Partager via

postgres groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.285 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 postgres groupe de commandes dans l’interface CLI Databricks contient des commandes pour gérer les ressources Postgres Lakebase, notamment les projets, les branches et les points de terminaison. L’API Postgres permet d’accéder à une base de données Postgres via l’API REST ou sql direct.

databricks postgres create-branch

Créez une branche. Lors de la création d’une branche, vous devez spécifier une stratégie d’expiration à l’aide no_expiry: true de branches permanentes.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres create-branch PARENT BRANCH_ID [flags]

Arguments

PARENT

    Projet dans lequel cette branche est créée. Format : projects/{project_id}

BRANCH_ID

    ID à utiliser pour la branche, qui devient le composant final du nom de la ressource de la branche. Doit comporter 1 à 63 caractères, commencer par une lettre minuscule et contenir uniquement des lettres minuscules, des chiffres et des traits d’union (RFC 1123).

Options

--json JSON

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

--name string

    Nom de la ressource de la branche.

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant crée une branche dans un projet :

databricks postgres create-branch projects/my-project-id my-branch \
  --json '{
    "spec": {
      "no_expiry": true
    }
  }'

L’exemple suivant crée une branche à partir d’une branche 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-endpoint

Créez un point de terminaison. Une branche peut avoir un point de terminaison de calcul en lecture-écriture et plusieurs points de terminaison en lecture seule (réplicas en lecture) pour la mise à l’échelle des opérations de lecture.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres create-endpoint PARENT ENDPOINT_ID [flags]

Arguments

PARENT

    Branche où ce point de terminaison est créé. Format : projects/{project_id}/branches/{branch_id}

ENDPOINT_ID

    ID à utiliser pour le point de terminaison, qui devient le composant final du nom de ressource du point de terminaison. Doit comporter 1 à 63 caractères, commencer par une lettre minuscule et contenir uniquement des lettres minuscules, des chiffres et des traits d’union (RFC 1123).

Options

--json JSON

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

--name string

    Nom de la ressource du point de terminaison.

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant crée un point de terminaison en lecture-écriture dans une branche :

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 point de terminaison 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éez un projet.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

Lorsque vous créez un projet, il inclut automatiquement une branche de production par défaut et un point de terminaison de calcul en lecture-écriture, à la fois avec des ID générés automatiquement.

databricks postgres create-project PROJECT_ID [flags]

Arguments

PROJECT_ID

    ID à utiliser pour le projet, qui devient le composant final du nom de la ressource du projet. Doit comporter 1 à 63 caractères, commencer par une lettre minuscule et contenir uniquement des lettres minuscules, des chiffres et des traits d’union (RFC 1123).

Options

--json JSON

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

--name string

    Nom de la ressource du projet.

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

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 PostgreSQL spécifique :

databricks postgres create-project my-project \
  --json '{
    "spec": {
      "display_name": "My Project",
      "pg_version": "17"
    }
  }'

databricks postgres delete-branch

Supprimez une branche.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

Les branches protégées ne peuvent pas être supprimées. Permet update-branch de définir spec.is_protectedfalse la valeur avant la suppression.

databricks postgres delete-branch NAME [flags]

Arguments

NAME

    Nom de la branche à supprimer. Format : projects/{project_id}/branches/{branch_id}

Options

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant supprime une branche :

databricks postgres delete-branch projects/my-project-id/branches/my-branch-id

databricks postgres delete-endpoint

Supprimez un point de terminaison.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres delete-endpoint NAME [flags]

Arguments

NAME

    Nom du point de terminaison à supprimer. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant supprime un point de terminaison :

databricks postgres delete-endpoint projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id

databricks postgres delete-project

Supprimez un projet.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres delete-project NAME [flags]

Arguments

NAME

    Nom du projet à supprimer. Format : projects/{project_id}

Options

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant supprime un projet :

databricks postgres delete-project projects/my-project-id

databricks postgres generate-database-credential

Générez des informations d’identification OAuth pour une base de données Postgres. Le jeton OAuth retourné 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

    Point de terminaison pour lequel ces informations d’identification sont générées. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

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 génère des informations d’identification OAuth pour un point de terminaison :

databricks postgres generate-database-credential projects/my-project-id/branches/my-branch-id/endpoints/my-endpoint-id

databricks postgres get-branch

Obtenir une branche.

databricks postgres get-branch NAME [flags]

Arguments

NAME

    Nom de la branche à récupérer. Format : projects/{project_id}/branches/{branch_id}

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des informations sur une branche :

databricks postgres get-branch projects/my-project-id/branches/my-branch-id

databricks postgres get-endpoint

Obtenir un point de terminaison.

databricks postgres get-endpoint NAME [flags]

Arguments

NAME

    Nom du point de terminaison à récupérer. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des informations sur un point de terminaison :

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

    Nom de la ressource d’opération.

