list_secrets table function

  • Article

Applies to: check marked yes Databricks SQL preview check marked yes Databricks Runtime 11.3 LTS and above

Returns all keys in all scopes or one specific scope the user is authorized to see from Databricks secret service.

Syntax

list_secrets ( [ scopeStr ] )

Arguments

Applies to: check marked yes Databricks SQL preview check marked yes Databricks Runtime 15.3 and above

  • scopeStr: The scope within which to search. If not provided, all scopes are returned.

Returns

A table with two columns:

  • scope STRING NOT NULL: The namespace of the key.
  • key STRING NOT NULL: The key itself

To return the secret values for specific keys use secret(scope, key).

Error conditions

  • INVALID_SECRET_LOOKUP.LIST_SECRETS_FAILED: Databricks secret service is not available.

Examples

> SELECT * FROM list_secrets();
  scope         key
  ------------  ---------------
  secrets.r.us  theAnswerToLife
  openSecrets   psst

> SELECT * FROM list_secrets('secrets.r.us');
  scope         key
  ------------  ---------------
  secrets.r.us  theAnswerToLife

> SELECT secret('secrets.r.us', 'theAnswerToLife');
  fourtyTwo