Commande psql

La psql commande dans l’interface CLI Databricks vous permet de vous connecter à une base de données Postgres Lakebase à l’aide d’un client PostgreSQL. Il prend en charge les instances Provisioned Lakebase et les projets de mise à l’échelle automatique Lakebase.

databricks psql

Connectez-vous à une base de données Postgres Lakebase. Cette commande nécessite l’installation d’un psql client sur votre ordinateur.

La commande inclut une logique de nouvelle tentative automatique pour les échecs de connexion. Vous pouvez configurer le comportement de nouvelle tentative à l’aide de l’indicateur --max-retries .

databricks psql [TARGET] [flags] [-- PSQL_ARGS...]

Arguments

TARGET

    Cible à laquelle se connecter. Pour Lakebase Provisioned, spécifiez le nom de l’instance. Pour la mise à l’échelle automatique Lakebase, spécifiez le chemin complet sous la forme projects/<project>/branches/<branch>/endpoints/<endpoint>. En cas d’omission, la commande répertorie les bases de données disponibles pour la sélection interactive.

PSQL_ARGS (facultatif)

    Arguments supplémentaires à passer au psql client. Spécifiez-les après un séparateur double tiret (--).

Options

--autoscaling

    Affichez uniquement les projets de mise à l’échelle automatique Lakebase lors de la liste des bases de données disponibles.

--branch string

    ID de branche pour la mise à l’échelle automatique Lakebase. La valeur par défaut est de sélectionner automatiquement lorsqu’une seule branche existe.

--endpoint string

    ID de point de terminaison pour la mise à l’échelle automatique Lakebase. La valeur par défaut est de sélectionner automatiquement lorsqu’un seul point de terminaison existe.

--max-retries int

    Nombre maximal de tentatives de nouvelle tentative de connexion. Définissez cette option pour 0 désactiver les nouvelles tentatives. Par défaut : 3.

--project string

    Project ID pour la mise à l’échelle automatique Lakebase.

--provisioned

    Affichez uniquement les instances provisionnée Lakebase lors de la liste des bases de données disponibles.

Indicateurs globaux

Examples

L’exemple suivant se connecte à une instance provisionnée Lakebase :

databricks psql my-instance

L’exemple suivant se connecte à un projet de mise à l’échelle automatique Lakebase à l’aide d’indicateurs :

databricks psql --project my-project --branch main --endpoint primary

L’exemple suivant se connecte à un projet de mise à l’échelle automatique Lakebase à l’aide du chemin d’accès complet :

databricks psql projects/my-project/branches/main/endpoints/primary

L’exemple suivant répertorie uniquement les projets de mise à l’échelle automatique Lakebase pour la sélection interactive :

databricks psql --autoscaling

L’exemple suivant transmet des arguments supplémentaires au psql client :

databricks psql my-instance -- -c "SELECT 1"

L’exemple suivant se connecte avec les nouvelles tentatives désactivées :

databricks psql my-instance --max-retries 0

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