Aller au contenu principal

groupe de commandeslakeview

remarque

L'utilisation de la CLI Databricks est soumise à la licence Databricks et à la politique de confidentialité de Databricks, y compris toute disposition relative aux données d'utilisation.

Le groupe de commandes lakeview de la CLI Databricks contient des commandes pour des opérations de gestion spécifiques des tableaux de bord Lakeview. Consultez les tableaux de bord.

databricks Lakeview créer

Créez un tableau de bord provisoire.

databricks lakeview create [flags]

Options

--display-name string

Le nom d'affichage du tableau de bord.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--serialized-dashboard string

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

--warehouse-id string

L'ID du warehouse utilisé pour exécuter le tableau de bord.

Indicateurs globaux

Exemples

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

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

L'exemple suivant crée un tableau de bord avec une configuration JSON :

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

databricks lakeview create-schedule

Créer une planification pour un tableau de bord.

databricks lakeview create-schedule DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

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

Options

--display-name string

Le nom d'affichage du planning.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--pause-status SchedulePauseStatus

Le statut indique si ce planning est suspendu ou non. Valeurs supportées : PAUSED, UNPAUSED

--warehouse-id string

ID du warehouse pour l'exécution planifiée du tableau de bord.

Indicateurs globaux

Exemples

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

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

L'exemple suivant crée un planning suspendu :

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

Databricks Lakeview create-subscription

Créer 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 l'abonnement appartient.

SCHEDULE_ID

UUID identifiant le calendrier auquel l'abonnement appartient.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant crée un abonnement pour un planning :

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

Databricks Lakeview supprimer-planification

Supprimer un calendrier pour un tableau de bord.

databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

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

SCHEDULE_ID

UUID identifiant la planification.

Options

--etag string

L'etag du planning.

Indicateurs globaux

Exemples

L'exemple suivant supprime un calendrier de tableau de bord :

Bash
databricks lakeview delete-schedule abc123 sch456

L'exemple suivant supprime une planification avec l'etag :

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

databricks lakeview delete-subscription

Supprimer 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 l'abonnement appartient.

SCHEDULE_ID

UUID identifiant le calendrier auquel l'abonnement appartient.

SUBSCRIPTION_ID

UUID identifiant l'abonnement.

Options

--etag string

L'etag pour l'abonnement.

Indicateurs globaux

Exemples

L'exemple suivant supprime un abonnement :

Bash
databricks lakeview delete-subscription abc123 sch456 sub789

L'exemple suivant supprime un abonnement avec etag :

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

databricks lakeview get

Obtenir un tableau de bord brouillon.

databricks lakeview get DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

L'UUID identifiant le tableau de bord.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient un tableau de bord :

Bash
databricks lakeview get abc123

databricks lakeview get-published

Obtenez le tableau de bord actuellement publié.

databricks lakeview get-published DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

UUID identifiant le tableau de bord publié.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient un tableau de bord publié :

Bash
databricks lakeview get-published abc123

Databricks Lakeview obtenir-la-planification

Obtenez un calendrier pour un tableau de bord.

databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

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

SCHEDULE_ID

UUID identifiant la planification.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient un calendrier de tableau de bord :

Bash
databricks lakeview get-schedule abc123 sch456

databricks lakeview get-subscription

Obtenir 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 l'abonnement appartient.

SCHEDULE_ID

UUID identifiant le calendrier auquel l'abonnement appartient.

SUBSCRIPTION_ID

UUID identifiant l'abonnement.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient un abonnement :

Bash
databricks lakeview get-subscription abc123 sch456 sub789

databricks lakeview list

Lister tous les tableaux de bord.

databricks lakeview list [flags]

Options

--page-size int

Le nombre de tableaux de bord à retourner par page.

--page-token string

Un jeton de page, reçu d'un appel ListDashboards précédent.

--show-trashed

L'option pour inclure les tableaux de bord situés 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

Exemples

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

Bash
databricks lakeview list

L'exemple suivant liste les tableaux de bord avec une taille de page spécifique :

Bash
databricks lakeview list --page-size 10

L'exemple suivant répertorie les tableaux de bord, y compris ceux mis à la corbeille :

Bash
databricks lakeview list --show-trashed

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

Bash
databricks lakeview list --view DASHBOARD_VIEW_BASIC

Databricks Lakeview list-schedules

Lister tous les calendriers pour un tableau de bord.

databricks lakeview list-schedules DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

UUID identifiant le tableau de bord auquel appartiennent les horaires.

Options

--page-size int

Le nombre de planifications à renvoyer par page.

--page-token string

Un jeton de page, reçu d'un appel ListSchedules précédent.

Indicateurs globaux

Exemples

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

Bash
databricks lakeview list-schedules abc123

databricks lakeview list-subscriptions

Répertorier tous les abonnements pour un programme 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 la planification à laquelle les abonnements appartiennent.

Options

--page-size int

Le nombre d'abonnements à retourner par page.

--page-token string

Un jeton de page, reçu d’un précédent appel ListSubscriptions.

Indicateurs globaux

Exemples

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

Bash
databricks lakeview list-subscriptions abc123 sch456

migration 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 du nouveau tableau de bord Lakeview.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--parent-path string

Le chemin du Workspace du dossier devant contenir le tableau de bord Lakeview migré.

--update-parameter-syntax

Indicateur pour spécifier si la syntaxe de paramètre mustache ({{ param }}) doit être automatiquement mise à jour vers la syntaxe nommée (:param) lors de la conversion des datasets dans le tableau de bord.

Indicateurs globaux

Exemples

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

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

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

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

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

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

Databricks Lakeview publier

Publier le tableau de bord provisoire 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 intégrées dans le tableau de bord publié.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--warehouse-id string

L'ID du warehouse qui peut être utilisé pour remplacer le warehouse qui a été défini dans le brouillon.

Indicateurs globaux

Exemples

L'exemple suivant publie un tableau de bord :

Bash
databricks lakeview publish abc123

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

Bash
databricks lakeview publish abc123 --embed-credentials

L'exemple suivant publie un tableau de bord avec un warehouse spécifique :

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

Corbeille Lakeview Databricks

Mettre un tableau de bord à la corbeille.

databricks lakeview trash DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

L'UUID identifiant le tableau de bord.

Options

Indicateurs globaux

Exemples

L'exemple suivant déplace un tableau de bord vers la corbeille :

Bash
databricks lakeview trash abc123

databricks lakeview annulation de publication

Annuler 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

Exemples

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

Bash
databricks lakeview unpublish abc123

Mise à jour de Databricks Lakeview

Mettre à jour un tableau de bord en brouillon.

databricks lakeview update DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

L'UUID identifiant le tableau de bord.

Options

--display-name string

Le nom d'affichage du tableau de bord.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--serialized-dashboard string

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

--warehouse-id string

L'ID du warehouse utilisé pour exécuter le tableau de bord.

Indicateurs globaux

Exemples

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

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

L'exemple suivant met à jour le warehouse d'un tableau de bord :

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

databricks lakeview update-schedule

Mettre à jour un calendrier pour un tableau de bord.

databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

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

SCHEDULE_ID

UUID identifiant la planification.

Options

--display-name string

Le nom d'affichage du planning.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--pause-status SchedulePauseStatus

Le statut indique si ce planning est suspendu ou non. Valeurs supportées : PAUSED, UNPAUSED

--warehouse-id string

ID du warehouse pour l'exécution planifiée du tableau de bord.

Indicateurs globaux

Exemples

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

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

L'exemple suivant suspend un calendrier :

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

L'exemple suivant met à jour une planification avec un warehouse différent :

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

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