Class LakeviewClient

Constructors

constructor

new LakeviewClient(options: ClientOptions): LakeviewClient
Parameters
- options: ClientOptions
Returns LakeviewClient
- Defined in client.ts:92

Methods

createDashboard

createDashboard(
req: CreateDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Create a draft dashboard.

Requires the Databricks SQL access entitlement.
Parameters
- req: CreateDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:112

createSchedule

createSchedule(
req: CreateScheduleRequest,
options?: CallOptions,
): Promise<Schedule>
Create dashboard schedule.
Parameters
- req: CreateScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<Schedule>
- Defined in client.ts:157

createSubscription

createSubscription(
req: CreateSubscriptionRequest,
options?: CallOptions,
): Promise<Subscription>
Create schedule subscription.
Parameters
- req: CreateSubscriptionRequest
- Optionaloptions: CallOptions
Returns Promise<Subscription>
- Defined in client.ts:187

deleteSchedule

deleteSchedule(req: DeleteScheduleRequest, options?: CallOptions): Promise<void>
Delete dashboard schedule.
Parameters
- req: DeleteScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:220

deleteSubscription

deleteSubscription(
req: DeleteSubscriptionRequest,
options?: CallOptions,
): Promise<void>
Delete schedule subscription.
Parameters
- req: DeleteSubscriptionRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:249

getDashboard

getDashboard(
req: GetDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Get a draft dashboard.

Requires the Databricks SQL access entitlement.
Parameters
- req: GetDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:282

getPublishedDashboard

getPublishedDashboard(
req: GetPublishedDashboardRequest,
options?: CallOptions,
): Promise<PublishedDashboard>
Get the current published dashboard.

The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.

Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
Parameters
- req: GetPublishedDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<PublishedDashboard>
- Defined in client.ts:319

getPublishedDashboardTokenInfo

getPublishedDashboardTokenInfo(
req: GetPublishedDashboardTokenInfoRequest,
options?: CallOptions,
): Promise<GetPublishedDashboardTokenInfoResponse>
Get a required authorization details and scopes of a published dashboard to mint an OAuth token.

The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.

Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
Parameters
- req: GetPublishedDashboardTokenInfoRequest
- Optionaloptions: CallOptions
Returns Promise<GetPublishedDashboardTokenInfoResponse>
- Defined in client.ts:356

getSchedule

getSchedule(req: GetScheduleRequest, options?: CallOptions): Promise<Schedule>
Get dashboard schedule.
Parameters
- req: GetScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<Schedule>
- Defined in client.ts:397

getSubscription

getSubscription(
req: GetSubscriptionRequest,
options?: CallOptions,
): Promise<Subscription>
Get schedule subscription.
Parameters
- req: GetSubscriptionRequest
- Optionaloptions: CallOptions
Returns Promise<Subscription>
- Defined in client.ts:426

listDashboards

listDashboards(
req: ListDashboardsRequest,
options?: CallOptions,
): Promise<ListDashboardsResponse>
List dashboards.

Requires the Databricks SQL access entitlement.
Parameters
- req: ListDashboardsRequest
- Optionaloptions: CallOptions
Returns Promise<ListDashboardsResponse>
- Defined in client.ts:459

listDashboardsIter

listDashboardsIter(
req: ListDashboardsRequest,
options?: CallOptions,
): AsyncGenerator<Dashboard>
Parameters
- req: ListDashboardsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Dashboard>
- Defined in client.ts:502

listSchedules

listSchedules(
req: ListSchedulesRequest,
options?: CallOptions,
): Promise<ListSchedulesResponse>
List dashboard schedules.
Parameters
- req: ListSchedulesRequest
- Optionaloptions: CallOptions
Returns Promise<ListSchedulesResponse>
- Defined in client.ts:520

listSchedulesIter

listSchedulesIter(
req: ListSchedulesRequest,
options?: CallOptions,
): AsyncGenerator<Schedule>
Parameters
- req: ListSchedulesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Schedule>
- Defined in client.ts:557

listSubscriptions

listSubscriptions(
req: ListSubscriptionsRequest,
options?: CallOptions,
): Promise<ListSubscriptionsResponse>
List schedule subscriptions.
Parameters
- req: ListSubscriptionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListSubscriptionsResponse>
- Defined in client.ts:575

listSubscriptionsIter

listSubscriptionsIter(
req: ListSubscriptionsRequest,
options?: CallOptions,
): AsyncGenerator<Subscription>
Parameters
- req: ListSubscriptionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Subscription>
- Defined in client.ts:612

migrateDashboard

migrateDashboard(
req: MigrateDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Deprecated: Legacy dashboard migration is no longer supported. Use Lakeview (AI/BI) dashboards instead.
Parameters
- req: MigrateDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:633

publishDashboard

publishDashboard(
req: PublishDashboardRequest,
options?: CallOptions,
): Promise<PublishedDashboard>
Publish the current draft dashboard.

Requires the Databricks SQL access entitlement.
Parameters
- req: PublishDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<PublishedDashboard>
- Defined in client.ts:667

revertDashboard

revertDashboard(
req: RevertDashboardRequest,
options?: CallOptions,
): Promise<RevertDashboardResponse>
Revert a dashboard's definition in draft mode to the last published version.

Requires the Databricks SQL access entitlement.
Parameters
- req: RevertDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<RevertDashboardResponse>
- Defined in client.ts:701

trashDashboard

trashDashboard(
req: TrashDashboardRequest,
options?: CallOptions,
): Promise<TrashDashboardResponse>
Trash a dashboard.

Requires the Databricks SQL access entitlement.
Parameters
- req: TrashDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<TrashDashboardResponse>
- Defined in client.ts:735

unpublishDashboard

unpublishDashboard(
req: UnpublishDashboardRequest,
options?: CallOptions,
): Promise<UnpublishDashboardResponse>
Unpublish the dashboard.

Requires the Databricks SQL access entitlement.
Parameters
- req: UnpublishDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<UnpublishDashboardResponse>
- Defined in client.ts:768

updateDashboard

updateDashboard(
req: UpdateDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Update a draft dashboard.

Requires the Databricks SQL access entitlement.
Parameters
- req: UpdateDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:801

updateSchedule

updateSchedule(
req: UpdateScheduleRequest,
options?: CallOptions,
): Promise<Schedule>
Update dashboard schedule.
Parameters
- req: UpdateScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<Schedule>
- Defined in client.ts:846

Class LakeviewClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LakeviewClient

Methods

createDashboard

Parameters

Returns Promise<Dashboard>

createSchedule

Parameters

Returns Promise<Schedule>

createSubscription

Parameters

Returns Promise<Subscription>

deleteSchedule

Parameters

Returns Promise<void>

deleteSubscription

Parameters

Returns Promise<void>

getDashboard

Parameters

Returns Promise<Dashboard>

getPublishedDashboard

Parameters

Returns Promise<PublishedDashboard>

getPublishedDashboardTokenInfo

Parameters

Returns Promise<GetPublishedDashboardTokenInfoResponse>

getSchedule

Parameters

Returns Promise<Schedule>

getSubscription

Parameters

Returns Promise<Subscription>

listDashboards

Parameters

Returns Promise<ListDashboardsResponse>

listDashboardsIter

Parameters

Returns AsyncGenerator<Dashboard>

listSchedules

Parameters

Returns Promise<ListSchedulesResponse>

listSchedulesIter

Parameters

Returns AsyncGenerator<Schedule>

listSubscriptions

Parameters

Returns Promise<ListSubscriptionsResponse>

listSubscriptionsIter

Parameters

Returns AsyncGenerator<Subscription>

migrateDashboard

Parameters

Returns Promise<Dashboard>

publishDashboard

Parameters

Returns Promise<PublishedDashboard>

revertDashboard

Parameters

Returns Promise<RevertDashboardResponse>

trashDashboard

Parameters

Returns Promise<TrashDashboardResponse>

unpublishDashboard

Parameters

Returns Promise<UnpublishDashboardResponse>

updateDashboard

Parameters

Returns Promise<Dashboard>

updateSchedule

Parameters

Returns Promise<Schedule>

Settings

On This Page