Partager via

Fonction secret

  • Article

S’applique à : coche marquée oui Databricks SQL – préversioncoche marquée oui Databricks Runtime 11.3 LTS et ultérieur

Extrait une valeur secrète avec les valeurs scope et key données à partir du service secret Databricks.

Syntaxe

secret ( scope, key )

Arguments

  • scope : expression de chaîne constante contenant l’étendue du secret à extraire. L’étendue est l’espace de noms dans lequel plusieurs clés peuvent résider.
  • key : expression de chaîne constante avec la clé du secret à extraire.

Retours

STRING.

Si la clé ne peut pas être récupérée, la fonction génère INVALID_SECRET_LOOKUP. Pour retourner NULL à la place, utilisez la fonction try_secret().

Pour récupérer une liste de tous les secrets que l’utilisateur est autorisé à voir, utilisez la fonction list_secrets.

Conditions d'erreur

  • INVALID_SECRET_LOOKUP.SECRET_FUNCTION_KEY_NOT_CONSTANT : le key n’est pas une chaîne constante.
  • INVALID_SECRET_LOOKUP.SECRET_FUNCTION_SCOPE_NOT_CONSTANT : le scope n’est pas une chaîne constante.
  • INVALID_SECRET_LOOKUP.SECRET_FUNCTION_NOT_SUPPORTED : le service secret Databricks n’est pas disponible.
  • INVALID_SECRET_LOOKUP.SECRET_FUNCTION_LOOKUP_FAILED : key est introuvable dans scope.

Exemples

> 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