lakeview groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 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 lakeview groupe de commandes dans l’interface CLI Databricks contient des commandes pour des opérations de gestion spécifiques pour les tableaux de bord Lakeview. Consultez Tableaux de bord.

créer un lac de données avec Databricks

Créez un tableau de bord brouillon.

databricks lakeview create [flags]

Options

--display-name string

    Nom complet du tableau de bord.

--json JSON

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

--serialized-dashboard string

    Contenu du tableau de bord sous forme de chaîne sérialisée.

--warehouse-id string

    ID d’entrepôt utilisé pour exécuter le tableau de bord.

Indicateurs globaux

Examples

L’exemple suivant crée un tableau de bord avec un nom d'affichage :

databricks lakeview create --display-name "Sales Dashboard" --warehouse-id "abc123"

L’exemple suivant crée un tableau de bord avec la configuration JSON :

databricks lakeview create --json '{"display_name": "Revenue Report", "warehouse_id": "xyz789"}'

databricks lakeview créer-plannification

Créez une planification pour un tableau de bord.

databricks lakeview create-schedule DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient la planification.

Options

--display-name string

    Nom d’affichage de la planification.

--json JSON

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

--pause-status SchedulePauseStatus

    L’état indique si cet horaire est suspendu ou non. Valeurs prises en charge : PAUSED, UNPAUSED

--warehouse-id string

    ID de l’entrepôt avec lequel exécuter le tableau de bord pour la planification.

Indicateurs globaux

Examples

L’exemple suivant crée une planification de tableau de bord :

databricks lakeview create-schedule abc123 --display-name "Daily Sales Report" --warehouse-id "wh456"

L’exemple suivant crée une planification suspendue :

databricks lakeview create-schedule abc123 --display-name "Weekly Report" --pause-status PAUSED --warehouse-id "wh456"

databricks lakeview créer-abonnement

Créez un abonnement pour une planification de tableau de bord.

databricks lakeview create-subscription DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient l’abonnement.

SCHEDULE_ID

    UUID identifiant le planning auquel appartient l’abonnement.

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 sert à créer un abonnement pour un horaire :

databricks lakeview create-subscription abc123 sch456 --json '{"email": "someone@example.com"}'

databricks lakeview supprimer-emploi du temps

Supprimez une planification pour un tableau de bord.

databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient la planification.

SCHEDULE_ID

    UUID identifiant la planification.

Options

--etag string

    etag pour la planification.

Indicateurs globaux

Examples

L’exemple suivant supprime une planification de tableau de bord :

databricks lakeview delete-schedule abc123 sch456

L’exemple suivant supprime une planification avec etag :

databricks lakeview delete-schedule abc123 sch456 --etag "v1.0"

databricks lakeview supprimer l'abonnement

Supprimez un abonnement pour un planning de tableau de bord.

databricks lakeview delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient l’abonnement.

SCHEDULE_ID

    UUID identifiant l'horaire auquel appartient l’abonnement.

SUBSCRIPTION_ID

    UUID identifiant l’abonnement.

Options

--etag string

    etag pour l’abonnement.

Indicateurs globaux

Examples

L’exemple suivant supprime un abonnement :

databricks lakeview delete-subscription abc123 sch456 sub789

L’exemple suivant supprime un abonnement avec etag :

databricks lakeview delete-subscription abc123 sch456 sub789 --etag "v1.0"

databricks lakeview obtenir

Accéder à un tableau de bord d'ébauche.

databricks lakeview get DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient un tableau de bord :

databricks lakeview get abc123

databricks lakeview publication obtenir

Obtenez le tableau de bord publié actuel.

databricks lakeview get-published DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord publié.

Options

Indicateurs globaux

Examples

L’exemple suivant accède à un tableau de bord publié :

databricks lakeview get-published abc123

databricks lakeview obtenir-horaire

Obtenez une planification pour un tableau de bord.

databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient la planification.

SCHEDULE_ID

    UUID identifiant la planification.

Options

Indicateurs globaux

Examples

L'exemple suivant montre comment obtenir le programme d'un tableau de bord :

databricks lakeview get-schedule abc123 sch456

databricks vue-lac obtenir-abonnement

Obtenez un abonnement pour une planification de tableau de bord.

databricks lakeview get-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient l’abonnement.

SCHEDULE_ID

    UUID identifiant l'horaire auquel appartient l’abonnement.

SUBSCRIPTION_ID

    UUID identifiant l’abonnement.

Options

Indicateurs globaux

Examples

L’exemple suivant obtient un abonnement :

databricks lakeview get-subscription abc123 sch456 sub789

Liste des Databricks Lakeview

Répertorier tous les tableaux de bord.

databricks lakeview list [flags]

Options

--page-size int

    Nombre de tableaux de bord à afficher par page.

--page-token string

    Jeton de page reçu d’un appel ListDashboards précédent.

--show-trashed

    Indicateur permettant d’inclure des tableaux de bord se trouvant dans la corbeille.

--view DashboardView

     DASHBOARD_VIEW_BASIC inclut uniquement les métadonnées récapitulatives du tableau de bord. Valeurs prises en charge : DASHBOARD_VIEW_BASIC

Indicateurs globaux

Examples

L’exemple suivant répertorie tous les tableaux de bord :

databricks lakeview list

L’exemple suivant répertorie les tableaux de bord avec une taille de page spécifique :

databricks lakeview list --page-size 10

L’exemple suivant répertorie les tableaux de bord, y compris ceux supprimés :

databricks lakeview list --show-trashed

L’exemple suivant répertorie les tableaux de bord avec une vue de base :

