groupe de commandesshares
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
Le groupe de commandes shares au sein de la CLI Databricks vous permet de gérer les partages dans Unity Catalog.
Un partage est un conteneur instancié avec shares create. Une fois créé, vous pouvez enregistrer itérativement une collection d'assets de données existants définis dans le métastore à l’aide de shares update. Vous pouvez enregistrer des assets de données sous leur nom d’origine, qualifiés par leur schéma d’origine, ou fournir des noms exposés alternatifs.
création de partages Databricks
Créer un nouveau partage pour les objets de données. Les objets de données peuvent être ajoutés après la création avec update. L'appelant doit être un administrateur de métastore ou avoir le privilège CREATE_SHARE sur le métastore.
databricks shares create NAME [flags]
Arguments
NAME
Nom du partage.
Options
--comment string
Description textuelle libre fournie par l'utilisateur.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--storage-root string
URL racine de stockage pour les fichiers Notebook dans le partage.
Exemples
Les exemples suivants créent un partage nommé my-analytics-share avec un commentaire :
databricks shares create my-analytics-share --comment "Sales analytics data share"
L'exemple suivant crée un partage avec une racine de stockage spécifique :
databricks shares create my-analytics-share --storage-root "s3://my-bucket/share-data"
Supprimer des partages Databricks
Supprimer un partage du métastore. L'appelant doit être le propriétaire du partage.
databricks shares delete NAME [flags]
Arguments
NAME
Le nom du partage.
Options
Exemples
L'exemple suivant supprime un partage nommé my-analytics-share:
databricks shares delete my-analytics-share
Obtenir des partages Databricks
Obtenez un partage du metastore. L'appelant doit être un administrateur du métastore ou le propriétaire du partage.
databricks shares get NAME [flags]
Arguments
NAME
Le nom du partage.
Options
--include-shared-data
Query pour les données à inclure dans le partage.
Exemples
L'exemple suivant obtient des informations sur un partage nommé my-analytics-share:
databricks shares get my-analytics-share
L'exemple suivant obtient un partage avec des détails sur les données partagées :
databricks shares get my-analytics-share --include-shared-data
(Obsolète) liste de partages Databricks
Cette commande est obsolète.
Lister les partages du métastore. L’appelant doit être un administrateur du métastore ou le propriétaire du partage. L’ordre des éléments dans le tableau n’est pas garanti.
databricks shares list [flags]
Arguments
Aucun
Options
--max-results int
Nombre maximal de partages à renvoyer.
--page-token string
Jeton de pagination opaque pour aller à la page suivante basé sur la query précédente.
databricks shares list-shares
Lister les partages du métastore. L’appelant doit être un administrateur du métastore ou le propriétaire du partage. L’ordre des éléments dans le tableau n’est pas garanti.
databricks shares list-shares [flags]
Arguments
Aucun
Options
--max-results int
Nombre maximal de partages à renvoyer.
--page-token string
Jeton de pagination opaque pour aller à la page suivante basé sur la query précédente.
Exemples
L'exemple suivant liste tous les partages :
databricks shares list-shares
Mise à jour des partages Databricks
Mettez à jour le partage avec les modifications et les objets de données dans la requête. L'appelant doit être le propriétaire du partage ou un administrateur de métastore.
Lorsque l'appelant est un administrateur du métastore, seul le champ owner peut être mis à jour.
Dans le cas où le nom du partage est modifié, updateShare exige que l'appelant soit le propriétaire du partage et dispose du privilège CREATE_SHARE.
S'il y a des fichiers notebook dans le partage, le champ storage_root ne peut pas être mis à jour.
Pour chaque table ajoutée via cette méthode, le propriétaire du partage doit également disposer du privilège SELECT sur la table. Ce privilège doit être maintenu indéfiniment pour que les destinataires puissent accéder à la table. En règle générale, vous devez utiliser un groupe comme propriétaire du partage.
Les suppressions de table via update ne nécessitent pas de privilèges supplémentaires.
databricks shares update NAME [flags]
Arguments
NAME
Le nom du partage.
Options
--comment string
Description textuelle libre fournie par l'utilisateur.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--new-name string
Nouveau nom du partage.
--owner string
Nom d’utilisateur du propriétaire actuel du partage.
--storage-root string
URL racine de stockage pour les fichiers Notebook dans le partage.
Exemples
L'exemple suivant met à jour le commentaire d'un partage :
databricks shares update my-analytics-share --comment "Updated sales analytics data share"
L'exemple suivant modifie le nom d'un partage :
databricks shares update my-analytics-share --new-name "sales-analytics-share"
L'exemple suivant met à jour le propriétaire d'un partage :
databricks shares update my-analytics-share --owner "someone@example.com"
L'exemple suivant met à jour un partage à l'aide de la configuration JSON :
databricks shares update my-analytics-share --json '{
"comment": "Updated share with new tables",
"objects": [
{
"name": "sales.customers",
"data_object_type": "TABLE"
}
]
}'
databricks partages autorisations de partage
Obtenez les autorisations pour un partage de données du métastore. L'appelant doit être un administrateur du métastore ou le propriétaire du partage.
databricks shares share-permissions NAME [flags]
Arguments
NAME
Le nom du partage.
Options
--max-results int
Nombre maximal d'autorisations à renvoyer.
--page-token string
Jeton de pagination opaque pour aller à la page suivante basé sur la query précédente.
Exemples
L'exemple suivant obtient les permissions pour un partage nommé my-analytics-share:
databricks shares share-permissions my-analytics-share
databricks partages mettre à jour les autorisations
Mettez à jour les autorisations pour un partage de données dans le métastore. L'appelant doit être un administrateur de metastore ou un propriétaire du partage.
Pour les nouvelles octrois de destinataires, l'utilisateur doit également être le propriétaire du destinataire ou l'administrateur du métastore. Les révocations de destinataires ne nécessitent pas de privilèges supplémentaires.
databricks shares update-permissions NAME [flags]
Arguments
NAME
Le nom du partage.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--omit-permissions-list
Facultatif.
Exemples
L'exemple suivant accorde des autorisations à un destinataire :
databricks shares update-permissions my-analytics-share --json '{
"changes": [
{
"principal": "recipient-name",
"add": ["SELECT"]
}
]
}'
L’exemple suivant révoque les autorisations d’un destinataire :
databricks shares update-permissions my-analytics-share --json '{
"changes": [
{
"principal": "recipient-name",
"remove": ["SELECT"]
}
]
}'
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser