functions groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le groupe de functions commandes au sein de la Databricks CLI vous permet de gérer les fonctions définies par l’utilisateur (UDFs) dans Unity Catalog. L’implémentation de la fonction peut être n’importe quelle expression ou requête SQL, et elle peut être appelée partout où une référence de table est autorisée dans une requête. Dans Le catalogue Unity, une fonction réside au même niveau qu’une table, afin qu’elle puisse être référencée avec le formulaire catalog_name.schema_name.function_name.

fonctions databricks créer

Créez une fonction.

Important

Il s’agit d’une fonctionnalité expérimentale.

L’utilisateur doit disposer des autorisations suivantes pour que la fonction soit créée :

- USE_CATALOG sur le catalogue parent de la fonction

• USE_SCHEMA et CREATE_FUNCTION sur le schéma parent de la fonction

databricks functions create [flags]

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Examples

L’exemple suivant crée une fonction à l’aide d’un fichier JSON :

databricks functions create --json @function-definition.json

L’exemple suivant crée une fonction à l’aide de JSON inline :

databricks functions create --json '{"name": "my_catalog.my_schema.my_function", "data_type": "INT", "full_data_type": "INT", "return_params": {"parameters": []}, "routine_body": "SQL", "routine_definition": "SELECT 1", "routine_dependencies": {"dependencies": []}, "parameter_style": "S", "is_deterministic": true, "sql_data_access": "CONTAINS_SQL", "is_null_call": false, "security_type": "DEFINER", "specific_name": "my_function"}'

fonctions databricks supprimer

Supprimez la fonction qui correspond au nom fourni.

Pour que la suppression réussisse, l’utilisateur doit remplir l’une des conditions suivantes :

• Est le propriétaire du catalogue parent de la fonction
• Est le propriétaire du schéma parent de la fonction et dispose du privilège USE_CATALOG sur le catalogue parent
• Est propriétaire de la fonction elle-même et a le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent

databricks functions delete NAME [flags]

Arguments

NAME

    Nom complet de la fonction (sous la forme catalog_name.schema_name.function_name).

Options

--force

    Forcer la suppression même si la fonction n'est pas vide.

Indicateurs globaux

Examples

L’exemple suivant supprime une fonction :

databricks functions delete my_catalog.my_schema.my_function

L’exemple suivant force la suppression d’une fonction :

databricks functions delete my_catalog.my_schema.my_function --force

fonctions databricks obtenir

Obtenir une fonction à partir d’un catalogue parent et d’un schéma.

Pour que la récupération réussisse, l’utilisateur doit répondre à l’une des exigences suivantes :

• Est un administrateur de metastore
• Est un propriétaire du catalogue parent de la fonction
• A le privilège USE_CATALOG sur le catalogue parent de la fonction et est le propriétaire de la fonction
• Disposer du privilège sur le USE_CATALOG catalogue parent de la fonction, le USE_SCHEMA privilège sur le schéma parent de la fonction et le EXECUTE privilège sur la fonction elle-même

databricks functions get NAME [flags]

Arguments

NAME

    Nom complet de la fonction (sous la forme catalog_name.schema_name.function_name).

Options

--include-browse

    Indique s’il faut inclure des fonctions dans la réponse pour laquelle le principal ne peut accéder qu’aux métadonnées sélectives.

Indicateurs globaux

Examples

L’exemple suivant obtient des informations sur une fonction :

databricks functions get my_catalog.my_schema.my_function

L’exemple suivant obtient une fonction avec les informations de navigation incluses :

databricks functions get my_catalog.my_schema.my_function --include-browse

fonctions databricks lister

Répertorier les fonctions dans le catalogue et le schéma parent spécifiés.

Si l’utilisateur est un administrateur de metastore, toutes les fonctions sont retournées dans la liste de sortie. Dans le cas contraire, l’utilisateur doit avoir le USE_CATALOG privilège sur le catalogue et le USE_SCHEMA privilège sur le schéma, et la liste de sortie contient uniquement les fonctions pour lesquelles l’utilisateur a le EXECUTE privilège ou l’utilisateur est le propriétaire. Il n’existe aucune garantie d’un classement spécifique des éléments dans le tableau.

databricks functions list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    Nom du catalogue parent des fonctions concernées.

SCHEMA_NAME

    Schéma parent des fonctions.

Options

--include-browse

    Indique s’il faut inclure des fonctions dans la réponse pour laquelle le principal ne peut accéder qu’aux métadonnées sélectives.

--max-results int

    Nombre maximal de fonctions à retourner.

--page-token string

    Jeton de pagination opaque pour accéder à la page suivante en fonction de la requête précédente.

Indicateurs globaux

Examples

L’exemple suivant répertorie toutes les fonctions d’un catalogue et d’un schéma :

databricks functions list my_catalog my_schema

L’exemple suivant répertorie les fonctions avec un maximum de 10 résultats :

databricks functions list my_catalog my_schema --max-results 10

L’exemple suivant répertorie les fonctions avec des informations de navigation incluses :

databricks functions list my_catalog my_schema --include-browse

Mise à jour des fonctions Databricks

Mettez à jour la fonction qui correspond au nom fourni.

Seul le propriétaire de la fonction peut être mis à jour. Si l’utilisateur n’est pas administrateur de metastore, l’utilisateur doit être membre du groupe qui est le nouveau propriétaire de la fonction. L’utilisateur doit remplir l’une des conditions suivantes :

• Est un administrateur de metastore
• Est le propriétaire du catalogue parent de la fonction
• Est le propriétaire du schéma parent de la fonction et dispose du privilège USE_CATALOG sur le catalogue parent
• Est le propriétaire de la fonction elle-même et a le USE_CATALOG privilège sur son catalogue parent ainsi que le USE_SCHEMA privilège sur le schéma parent de la fonction

databricks functions update NAME [flags]

Arguments

NAME

    Nom complet de la fonction (sous la forme catalog_name.schema_name.function_name).

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--owner string

    Nom d’utilisateur du propriétaire actuel de la fonction.

Indicateurs globaux

Examples

L’exemple suivant met à jour le propriétaire d’une fonction :

databricks functions update my_catalog.my_schema.my_function --owner someone@example.com

Indicateurs globaux

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne

    Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.

--progress-format format

    Format d’affichage des journaux d’activité de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser