lakeview группа команд

Note

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

Использование интерфейса командной строки Databricks подчиняется лицензии Databricks и уведомлению о конфиденциальности Databricks, включая любые положения о данных использования.

Группа lakeview команд в интерфейсе командной строки Databricks содержит команды для определенных операций управления для панелей мониторинга Lakeview. См. панели мониторинга.

создание Databricks Lakeview

Создайте черновик панели мониторинга.

databricks lakeview create [flags]

Options

--display-name string

    Отображаемое имя панели мониторинга.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--serialized-dashboard string

    Содержимое панели мониторинга в сериализованной строковой форме.

--warehouse-id string

    Идентификатор хранилища, используемый для запуска панели мониторинга.

Глобальные флаги

Examples

В следующем примере создается новая панель мониторинга с отображаемым именем:

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

В следующем примере создается панель мониторинга с конфигурацией JSON:

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

databricks lakeview создать-расписание

Создание расписания для панели мониторинга.

databricks lakeview create-schedule DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит расписание.

Options

--display-name string

    Отображаемое имя расписания.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--pause-status SchedulePauseStatus

    Состояние указывает, приостановлено ли это расписание. Поддерживаемые значения: PAUSED, UNPAUSED

--warehouse-id string

    Идентификатор хранилища для запуска панели мониторинга в соответствии с расписанием.

Глобальные флаги

Examples

В следующем примере создается расписание панели мониторинга:

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

В следующем примере создается приостановленное расписание:

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

databricks lakeview создать-подписку

Создайте подписку для расписания панели мониторинга.

databricks lakeview create-subscription DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит подписка.

SCHEDULE_ID

    UUID, идентификатор, определяющий расписание, к которому принадлежит подписка.

Options

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

Глобальные флаги

Examples

В следующем примере создается подписка для расписания:

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

Databricks Lakeview удалить-расписание

Удалите расписание для панели мониторинга.

databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит расписание.

SCHEDULE_ID

    UUID определяющий расписание.

Options

--etag string

    etag для расписания.

Глобальные флаги

Examples

В следующем примере удаляется расписание панели мониторинга:

databricks lakeview delete-schedule abc123 sch456

В следующем примере удаляется расписание с ETag:

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

databricks lakeview удаление-подписки

Удаление подписки на расписание панели мониторинга.

databricks lakeview delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит подписка.

SCHEDULE_ID

    UUID, определяющий расписание, к которому подписка принадлежит.

SUBSCRIPTION_ID

    UUID, определяющий подписку.

Options

--etag string

    Etag для подписки.

Глобальные флаги

Examples

В следующем примере удаляется подписка:

databricks lakeview delete-subscription abc123 sch456 sub789

В следующем примере удаляется подписка с etag:

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

Получить databricks lakeview

Получите черновик панели мониторинга.

databricks lakeview get DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    Идентификатор UUID, определяющий панель мониторинга.

Options

Глобальные флаги

Examples

В следующем примере получается панель мониторинга:

databricks lakeview get abc123

databricks lakeview опубликовать

Получите текущую опубликованную панель мониторинга.

databricks lakeview get-published DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий опубликованную панель мониторинга.

Options

Глобальные флаги

Examples

Следующий пример получает опубликованную панель мониторинга:

databricks lakeview get-published abc123

databricks lakeview запросить-расписание

Получение расписания для панели мониторинга.

databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит расписание.

SCHEDULE_ID

    UUID определяющий расписание.

Options

Глобальные флаги

Examples

В следующем примере показано, как запланировать панель мониторинга:

databricks lakeview get-schedule abc123 sch456

databricks lakeview get-subscription (получить подписку)

Оформите подписку на расписание для панели мониторинга.

databricks lakeview get-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит подписка.

SCHEDULE_ID

    UUID, определяющий расписание, к которому подписка принадлежит.

SUBSCRIPTION_ID

    UUID, определяющий подписку.

Options

Глобальные флаги

Examples

Следующий пример получает подписку:

databricks lakeview get-subscription abc123 sch456 sub789

список Databricks Lakeview

Список всех панелей мониторинга.

databricks lakeview list [flags]

Options

--page-size int

    Количество панелей мониторинга, возвращаемых на страницу.

--page-token string

    Маркер страницы, полученный из предыдущего вызова ListDashboards.

--show-trashed

    Флаг для включения панелей мониторинга, расположенных в корзине.

--view DashboardView

     DASHBOARD_VIEW_BASIC Содержит только сводные метаданные из информационной панели. Поддерживаемые значения: DASHBOARD_VIEW_BASIC

Глобальные флаги

Examples

В следующем примере перечислены все панели мониторинга:

databricks lakeview list

В следующем примере перечислены панели мониторинга с определенным размером страницы:

databricks lakeview list --page-size 10

В следующем примере перечислены панели мониторинга, включая удаленные.

databricks lakeview list --show-trashed

В следующем примере перечислены панели мониторинга с базовым представлением:

databricks lakeview list --view DASHBOARD_VIEW_BASIC

список расписаний в databricks lakeview

Вывод списка всех расписаний для панели мониторинга.

databricks lakeview list-schedules DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежат расписания.

Options

--page-size int

    Количество расписаний, возвращаемых на страницу.

