secret
関数
適用対象: Databricks SQL プレビュー Databricks Runtime 11.3 LTS 以降
Databricks シークレット サービスから、指定された scope
と key
のシークレット値を抽出します。
構文
secret ( scope, key )
引数
scope
: 抽出するシークレットのスコープが含まれる定数文字列式。 このスコープは名前空間であり、その中には複数のキーが存在している可能性があります。key
: 抽出するシークレットのキーを持つ定数文字列式。
返品
STRING
です。
キーを取得できない場合、関数は INVALID_SECRET_LOOKUP を発生させます。
代わりに NULL
を返すには、try_secret() 関数を使用します。
すべてのシークレットの一覧を取得するため、ユーザーには list_secrets 関数の表示と使用が許可されます。
エラー条件
INVALID_SECRET_LOOKUP.SECRET_FUNCTION_KEY_NOT_CONSTANT
:key
は定数文字列ではありません。INVALID_SECRET_LOOKUP.SECRET_FUNCTION_SCOPE_NOT_CONSTANT
:scope
は定数文字列ではありません。INVALID_SECRET_LOOKUP.SECRET_FUNCTION_NOT_SUPPORTED
: Databricks シークレット サービスは利用できません。INVALID_SECRET_LOOKUP.SECRET_FUNCTION_LOOKUP_FAILED
:key
はscope
内で見つかりません。
例
> SELECT * FROM list_secrets();
scope key
------------ ---------------
secrets.r.us theAnswerToLife
> SELECT secret('secrets.r.us', 'theAnswerToLife');
fourtyTwo
> SELECT try_secret('secrets.r.us', 'WhatIsTheAnswerToLife');
Error: INVALID_SECRET_LOOKUP.SECRET_FUNCTION_LOOKUP_FAILED