groupe de commandespostgres
Ces informations s'appliquent aux versions 0.285 et ultérieures de Databricks CLI.
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 postgres au sein de la CLI Databricks contient des commandes pour gérer les ressources Postgres de Lakebase, notamment les projets, les Branch, les Endpoint, les rôles, les catalogues et les tables synchronisées. L'API Postgres fournit un accès à une base de données Postgres via l'API REST ou SQL direct.
databricks postgres create-branch
Créer une Branch. Lors de la création d'une branch, vous devez spécifier une politique d'expiration en utilisant no_expiry: true pour les branches permanentes.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres create-branch PARENT BRANCH_ID [flags]
Arguments
PARENT
Le projet où cette Branch est créée. Format : projects/{project_id}
BRANCH_ID
L'ID à utiliser pour la Branch, qui devient le composant final du nom de ressource de la branch. Doit comporter de 1 à 63 caractères, start par une lettre minuscule et contenir uniquement des lettres minuscules, des chiffres et des tirets (RFC 1123).
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource Branch.
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant crée une Branch dans un projet :
databricks postgres create-branch projects/my-project-id my-branch \
--json '{
"spec": {
"no_expiry": true
}
}'
L'exemple suivant crée une Branch à partir d'une Branch existante :
databricks postgres create-branch projects/my-project-id dev-branch \
--json '{
"spec": {
"source_branch": "projects/my-project-id/branches/main",
"no_expiry": true
}
}'
databricks postgres create-catalog
Enregistrer une base de données Postgres dans Unity Catalog.
Nécessite Databricks CLI version 0.298 ou une version supérieure.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres create-catalog CATALOG_ID [flags]
Arguments
CATALOG_ID
L'ID à utiliser pour le catalogue dans Unity Catalog. Il devient le composant final du nom de la ressource du catalogue (par exemple, my_catalog devient catalogs/my_catalog).
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du catalogue (résultat uniquement).
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant enregistre une base de données Postgres dans Unity Catalog :
databricks postgres create-catalog my-catalog \
--json '{
"spec": {
"postgres_database": "mydb",
"branch": "projects/my-project-id/branches/production"
}
}'
databricks postgres create-endpoint
Créer un Endpoint. Une Branch peut avoir un Endpoint de compute en lecture-écriture et plusieurs Endpoints en lecture seule (réplicas de lecture) pour la mise à l'échelle des Opérations de lecture.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]
Arguments
PARENT
La Branch où cet Endpoint est créé. Format : projects/{project_id}/branches/{branch_id}
ENDPOINT_ID
L'ID à utiliser pour l'Endpoint, qui devient le composant final du nom de la ressource de l'endpoint. Doit comporter de 1 à 63 caractères, start par une lettre minuscule et contenir uniquement des lettres minuscules, des chiffres et des tirets (RFC 1123).
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource de l'Endpoint.
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant crée un Endpoint en lecture-écriture dans une Branch :
databricks postgres create-endpoint projects/my-project-id/branches/my-branch-id my-endpoint \
--json '{
"spec": {
"endpoint_type": "ENDPOINT_TYPE_READ_WRITE",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": 4.0
}
}'
L'exemple suivant crée un Endpoint en lecture seule (réplica en lecture) :
databricks postgres create-endpoint projects/my-project-id/branches/my-branch-id read-replica-1 \
--json '{
"spec": {
"endpoint_type": "ENDPOINT_TYPE_READ_ONLY",
"autoscaling_limit_min_cu": 0.5,
"autoscaling_limit_max_cu": 4.0
}
}'
databricks postgres create-project
Créer un projet.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
Lorsque vous créez un projet, il inclut automatiquement une Branch de production par default et un Endpoint de compute en lecture-écriture, tous deux avec des ID générés automatiquement.
databricks postgres create-project PROJECT_ID [flags]
Arguments
PROJECT_ID
L'ID à utiliser pour le projet, qui devient le composant final du nom de ressource du projet. Doit comporter de 1 à 63 caractères, start par une lettre minuscule et contenir uniquement des lettres minuscules, des chiffres et des tirets (RFC 1123).
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du projet.
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant crée un projet :
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project"
}
}'
L'exemple suivant crée un projet avec une version spécifique de PostgreSQL :
databricks postgres create-project my-project \
--json '{
"spec": {
"display_name": "My Project",
"pg_version": "17"
}
}'
databricks postgres create-role
Créer un rôle Postgres pour une Branch.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres create-role PARENT [flags]
Arguments
PARENT
La Branch où ce rôle est créé. Format : projects/{project_id}/branches/{branch_id}.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du rôle (sortie seulement).
--no-wait
N’attendez pas d’atteindre l’état TERMINÉ.
--role-id string
L'ID à utiliser pour le rôle, qui devient la composante finale du nom de la ressource du rôle.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant crée un rôle basé sur un mot de passe dans une Branch :
databricks postgres create-role projects/my-project-id/branches/my-branch-id \
--role-id my-role \
--json '{"spec": {"postgres_role": "my-role"}}'
L'exemple suivant crée un rôle OAuth pour un utilisateur Databricks :
databricks postgres create-role projects/my-project-id/branches/my-branch-id \
--role-id my-user-role \
--json '{"spec": {"identity_type": "USER", "postgres_role": "user@example.com"}}'
databricks postgres create-synced-table
Créez une table synchronisée qui réplique en continu une table Unity Catalog dans une base de données Lakebase Postgres.
Nécessite Databricks CLI version 0.298 ou une version supérieure.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres create-synced-table SYNCED_TABLE_ID [flags]
Arguments
SYNCED_TABLE_ID
L'ID à utiliser pour la table synchronisée, au format {catalog}.{schema}.{table}. Par exemple, my-catalog.sales.orders. Cela crée une table synchronisée Unity Catalog et une table Postgres nommée {table} dans le schéma {schema}.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de ressource de la table synchronisée (sortie uniquement).
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant crée une table synchronisée avec un instantané unique :
databricks postgres create-synced-table my-catalog.sales.orders \
--json '{
"spec": {
"source_table_full_name": "main.sales.orders",
"branch": "projects/my-project-id/branches/production",
"primary_key_columns": ["order_id"],
"scheduling_policy": "SNAPSHOT",
"postgres_database": "mydb",
"create_database_objects_if_missing": true
}
}'
L'exemple suivant crée une table synchronisée avec synchronisation continue (mises à jour quasi en temps réel) :
databricks postgres create-synced-table my-catalog.sales.orders \
--json '{
"spec": {
"source_table_full_name": "main.sales.orders",
"branch": "projects/my-project-id/branches/production",
"primary_key_columns": ["order_id"],
"scheduling_policy": "CONTINUOUS",
"postgres_database": "mydb",
"create_database_objects_if_missing": true
}
}'
databricks postgres supprimer-Branch
Supprimer une Branch.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
Les Branch protégées ne peuvent pas être supprimées. Utilisez update-branch pour définir spec.is_protected sur false avant de supprimer.
databricks postgres delete-branch NAME [flags]
Arguments
NAME
Le nom de la Branch à supprimer. Format : projects/{project_id}/branches/{branch_id}
Options
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant supprime une Branch :
databricks postgres delete-branch projects/my-project-id/branches/my-branch-id
databricks postgres delete-catalog
Supprimer un catalogue de bases de données.
Nécessite Databricks CLI version 0.298 ou une version supérieure.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres delete-catalog NAME [flags]
Arguments
NAME
Le chemin complet des ressources du catalogue à supprimer. Format : catalogs/{catalog_id}
Options
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant supprime un catalogue :
databricks postgres delete-catalog catalogs/my-catalog
databricks postgres delete-endpoint
Supprimer un Endpoint.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres delete-endpoint NAME [flags]
Arguments
NAME
Le nom de l'Endpoint à supprimer. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant supprime un endpoint :
databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres delete-project
Supprimer un projet.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres delete-project NAME [flags]
Arguments
NAME
Le nom du projet à supprimer. Format : projects/{project_id}
Options
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--purge
Si la valeur est vraie, supprime définitivement le projet (suppression définitive).
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant supprime de manière réversible un projet (récupérable pendant 7 jours) :
databricks postgres delete-project projects/my-project-id
L'exemple suivant supprime définitivement un projet :
databricks postgres delete-project projects/my-project-id --purge
databricks postgres delete-role
Supprimez un rôle Postgres d'une Branch.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres delete-role NAME [flags]
Arguments
NAME
Le chemin d'accès complet à la ressource du rôle à supprimer. Format : projects/{project_id}/branches/{branch_id}/roles/{role_id}.
Options
--no-wait
N’attendez pas d’atteindre l’état TERMINÉ.
--reassign-owned-to string
Réaffecter les objets détenus par le rôle supprimé à ce rôle.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant supprime un rôle d'une Branch :
databricks postgres delete-role projects/my-project-id/branches/my-branch-id/roles/my-role
databricks postgres delete-synced-table
Supprimer une table synchronisée.
Nécessite Databricks CLI version 0.298 ou une version supérieure.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres delete-synced-table NAME [flags]
Arguments
NAME
Le nom complet de la ressource de la table synchronisée à supprimer. Format : synced_tables/{catalog}.{schema}.{table}
Options
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant supprime une table synchronisée :
databricks postgres delete-synced-table "synced_tables/my-catalog.sales.orders"
databricks postgres generate-database-credential
Générer des informations d'identification OAuth pour une base de données Postgres. Le jeton OAuth renvoyé est utilisé pour authentifier et se connecter à votre base de données avec des clients PostgreSQL comme psql.
databricks postgres generate-database-credential ENDPOINT [flags]
Arguments
ENDPOINT
L'endpoint pour lequel cet identifiant est généré. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Exemples
L'exemple suivant génère des identifiants OAuth pour un endpoint :
databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-Branch
Obtenir une Branch.
databricks postgres get-branch NAME [flags]
Arguments
NAME
Nom de la Branch à récupérer. Format : projects/{project_id}/branches/{branch_id}
Options
Exemples
L’exemple suivant fournit des informations sur une Branch :
databricks postgres get-branch projects/my-project-id/branches/my-branch-id
databricks postgres get-catalog
Obtenir un catalogue de bases de données.
Nécessite Databricks CLI version 0.298 ou une version supérieure.
databricks postgres get-catalog NAME [flags]
Arguments
NAME
Le chemin de ressource complet du catalogue à récupérer. Format : catalogs/{catalog_id}
Options
Exemples
L’exemple suivant obtient des informations sur un catalogue :
databricks postgres get-catalog catalogs/my-catalog
databricks postgres get-endpoint
Obtenez un Endpoint.
databricks postgres get-endpoint NAME [flags]
Arguments
NAME
Le nom de l'Endpoint à récupérer. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
Options
Exemples
L'exemple suivant obtient des informations sur un Endpoint :
databricks postgres get-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id
databricks postgres get-operation
Obtenir une Opération.
databricks postgres get-operation NAME [flags]
Arguments
NAME
Le nom de la ressource d'opération.
Options
Exemples
L'exemple suivant obtient des informations sur une opération :
databricks postgres get-operation projects/my-project-id/operations/my-operation-id
Databricks postgres get-project
Obtenez un projet.
databricks postgres get-project NAME [flags]
Arguments
NAME
Le nom du projet à récupérer. Format : projects/{project_id}
Options
Exemples
L'exemple suivant obtient des informations sur un projet :
databricks postgres get-project projects/my-project-id
databricks postgres get-role
Obtenez un rôle Postgres pour une Branch. Récupère des informations sur le rôle spécifié, y compris sa méthode d'authentification et ses autorisations.
databricks postgres get-role NAME [flags]
Arguments
NAME
Le chemin d'accès complet des ressources du rôle à récupérer. Format : projects/{project_id}/branches/{branch_id}/roles/{role_id}.
Options
Exemples
L'exemple suivant obtient un rôle :
databricks postgres get-role projects/my-project-id/branches/my-branch-id/roles/my-role
databricks postgres get-synced-table
Obtenir une table synchronisée.
Nécessite Databricks CLI version 0.298 ou une version supérieure.
databricks postgres get-synced-table NAME [flags]
Arguments
NAME
Le nom complet de la ressource de la table synchronisée. Format : synced_tables/{catalog}.{schema}.{table}
Options
Exemples
L'exemple suivant obtient des informations sur une table synchronisée :
databricks postgres get-synced-table "synced_tables/my-catalog.sales.orders"
databricks postgres liste-branches
Lister les branches. Utilisez cette commande pour trouver les ID de Branch, y compris la Branch par default créée avec votre projet (indiquée par "default": true dans le statut).
databricks postgres list-branches PARENT [flags]
Arguments
PARENT
Le projet qui possède cette collection de Branches. Format : projects/{project_id}
Options
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de page d'une réponse précédente.
Exemples
L'exemple suivant liste toutes les Branch d'un projet :
databricks postgres list-branches projects/my-project-id
L'exemple suivant liste les branches avec pagination :
databricks postgres list-branches projects/my-project-id --page-size 10
databricks postgres list-endpoints
Lister les Endpoint. Utilisez cette commande pour trouver les ID d'Endpoint, y compris l'Endpoint de lecture-écriture par default créé automatiquement avec votre projet.
databricks postgres list-endpoints PARENT [flags]
Arguments
PARENT
La Branch qui possède cette collection d’Endpoint. Format : projects/{project_id}/branches/{branch_id}
Options
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de page d'une réponse précédente.
Exemples
L’exemple suivant répertorie tous les Endpoint d’une Branch :
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id
L'exemple suivant liste les Endpoint avec pagination :
databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10
databricks postgres list-projects
Lister les projets.
databricks postgres list-projects [flags]
Options
--limit int
Nombre maximal de résultats à renvoyer.
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de page d'une réponse précédente.
--show-deleted
Faut-il inclure les projets supprimés de manière logique dans la réponse.
Exemples
L'exemple suivant répertorie tous les projets :
databricks postgres list-projects
L'exemple suivant liste les projets avec pagination :
databricks postgres list-projects --page-size 10
L'exemple suivant liste tous les projets, y compris ceux qui ont été supprimés logiquement :
databricks postgres list-projects --show-deleted
databricks postgres list-roles
Lister les rôles Postgres pour une Branch.
databricks postgres list-roles PARENT [flags]
Arguments
PARENT
La Branch qui possède cette collection de rôles. Format : projects/{project_id}/branches/{branch_id}.
Options
--page-size int
Limite supérieure pour les éléments renvoyés.
--page-token string
Jeton de page d'une réponse précédente.
Exemples
L'exemple suivant liste tous les rôles dans une Branch :
databricks postgres list-roles projects/my-project-id/branches/my-branch-id
Databricks Postgres undelete-project
Restaurer un projet.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres undelete-project NAME [flags]
Arguments
NAME
Le chemin d'accès complet aux ressources du projet à restaurer. Format : projects/{project_id}
Options
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant récupère un projet supprimé de manière réversible :
databricks postgres undelete-project projects/my-project-id
databricks postgres update-branch
Mettre à jour une Branch.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres update-branch NAME UPDATE_MASK [flags]
Arguments
NAME
Le nom de la ressource de la Branch. Format : projects/{project_id}/branches/{branch_id}
UPDATE_MASK
La liste des champs à mettre à jour. Si non spécifié, tous les champs sont mis à jour lorsque cela est possible.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource Branch.
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant met à jour une Branch pour la protéger :
databricks postgres update-branch projects/my-project-id/branches/my-branch-id spec.is_protected \
--json '{
"spec": {
"is_protected": true
}
}'
databricks postgres update-Endpoint
Mise à jour d'un Endpoint.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres update-endpoint NAME UPDATE_MASK [flags]
Arguments
NAME
Nom de la ressource de l’Endpoint. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
UPDATE_MASK
La liste des champs à mettre à jour. Si non spécifié, tous les champs sont mis à jour lorsque cela est possible.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource de l'Endpoint.
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant met à jour les unités de compute maximales d'un Endpoint :
databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.autoscaling_limit_max_cu \
--json '{
"spec": {
"autoscaling_limit_max_cu": 8.0
}
}'
L'exemple suivant met à jour plusieurs champs (unités de compute min et max) :
databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id "spec.autoscaling_limit_min_cu,spec.autoscaling_limit_max_cu" \
--json '{
"spec": {
"autoscaling_limit_min_cu": 1.0,
"autoscaling_limit_max_cu": 8.0
}
}'
Pour configurer la mise à l'échelle jusqu'à zéro, incluez spec.suspension dans le masque de mise à jour. Définissez suspend_timeout_duration (60s–604800s) pour définir le délai d'inactivité, ou no_suspension: true pour le désactiver. Ne définissez pas les deux. La définition de no_suspension: false renvoie une erreur.
L'exemple suivant désactive le dimensionnement à zéro :
databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.suspension \
--json '{
"spec": {
"no_suspension": true
}
}'
L'exemple suivant active la mise à l'échelle à zéro avec un délai d'inactivité de 5 minutes :
databricks postgres update-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id spec.suspension \
--json '{
"spec": {
"suspend_timeout_duration": "300s"
}
}'
databricks postgres update-project
Mettre à jour un projet.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres update-project NAME UPDATE_MASK [flags]
Arguments
NAME
Le nom de la ressource du projet. Format : projects/{project_id}
UPDATE_MASK
La liste des champs à mettre à jour. Si non spécifié, tous les champs sont mis à jour lorsque cela est possible.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du projet.
--no-wait
N'attendez pas d'atteindre l'état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L'exemple suivant met à jour le nom d'affichage d'un projet :
databricks postgres update-project projects/my-project-id spec.display_name \
--json '{
"spec": {
"display_name": "Updated Project Name"
}
}'
databricks postgres update-role
Mettre à jour un rôle Postgres pour une Branch.
Il s'agit d'une opération de longue durée. Par default, la commande attend la fin de l'opération. Utilisez --no-wait pour revenir immédiatement avec les détails bruts de l'opération. Le champ name de l'Opération peut ensuite être utilisé pour interroger l'achèvement à l'aide de la commande get-operation.
databricks postgres update-role NAME UPDATE_MASK [flags]
Arguments
NAME
Le chemin de ressource complet du rôle. Format : projects/{project_id}/branches/{branch_id}/roles/{role_id}.
UPDATE_MASK
La liste des champs à mettre à jour. Si non spécifié, tous les champs sont mis à jour lorsque cela est possible.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du rôle (sortie seulement).
--no-wait
N’attendez pas d’atteindre l’état TERMINÉ.
--timeout duration
Durée maximale pour atteindre l'état TERMINÉ.
Exemples
L’exemple suivant octroie CREATEDB à un rôle. Lors de la mise à jour de spec.attributes, les trois champs d'attribut doivent être fournis :
databricks postgres update-role projects/my-project-id/branches/my-branch-id/roles/my-role \
spec.attributes \
--json '{"spec": {"attributes": {"createdb": true, "createrole": false, "bypassrls": false'
L'exemple suivant ajoute un rôle à l'adhésion databricks_superuser :
databricks postgres update-role projects/my-project-id/branches/my-branch-id/roles/my-role \
spec.membership_roles \
--json '{"spec": {"membership_roles": ["DATABRICKS_SUPERUSER"]}}'
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