lakeview_published
Creates, updates, deletes, gets or lists a lakeview_published resource.
Overview
| Name | lakeview_published |
| Type | Resource |
| Id | databricks_workspace.dashboards.lakeview_published |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
warehouse_id | string | The warehouse ID used to run the published dashboard. |
display_name | string | |
embed_credentials | boolean | Indicates whether credentials are embedded in the published dashboard. |
revision_create_time | string | The timestamp of when the published dashboard was last revised. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | dashboard_id, deployment_name | Get the current published dashboard. | |
publish | exec | dashboard_id, deployment_name | Publish the current draft dashboard. | |
unpublish | exec | dashboard_id, deployment_name | Unpublish the dashboard. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
dashboard_id | string | UUID identifying the published dashboard. |
deployment_name | string | The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc) |
SELECT examples
- get
Get the current published dashboard.
SELECT
warehouse_id,
display_name,
embed_credentials,
revision_create_time
FROM databricks_workspace.dashboards.lakeview_published
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;
Lifecycle Methods
- publish
- unpublish
Publish the current draft dashboard.
EXEC databricks_workspace.dashboards.lakeview_published.publish
@dashboard_id='{{ dashboard_id }}' --required,
@deployment_name='{{ deployment_name }}' --required
@@json=
'{
"embed_credentials": {{ embed_credentials }},
"warehouse_id": "{{ warehouse_id }}"
}'
;
Unpublish the dashboard.
EXEC databricks_workspace.dashboards.lakeview_published.unpublish
@dashboard_id='{{ dashboard_id }}' --required,
@deployment_name='{{ deployment_name }}' --required
;