DESCRIBE SECRET¶

シークレットのプロパティについて説明します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。: ALTER SECRET、 CREATE SECRET、 DROP SECRET、 SHOW SECRETS

構文¶

{ DESC | DESCRIBE } SECRET <name>

Copy

パラメーター¶

name: 記述するシークレットの識別子を指定します。識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

出力¶

コマンド出力では、次の列にシークレットプロパティとメタデータが提供されます。

列	説明
`created_on`	シークレットが作成された日時。
`name`	シークレットの名前。
`schema_name`	シークレットを含むスキーマの名前。
`database_name`	シークレットを含むデータベースの名前。
`owner`	シークレットを所有するロールの名前。
`comment`	シークレットのコメント、またはコメントが指定されていない場合は NULL。
`secret_type`	`OAUTH2`、 `PASSWORD`、 `GENERIC`、 `SYMMETRIC_KEY` のいずれか。
`username`	シークレットに格納されているユーザー名。
`oauth_access_token_expiry_time`	OAuth アクセストークンの有効期限が切れたときの、文字列としてのタイムスタンプ。
`oauth_refresh_token_expiry_time`	OAuth リフレッシュトークンの有効期限が切れたときの、文字列としてのタイムスタンプ、またはシークレットがこの値を格納しない場合は NULL。
`oauth_scopes`	OAuth クライアント認証情報フロー中に、統合に対して USAGE を持つロールによって OAuth サーバーからリクエストする際に使用するスコープのコンマ区切りリスト、またはスコープがない場合は NULL。
`integration_name`	シークレット内で参照される外部 API 認証統合の名前、またはシークレットが外部 API 認証統合を参照しない場合は NULL。
`algorithm`	対称キーシークレットに使用されるアルゴリズム。
`key_length`	対称キーのシークレットに使用されるキーの長さ。

アクセス制御の要件¶

この操作の実行に使用されるロールには、少なくとも次の権限が必要です。

権限	オブジェクト	注意
USAGE	シークレット

スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対するCREATE権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対するUSAGE*も*付与されている必要はありません。

指定された権限のセットを使用してカスタムロールを作成する手順については、カスタムロールの作成をご参照ください。

セキュリティ保護可能なオブジェクトに対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、アクセス制御の概要をご参照ください。

使用上の注意¶

Snowflakeが PASSWORD プロパティ値を返すことはありません。

このコマンドの出力を後処理するには、パイプ演算子（->>）または RESULT_SCAN 関数。どちらのコンストラクトも、出力をクエリできる結果セットとして扱います。

For example, you can use the pipe operator or RESULT_SCAN function to select specific columns from the SHOW command output or filter the rows.

When you refer to the output columns, use double-quoted identifiers for the column names. For example, to select the output column type, specify SELECT "type".

You must use double-quoted identifiers because the output column names for SHOW commands are in lowercase. The double quotes ensure that the column names in the SELECT list or WHERE clause match the column names in the SHOW command output that was scanned.

例¶

シークレットを説明します:

DESC SECRET service_now_creds_pw;

Copy