DESCRIBE EXTERNAL VOLUME¶
外部ボリューム のプロパティを説明します。
DESCRIBE は DESC に短縮できます。
- こちらもご参照ください。
ALTER EXTERNAL VOLUME、 CREATE EXTERNAL VOLUME、 DROP EXTERNAL VOLUME、 SHOW EXTERNAL VOLUMES
構文¶
DESC[RIBE] EXTERNAL VOLUME <name>
パラメーター¶
name説明する外部テーブルの識別子を指定します。識別子にスペースまたは特殊文字が含まれる場合、文字列全体を二重引用符で囲む必要があります(例えば、
"My object")。二重引用符で囲まれた識別子も大文字と小文字が区別されます。
出力¶
コマンドの出力には、オブジェクトのプロパティとメタデータを説明する以下の列が含まれます。
列 |
説明 |
|---|---|
|
親プロパティ。この列には、 |
|
プロパティの名前。この列には、以下のテーブルに示すプロパティを含めることができます。 |
|
プロパティの型。 |
|
プロパティに割り当てられた値。 |
|
プロパティのデフォルト値。 |
property 列には、外部ボリュームオブジェクトの以下のプロパティを含めることができます。
プロパティ |
説明 |
|---|---|
|
もしあれば、外部ボリュームに設定されたコメント。 |
|
外部ボリュームに対して書き込み操作を許可するかどうかを指定します。 |
|
外部ボリュームに関連付けられたクラウドストレージの場所の詳細。ここで、 ストレージの場所のプロパティに関する詳細については、 CREATE EXTERNAL VOLUME をご参照ください。 |
|
外部ボリュームの アクティブストレージの場所 の名前。 |
アクセス制御の要件¶
この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。
権限 |
オブジェクト |
注意 |
|---|---|---|
USAGE |
外部ボリューム |
指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。
セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。
使用上の注意¶
このコマンドの出力を後処理するには、 パイプ演算子 (
->>)または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。たとえば、パイプ演算子または RESULT_SCAN 関数を使用して、 SHOW コマンド出力から特定の列を選択したり、行をフィルター処理したりできます。
出力列を参照する場合は、列名に 二重引用符で囲まれた識別子 を使用します。たとえば、出力列
typeを選択するには、SELECT "type"を指定します。SHOW コマンドの出力列名は小文字のため、二重引用符で囲まれた識別子を使用する必要があります。二重引用符により、 SELECT リストまたは WHERE 句内の列名が、スキャンされた SHOW コマンド出力内の列名と一致することが保証されます。
例¶
外部ボリュームを説明します。
DESC EXTERNAL VOLUME my_external_volume;
以下は、1つのストレージロケーションを持つ外部ボリュームの DESCRIBE EXTERNAL VOLUME の出力です。STORAGE_LOCATION_1 のプロパティ値は、表示目的のために省略されています。
+-------------------+--------------------+---------------+-------------------------------------------------------------------------------------------+------------------+
| parent_property | property | property_type | property_value | property_default |
|-------------------+--------------------+---------------+-------------------------------------------------------------------------------------------+------------------|
| | ALLOW_WRITES | Boolean | true | true |
| STORAGE_LOCATIONS | STORAGE_LOCATION_1 | String | {"NAME":"my_storage_us_west","STORAGE_PROVIDER":"S3","STORAGE_BASE_URL":"s3://...", ...} | |
| STORAGE_LOCATIONS | ACTIVE | String | my_storage_us_west | |
+-------------------+--------------------+---------------+-------------------------------------------------------------------------------------------+------------------+