groupe de commandesdatabase
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 database au sein de la CLI Databricks contient des commandes pour gérer les instances de base de données. Les instances de base de données gèrent les ressources de stockage et de compute et fournissent les Endpoint auxquels les utilisateurs se connectent.
Voir Lakebase provisionnée.
databricks database create-database-catalog
Créer un catalogue de bases de données.
databricks database create-database-catalog NAME DATABASE_INSTANCE_NAME DATABASE_NAME [flags]
Arguments
NAME
Le nom du catalogue dans Unity Catalog.
DATABASE_INSTANCE_NAME
Le nom de l'instance de base de données hébergeant la base de données.
DATABASE_NAME
Le nom de la base de données (dans une instance) associée au catalogue.
Options
--create-database-if-not-exists
Créez la base de données si elle n'existe pas.
--json JSON
La chaîne JSON intégrée ou le @chemin vers le fichier JSON avec le corps de la requête. Pour référence JSON, voir Catalogue de bases de données.
Exemples
L’exemple suivant crée un catalogue de bases de données :
databricks database create-database-catalog my-catalog my-instance my-database
databricks database create-database-instance
Créer une instance de base de données.
Pour définir des champs imbriqués qui ne sont pas disponibles en tant qu'arguments, utilisez l'option --json pour spécifier le corps complet de la requête.
databricks database create-database-instance NAME [flags]
Arguments
NAME
Le nom de l'instance. Il s'agit de l'identifiant unique de l'instance.
Options
--capacity string
Le SKU de capacité de l'instance. Les valeurs valides sont : CU_1, CU_2, CU_4, CU_8.
--json JSON
La chaîne JSON intégrée ou le @chemin vers le fichier JSON avec le corps de la requête. Pour la référence JSON, consultez Instance de la base de données.
--stopped
Indique si l'instance est arrêtée.
Exemples
L'exemple suivant crée une instance de base de données :
databricks database create-database-instance my-instance --capacity CU_1
databricks database create-database-table
Créer une table de base de données.
databricks database create-database-table NAME [flags]
Arguments
NAME
Nom complet en trois parties (catalogue, schéma, table) de la table.
Options
--database-instance-name string
Nom de l'instance de base de données cible.
--json JSON
La chaîne JSON intégrée ou le @chemin vers le fichier JSON avec le corps de la requête. Pour la référence JSON, voir Table de base de données.
--logical-database-name string
Nom de l'objet de base de données Postgres cible (base de données logique) pour cette table.
Exemples
L'exemple suivant crée une table de base de données :
databricks database create-database-table my-catalog.my-schema.my-table --database-instance-name my-instance --logical-database-name dbname
databricks database create-synced-database-table
Créez une table de base de données synchronisée.
Pour définir des champs imbriqués qui ne sont pas disponibles en tant qu'arguments, utilisez l'option --json pour spécifier le corps complet de la requête.
databricks database create-synced-database-table NAME [flags]
Arguments
NAME
Nom complet en trois parties (catalogue, schéma, table) de la table.
Options
--database-instance-name string
Nom de l'instance de base de données cible.
--json JSON
La chaîne JSON intégrée ou le @chemin vers le fichier JSON avec le corps de la requête. Pour la référence JSON, consultez Table de base de données synchronisée.
--logical-database-name string
Nom de l'objet de base de données Postgres cible (base de données logique) pour cette table.
Exemples
L'exemple suivant crée une table de base de données synchronisée :
databricks database create-synced-database-table --json '{"name": "main.my-schema.my-table", "database_instance_name": "my-instance", "logical_database_name": "testdb", "spec": {"primary_key_columns": ["col1"], "existing_pipeline_id": "999999z9-dz9b-4zf7-c178-15b777772e6z", "scheduling_policy": "SNAPSHOT", "source_table_full_name": "main.my-instance.t"}}'
databricks database delete-database-catalog
Supprimer un catalogue de bases de données.
databricks database delete-database-catalog NAME [flags]
Arguments
NAME
Le nom du catalogue à supprimer.
Options
Exemples
L'exemple suivant supprime un catalogue de base de données :
databricks database delete-database-catalog my-catalog
databricks database delete-database-instance
Supprimer une instance de base de données.
databricks database delete-database-instance NAME [flags]
Arguments
NAME
Nom de l'instance à supprimer.
Options
--force
By default, une instance ne peut pas être supprimée si elle a des instances descendantes créées via PITR.
--purge
Remarque : purge=false est en développement.
Exemples
L'exemple suivant supprime une instance de base de données :
databricks database delete-database-instance my-instance --force
databricks database delete-database-table
Supprimer une table de base de données.
databricks database delete-database-table NAME [flags]
Arguments
NAME
Nom complet en trois parties (catalogue, schéma, table) de la table à supprimer.
Options
Exemples
L'exemple suivant supprime une table de base de données :
databricks database delete-database-table catalog.schema.table
databricks database delete-synced-database-table
Supprimer une table de base de données synchronisée.
databricks database delete-synced-database-table NAME [flags]
Arguments
NAME
... Nom complet en trois parties (catalogue, schéma, table) de la table synchronisée à supprimer.
Options
Exemples
L'exemple suivant supprime une table de base de données synchronisée :
databricks database delete-synced-database-table catalog.schema.table
databricks database find-database-instance-by-uid
Trouver une instance de base de données par uid.
databricks database find-database-instance-by-uid [flags]
Options
--uid string
UID du cluster à récupérer.
Exemples
L’exemple suivant trouve une instance de base de données par UID :
databricks database find-database-instance-by-uid --uid 12345-abcdef-67890
databricks database generate-database-credential
Génère un identifiant qui peut être utilisé pour accéder aux instances de base de données.
databricks database generate-database-credential [flags]
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--request-id string
ID de requête pour la génération de l'identifiant.
Exemples
L’exemple suivant génère un identifiant de base de données :
databricks database generate-database-credential --request-id my-request-123
databricks database get-database-catalog
Obtenir un catalogue de bases de données.
databricks database get-database-catalog NAME [flags]
Arguments
NAME
Le nom du catalogue à obtenir.
Options
Exemples
L'exemple suivant présente des informations sur un catalogue de bases de données :
databricks database get-database-catalog my-catalog
databricks database get-database-instance
Obtenir une instance de base de données.
databricks database get-database-instance NAME [flags]
Arguments
NAME
Nom du cluster à récupérer.
Options
Exemples
L'exemple suivant obtient des informations sur une instance de base de données :
databricks database get-database-instance my-instance
databricks database get-database-table
Obtenir une table de base de données.
databricks database get-database-table NAME [flags]
Arguments
NAME
Nom complet en trois parties (catalogue, schéma, table) de la table à récupérer.
Options
Exemples
L'exemple suivant obtient des informations sur une table de base de données :
databricks database get-database-table catalog.schema.table
databricks database get-synced-database-table
Obtenez une table de base de données synchronisée.
databricks database get-synced-database-table NAME [flags]
Arguments
NAME
Nom complet en trois parties (catalogue, schéma, table) de la table synchronisée à obtenir.
Options
Exemples
L’exemple suivant fournit des informations sur une table de base de données synchronisée :
databricks database get-synced-database-table catalog.schema.table
databricks database list-database-instances
Lister les instances de base de données.
databricks database list-database-instances [flags]
Options
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de pagination pour accéder à la page suivante des instances de base de données.
Exemples
L'exemple suivant répertorie toutes les instances de base de données :
databricks database list-database-instances
L'exemple suivant liste les instances de base de données avec pagination :
databricks database list-database-instances --page-size 10
databricks database update-instance-de-base-de-données
Mettre à jour une instance de base de données.
databricks database update-database-instance NAME UPDATE_MASK [flags]
Arguments
NAME
Le nom de l'instance. Il s'agit de l'identifiant unique de l'instance.
UPDATE_MASK
Un masque spécifiant les champs à mettre à jour. Utilisez * pour mettre à jour tous les champs spécifiés.
Options
--capacity string
La SKU de l'instance.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--stopped
Indique si l'instance est arrêtée.
Exemples
L'exemple suivant met à jour la capacité d'une instance de base de données :
databricks database update-database-instance my-instance '*' --capacity CU_4
L'exemple suivant arrête une instance de base de données :
databricks database update-database-instance my-instance '*' --stopped
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