--page-token string

    Маркер страницы, полученный из предыдущего вызова ListSchedules.

Глобальные флаги

Examples

В следующем примере перечислены расписания для панели мониторинга:

databricks lakeview list-schedules abc123

Databricks Lakeview список-подписок

Список всех подписок на расписание для панели мониторинга.

databricks lakeview list-subscriptions DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежат подписки.

SCHEDULE_ID

    UUID, определяющий расписание, к которому относятся подписки.

Options

--page-size int

    Количество подписок, возвращаемых на страницу.

--page-token string

    Маркер страницы, полученный из предыдущего вызова ListSubscriptions.

Глобальные флаги

Examples

В следующем примере перечислены подписки для расписания:

databricks lakeview list-subscriptions abc123 sch456

Миграция Databricks Lakeview

Перенос классической панели мониторинга SQL в Lakeview.

databricks lakeview migrate SOURCE_DASHBOARD_ID [flags]

Arguments

SOURCE_DASHBOARD_ID

    UUID дашборда для переноса.

Options

--display-name string

    Имя отображения для новой панели Lakeview.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--parent-path string

    Путь к папке рабочей области для хранения перенесенной панели мониторинга Lakeview.

--update-parameter-syntax

    Флаг, указывающий, следует ли автоматически обновлять синтаксис параметров "mustache" ({{ param }}) до именованного синтаксиса (:param) при преобразовании наборов данных на панели мониторинга.

Глобальные флаги

Examples

В следующем примере выполняется перенос классической панели мониторинга SQL в Lakeview:

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

В следующем примере панель мониторинга переносится в определенную папку:

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

В следующем примере выполняется перенос панели мониторинга с обновлением синтаксиса параметров:

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

публикация Databricks LakeView

Опубликуйте черновую приборную панель.

databricks lakeview publish DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий опубликованную панель мониторинга.

Options

--embed-credentials

    Пометка, чтобы указать, должны ли учетные данные издателя быть внедрены в опубликованную панель мониторинга.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--warehouse-id string

    Идентификатор склада, который можно использовать для переопределения склада, заданного в черновике.

Глобальные флаги

Examples

В следующем примере публикуется панель мониторинга:

databricks lakeview publish abc123

В следующем примере публикуется панель мониторинга с общими разрешениями данных:

databricks lakeview publish abc123 --embed-credentials

В следующем примере публикуется панель мониторинга с определенным хранилищем:

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

databricks lakeview корзина

Удалить панель мониторинга.

databricks lakeview trash DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    Идентификатор UUID, определяющий панель мониторинга.

Options

Глобальные флаги

Examples

В следующем примере удаляется панель мониторинга:

databricks lakeview trash abc123

Databricks Lakeview отменить публикацию

Отмена публикации панели мониторинга.

databricks lakeview unpublish DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий опубликованную панель мониторинга.

Options

Глобальные флаги

Examples

Следующий пример отмены публикации панели мониторинга:

databricks lakeview unpublish abc123

обновление Databricks Lakeview

Обновите черновик панели мониторинга.

databricks lakeview update DASHBOARD_ID [flags]

Arguments

DASHBOARD_ID

    Идентификатор UUID, определяющий панель мониторинга.

Options

--display-name string

    Отображаемое имя панели мониторинга.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--serialized-dashboard string

    Содержимое панели мониторинга в сериализованной строковой форме.

--warehouse-id string

    Идентификатор хранилища, используемый для запуска панели мониторинга.

Глобальные флаги

Examples

В следующем примере обновляется отображаемое имя панели мониторинга:

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

В следующем примере обновляется хранилище панели мониторинга:

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

обновление расписания в DataBricks Lakeview

Обновление расписания для панели мониторинга.

databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]

Arguments

DASHBOARD_ID

    UUID, определяющий панель мониторинга, к которой принадлежит расписание.

SCHEDULE_ID

    UUID определяющий расписание.

Options

--display-name string

    Отображаемое имя расписания.

--json JSON

    Строка JSON inline или @path к JSON-файлу с телом запроса.

--pause-status SchedulePauseStatus

    Состояние указывает, приостановлено ли это расписание. Поддерживаемые значения: PAUSED, UNPAUSED

--warehouse-id string

    Идентификатор хранилища для запуска панели мониторинга в соответствии с расписанием.

Глобальные флаги

Examples

В следующем примере обновляется отображаемое имя расписания:

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

Следующий пример приостанавливает расписание:

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

В следующем примере обновляется расписание для другого склада:

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

Глобальные флаги

--debug

  Следует ли включить ведение журнала отладки.

-h или --help

    Отобразить справку по интерфейсу командной строки Databricks, связанной группе команд или отдельной команде.

--log-file струна

    Строка, представляющая файл для записи журналов выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.

--log-format формат

    Тип формата журнала: text или json. Значение по умолчанию — text.

--log-level струна

    Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.

типа -o, --output

    Тип выходных данных команды: text или json. Значение по умолчанию — text.

-p, --profile струна

    Имя профиля в ~/.databrickscfg файле, используемого для выполнения команды. Если флаг не указан, используется профиль DEFAULT, если он существует.

--progress-format формат

    Формат для отображения журналов хода выполнения: default, appendinplace, илиjson

-t, --target струна

    Если применимо, целевой объект пакета для использования