databricks lakeview list --view DASHBOARD_VIEW_BASIC

databricks lakeview: liste des plannings

Répertorier toutes les planifications d’un tableau de bord.

databricks lakeview list-schedules DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient les planifications.

Options

--page-size int

    Nombre de planifications à retourner par page.

--page-token string

    Jeton de page reçu d’un appel ListSchedules précédent.

Indicateurs globaux

Examples

L’exemple suivant répertorie les planifications d’un tableau de bord :

databricks lakeview list-schedules abc123

databricks lakeview lister-les-souscriptions

Répertoriez tous les abonnements pour une planification de tableau de bord.

databricks lakeview list-subscriptions DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel les abonnements appartiennent.

SCHEDULE_ID

    UUID identifiant le calendrier auquel sont associés les abonnements.

Options

--page-size int

    Nombre d’abonnements à afficher par page.

--page-token string

    Jeton de page, reçu lors d’un appel précédemment passé à ListSubscriptions.

Indicateurs globaux

Examples

L’exemple suivant répertorie les abonnements pour un calendrier :

databricks lakeview list-subscriptions abc123 sch456

migration de databricks Lakeview

Migrez un tableau de bord SQL classique vers Lakeview.

databricks lakeview migrate SOURCE_DASHBOARD_ID [flags]

Arguments

SOURCE_DASHBOARD_ID

    UUID du tableau de bord à migrer.

Options

--display-name string

    Nom d'affichage pour le nouveau tableau de bord Lakeview.

--json JSON

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

--parent-path string

    Chemin d'accès à l'espace de travail du dossier contenant le tableau de bord Lakeview migré.

--update-parameter-syntax

    Indicateur pour indiquer si la syntaxe du paramètre mustache ({{ param }}) doit être mise à jour automatiquement en syntaxe nommée (:param) lors de la conversion de jeux de données dans le tableau de bord.

Indicateurs globaux

Examples

L’exemple suivant migre un tableau de bord SQL classique vers Lakeview :

databricks lakeview migrate old123 --display-name "Migrated Sales Dashboard"

L’exemple suivant migre un tableau de bord vers un dossier spécifique :

databricks lakeview migrate old123 --display-name "Migrated Report" --parent-path "/Workspace/Reports"

L’exemple suivant migre un tableau de bord avec la mise à jour de la syntaxe des paramètres :

databricks lakeview migrate old123 --display-name "Migrated Dashboard" --update-parameter-syntax

Publication Databricks Lakeview

Publiez le tableau de bord brouillon actuel.

databricks lakeview publish DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord à publier.

Options

--embed-credentials

    Indicateur pour indiquer si les informations d’identification de l’éditeur doivent être incorporées dans le tableau de bord publié.

--json JSON

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

--warehouse-id string

    ID de l’entrepôt qui peut être utilisé pour remplacer l’entrepôt qui a été défini dans le brouillon.

Indicateurs globaux

Examples

L’exemple suivant publie un tableau de bord :

databricks lakeview publish abc123

L’exemple suivant publie un tableau de bord avec des autorisations de données partagées :

databricks lakeview publish abc123 --embed-credentials

L’exemple suivant publie un tableau de bord avec un entrepôt spécifique :

databricks lakeview publish abc123 --warehouse-id "wh456"

Corbeille Databricks Lakeview

Supprimer un tableau de bord.

databricks lakeview trash DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord.

Options

Indicateurs globaux

Examples

L’exemple suivant supprime un tableau de bord :

databricks lakeview trash abc123

databricks lakeview dépublier

Annulez la publication du tableau de bord.

databricks lakeview unpublish DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord publié.

Options

Indicateurs globaux

Examples

L’exemple suivant annule la publication d’un tableau de bord :

databricks lakeview unpublish abc123

mise à jour de Databricks Lakeview

Mettez à jour un brouillon de tableau de bord.

databricks lakeview update DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord.

Options

--display-name string

    Nom complet du tableau de bord.

--json JSON

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

--serialized-dashboard string

    Contenu du tableau de bord sous forme de chaîne sérialisée.

--warehouse-id string

    ID d’entrepôt utilisé pour exécuter le tableau de bord.

Indicateurs globaux

Examples

L’exemple suivant met à jour le nom d'affichage d’un tableau de bord :

databricks lakeview update abc123 --display-name "Updated Sales Dashboard"

L’exemple suivant met à jour l’entrepôt d’un tableau de bord :

databricks lakeview update abc123 --warehouse-id "wh456"

databricks lakeview programme de mise à jour

Mettez à jour une planification pour un tableau de bord.

databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID identifiant le tableau de bord auquel appartient la planification.

SCHEDULE_ID

    UUID identifiant la planification.

Options

--display-name string

    Nom d’affichage de la planification.

--json JSON

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

--pause-status SchedulePauseStatus

    L’état indique si cet horaire est suspendu ou non. Valeurs prises en charge : PAUSED, UNPAUSED

--warehouse-id string

    ID de l’entrepôt avec lequel exécuter le tableau de bord pour la planification.

Indicateurs globaux

Examples

L'exemple suivant met à jour le nom d'affichage d'un calendrier :

databricks lakeview update-schedule abc123 sch456 --display-name "Updated Daily Report"

L’exemple suivant suspend une planification :

databricks lakeview update-schedule abc123 sch456 --pause-status PAUSED

L’exemple suivant met à jour une planification avec un autre entrepôt :

databricks lakeview update-schedule abc123 sch456 --warehouse-id "wh789"

Indicateurs globaux

--debug

  Active 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

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

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    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

    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 d’affichage des journaux d’activité de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser