secret
function
Applies to: Databricks SQL preview Databricks Runtime 11.3 LTS and above
Extracts a secret value with the given scope
and key
from Databricks secret service.
Arguments
scope
: A constant string expression containing the scope of the secret to be extracted. The scope is the namespace in which multiple keys might reside.key
: A constant string expression with the key of the secret to be extracted.
Returns
A STRING
.
If the key cannot be retrieved the function raises INVALID_SECRET_LOOKUP.
To return NULL
instead, use the try_secret() function.
To retrieve a list of all secrets the user is authorized to see use the list_secrets function.
Error conditions
INVALID_SECRET_LOOKUP.SECRET_FUNCTION_KEY_NOT_CONSTANT
: Thekey
is not a constant string.INVALID_SECRET_LOOKUP.SECRET_FUNCTION_SCOPE_NOT_CONSTANT
: Thescope
is not a constant string.INVALID_SECRET_LOOKUP.SECRET_FUNCTION_NOT_SUPPORTED
: Databricks secret service is not available.INVALID_SECRET_LOOKUP.SECRET_FUNCTION_LOOKUP_FAILED
: Thekey
cannot be found withinscope
.