ローカルカタログ
OLP CLI は、次のものをサポートしています。
- すべてのローカルカタログを一覧表示します
- ローカルカタログを作成します
- ローカルカタログを更新します
- ローカルカタログを表示します
- ローカルカタログを削除します
- ローカルカタログの依存関係を一覧表示します
- ローカルカタログを検査します
ローカルカタログリスト
すべてのローカルカタログを一覧表示し、別の行にカタログ名を返します。
カタログの詳細については olp local catalog show
、コマンドを参照してください。
olp local catalog list [filter] [command options]
オプションのパラメータ :
-
[filter]
カタログリストのフィルタリングに使用される freeform テキスト。 フィルタ filter
は、カタログ HERE リソースネーム に文字列が含まれているかどうかを確認します。 --json
コマンドの結果を JSON 形式で表示します。 -
--quiet
カタログ HRNS を新しい行に表示します。
フィルタリングの例 :
olp local catalog list "first-catalog-example-id" --json
出力 :
{"results": {"items": [
{"hrn": "hrn:local:data:::first-catalog-example-id"}
]}}
フィルタリングのない例 :
olp local catalog list --json
出力 :
{"results": {"items": [
{"hrn": "hrn:local:data:::first-catalog-example-id"},
{"hrn": "hrn:local:data:::second-catalog-example-id"}
]}}
ローカルカタログが作成されました
空のローカルカタログを作成します。
olp local catalog create <catalog ID> <catalog name> --summary <catalog summary> [command options]
必須パラメータ :
-
<catalog ID>
カタログ HERE リソースネーム を作成するためのヒントとして使用される ID 。 -
<catalog name>
カタログの読み取り可能な名前。 --config
コマンド ラインを介してパラメータで指定された値を上書きします。 --description <catalog description>
カタログおよびその内容の詳細な説明。 説明は引用符で囲んでください。 -
--summary <catalog summary>
カタログの内容の概要を 1 行で示します。 --config
コマンド ラインを介してパラメータで指定された値を上書きします。
注
--config
オプションで参照されている設定ファイルを使用して、カタログの概要を指定することもできます。
オプションのパラメータ :
-
--config <path to config file>
設定ファイルのパスと名前。 -
--tags <tag1 tag2 ...>
検索の検索に使用されるカタログキーワード。 -
--json
カタログ HERE リソースネーム を JSON 形式で表示します。 -
--quiet
カタログ HERE リソースネーム を表示します。
例 :
次のコマンド first-catalog-example
を使用すると、空のローカルカタログが作成され、出力にカタログの HERE リソースネーム が表示されます。
olp local catalog create first-catalog-example-id first-catalog-example --summary "A new summary"
複数の引数を受け取るパラメーターに渡すには、引数をスペースで区切ります。
例 :
次のコマンド を使用すると、プラットフォーム に 2 つのタグ(tag1
および tag2
)がある空のローカルカタログ second-catalog-example
が作成され、コンソール出力にカタログの HERE リソースネーム が表示されます。
olp local catalog create second-catalog-example-id second-catalog-example --tags tag1 tag2 --summary "A new summary"
ローカルカタログの更新
設定ファイルで指定された設定で既存のローカルカタログを更新します。
olp local catalog update <catalog HRN> [command options]
警告
カタログ設定の変更
プラットフォームと同様に、ローカルカタログのレイヤー設定を変更することはできません。
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。
オプションのパラメータ :
-
--config <path to config file>
更新された設定を含むファイルのパス。 -
--name <catalog name>
カタログの読み取り可能な名前。 --config
コマンド ラインを介してに提供された値を上書きします。 -
--summary <catalog summary>
カタログの内容の概要を 1 行で示します。 --config
コマンド ラインを介してに提供された値を上書きします。 --description <catalog description>
カタログおよびその内容の詳細な説明。 説明は引用符で囲んでください。 -
--tags <tag1 tag2 ...>
検索の検索に使用されるカタログキーワード。 タグを設定解除するには、を使用 --tags []
します。 -
--quiet
空の出力を追加情報なしで表示します。
例 :
olp local catalog update hrn:local:data:::first-catalog-example-id --config path/to/config.json
ボラタイル レイヤーを使用したカタログの設定例 :
{
"name": "volatile-volatile-catalog",
"summary": "A short summary",
"description": "A longer description about what the catalog contains",
"tags": [
"tag1",
"tag2"
],
"layers": [
{
"id": "volatile-layer",
"name": "volatile-layer",
"summary": "A short summary",
"description": "A longer description about what the layer contains",
"layerType": "volatile",
"partitioningScheme": "generic",
"partitioning": {
"scheme": "generic"
},
"volume": {
"volumeType": "volatile"
},
"contentType": "application/x-protobuf"
}
]
}
バージョン付レイヤーを使用したカタログの設定例 :
{
"name": "versioned-durable-catalog",
"summary": "A short summary",
"description": "A longer description about what the catalog contains",
"tags": [
"tag1",
"tag2"
],
"layers": [
{
"id": "versioned-layer",
"name": "versioned-layer",
"summary": "A short summary",
"description": "A longer description about what the layer contains",
"layerType": "versioned",
"partitioningScheme": "generic",
"partitioning": {
"scheme": "generic"
},
"volume": {
"volumeType": "durable"
},
"contentType": "application/x-protobuf",
"crc": "CRC-32C",
"digest": "MD5"
}
]
}
ストリーム レイヤーを使用したカタログの設定例 :
{
"name": "stream-durable-catalog",
"summary": "A short summary",
"description": "A longer description about what the catalog contains",
"tags": [
"tag1",
"tag2"
],
"layers": [
{
"id": "stream-layer",
"name": "stream-layer",
"summary": "A short summary",
"description": "A longer description about what the layer contains",
"layerType": "stream",
"partitioningScheme": "generic",
"partitioning": {
"scheme": "generic"
},
"volume": {
"volumeType": "durable"
},
"contentType": "application/x-protobuf"
}
]
}
追加のパラメータを使用した例 :
olp local catalog update hrn:local:data:::first-catalog-example-id --name first-catalog-example-updated \
--summary "Updated summary" --description "Updated description"
olp local catalog update hrn:local:data:::first-catalog-example-id --name first-catalog-example-updated ^
--summary "Updated summary" --description "Updated description"
カタログ設定の詳細について は、 Data API を参照してください。
ローカルカタログの表示
ローカルカタログ設定を表示します。
olp local catalog show <catalog HRN> [command options]
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム
オプションのパラメータ :
--json
コマンドの結果を JSON 形式で表示します。 -
--quiet
カタログのレイヤータイプとレイヤー ID をスペースで区切って表示します。
例 :
olp local catalog show hrn:local:data:::first-catalog-example-id --json
出力には、 JSON 形式のカタログの構成が含まれています。
{
"summary": "",
"billingTags": [],
"hrn": "hrn:local:data:::first-catalog-example-id",
"created": "2018-03-02T10:41:09.309Z",
"name": "first-catalog-example",
"layers": [
{
"summary": "Summary",
"volume": {"volumeType": "durable"},
"layerType": "versioned",
"billingTags": [],
"crc": "CRC-32C",
"name": "Test Layer",
"contentEncoding": "gzip",
"description": "some description",
"partitioningScheme": "generic",
"partitioning": {"scheme": "generic"},
"id": "test-layer",
"contentType": "application/octet-stream",
"digest": "SHA-1",
"tags": []
},
{
"summary": "Summary",
"volume": {"volumeType": "durable"},
"layerType": "versioned",
"billingTags": [],
"crc": "CRC-32C",
"name": "Test Layer1",
"description": "some description",
"partitioningScheme": "generic",
"partitioning": {"scheme": "generic"},
"id": "test-layer1",
"contentType": "application/octet-stream",
"tags": []
}
],
"description": "",
"notifications": {
"enabled": false
},
"id": "first-catalog-example-id",
"version": 0,
"metadataVersion": 21
"metadataMinimumVersion": 0
"tags": []
}
ローカルカタログの削除
ファイルシステムからローカルカタログを削除します。
olp local catalog delete <catalog HRN> [command options]
警告
ローカルカタログを削除しています
このコマンドは、ローカルカタログを完全に削除します。復元することはできません。
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。
オプションのパラメータ :
-
--quiet
空の出力を追加情報なしで表示します。
例 :
olp local catalog delete hrn:local:data:::first-catalog-example-id
ローカルカタログの依存関係リスト
特定のバージョンのすべてのカタログの依存関係を一覧表示します。
olp local catalog dependency list <catalog HRN>
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。
オプションのパラメータ :
-
--version <catalog version>
カタログのバージョン。 デフォルト値は最新バージョンです。 -
--direct-only
有効にすると、直接の依存関係のみが表示されます。 無効にすると、直接と間接の両方の依存関係が表示されます。 デフォルトでは無効になっています --json
コマンドの結果を JSON 形式で表示します。 -
--quiet
カタログの依存関係の HRNS を新しい行に表示します。
例 :
次のコマンド hrn:local:data:::first-catalog-example-id
は、 JSON 形式でカタログの直接の依存関係をすべて一覧表示します。
olp local catalog dependency list hrn:local:data:::first-catalog-example-id --direct-only --json
ローカルカタログ検査
外部ブラウザでローカルデータ インスペクターを開きます。 ローカルカタログが存在しない場合、コマンドは失敗します。
特定のレイヤーを検査 olp local catalog layer inspect
するには、コマンドを参照してください。
olp local catalog inspect <catalog HRN> [command options]
オプションのパラメータ :
-
--quiet
空の出力を追加情報なしで表示します。
注
olp local catalog inspect
このコマンドはローカルの Data API サーバーを起動し、プロセスが終了するまでユーザーに制御を戻しません。