Options

Indicateurs globaux

Examples

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

Obtenir un projet.

databricks postgres get-project NAME [flags]

Arguments

NAME

    Nom du projet à récupérer. Format : projects/{project_id}

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des informations sur un projet :

databricks postgres get-project projects/my-project-id

databricks postgres list-branches

Répertorier les branches. Utilisez cette commande pour rechercher les ID de branche, y compris la branche par défaut créée avec votre projet (indiquée par "default": true l’état).

databricks postgres list-branches PARENT [flags]

Arguments

PARENT

    Projet propriétaire de cette collection de branches. Format : projects/{project_id}

Options

--page-size int

    Limite supérieure pour les éléments retournés.

--page-token string

    Jeton de page d’une réponse précédente.

Indicateurs globaux

Examples

L’exemple suivant répertorie toutes les branches d’un projet :

databricks postgres list-branches projects/my-project-id

L’exemple suivant répertorie les branches avec pagination :

databricks postgres list-branches projects/my-project-id --page-size 10

databricks postgres list-endpoints

Répertorier les points de terminaison. Utilisez cette commande pour rechercher les ID de point de terminaison, y compris le point de terminaison en lecture-écriture par défaut créé automatiquement avec votre projet.

databricks postgres list-endpoints PARENT [flags]

Arguments

PARENT

    Branche propriétaire de cette collection de points de terminaison. Format : projects/{project_id}/branches/{branch_id}

Options

--page-size int

    Limite supérieure pour les éléments retournés.

--page-token string

    Jeton de page d’une réponse précédente.

Indicateurs globaux

Examples

L’exemple suivant répertorie tous les points de terminaison d’une branche :

databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id

L’exemple suivant répertorie les points de terminaison avec pagination :

databricks postgres list-endpoints projects/my-project-id/branches/my-branch-id --page-size 10

databricks postgres list-projects

Liste les projets.

databricks postgres list-projects [flags]

Options

--page-size int

    Limite supérieure pour les éléments retournés.

--page-token string

    Jeton de page d’une réponse précédente.

Indicateurs globaux

Examples

L’exemple suivant répertorie tous les projets :

databricks postgres list-projects

L’exemple suivant répertorie les projets avec pagination :

databricks postgres list-projects --page-size 10

databricks postgres update-branch

Mettez à jour une branche.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres update-branch NAME UPDATE_MASK [flags]

Arguments

NAME

    Nom de la ressource de la branche. Format : projects/{project_id}/branches/{branch_id}

UPDATE_MASK

    Liste des champs à mettre à jour. Si ce n’est pas spécifié, tous les champs sont mis à jour lorsque cela est possible.

Options

--json JSON

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

--name string

    Nom de la ressource de la branche.

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant met à jour une branche 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

Mettez à jour un point de terminaison.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres update-endpoint NAME UPDATE_MASK [flags]

Arguments

NAME

    Nom de la ressource du point de terminaison. Format : projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

UPDATE_MASK

    Liste des champs à mettre à jour. Si ce n’est pas spécifié, tous les champs sont mis à jour lorsque cela est possible.

Options

--json JSON

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

--name string

    Nom de la ressource du point de terminaison.

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant met à jour les unités de calcul maximales d’un point de terminaison :

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 calcul minimales et maximales) :

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
    }
  }'

databricks postgres update-project

Mettez à jour un projet.

Note

Il s’agit d’une opération longue. Par défaut, la commande attend la fin de l’opération. Permet --no-wait de retourner immédiatement avec les détails de l’opération brute. Le champ de l’opération peut ensuite être utilisé pour interroger la saisie semi-automatique à l’aide de name la get-operation commande.

databricks postgres update-project NAME UPDATE_MASK [flags]

Arguments

NAME

    Nom de la ressource du projet. Format : projects/{project_id}

UPDATE_MASK

    Liste des champs à mettre à jour. Si ce n’est pas spécifié, tous les champs sont mis à jour lorsque cela est possible.

Options

--json JSON

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

--name string

    Nom de la ressource du projet.

--no-wait

    N’attendez pas d’atteindre l’état DONE.

--timeout duration

    Durée maximale d’atteindre l’état DONE.

Indicateurs globaux

Examples

L’exemple suivant met à jour le nom complet d’un projet :

databricks postgres update-project projects/my-project-id spec.display_name \
  --json '{
    "spec": {
      "display_name": "Updated Project Name"
    }
  }'

Indicateurs globaux

--debug

  Faut-il activer 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 de caractères

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

--log-format Format

    Type de format de journal : text ou json. La valeur par défaut est text.

--log-level chaîne de caractères

    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 de caractères

    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 permettant d’afficher les journaux de progression : default, append, inplace ou json

-t, --target chaîne de caractères

    Le cas échéant, la cible d'ensemble à utiliser

  • Last updated on