Skip to content

Dashboard

`laktory.models.resources.databricks.Dashboard` ¤

Bases: DashboardBase

Databricks Lakeview Dashboard

Examples:

import io

from laktory import models

dashboard_yaml = '''
display_name: databricks-costs
file_path: ./dashboards/databricks_costs.json
parent_path: /.laktory/dashboards
warehouse_id: a7d9f2kl8mp3q6rt
access_controls:
- group_name: account users
  permission_level: CAN_VIEW
- group_name: role-engineers
  permission_level: CAN_RUN
'''
dashboard = models.resources.databricks.Dashboard.model_validate_yaml(
    io.StringIO(dashboard_yaml)
)

References

Databricks Lakeview Dashboard

BASE	DESCRIPTION
`create_time`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`dashboard_change_detected`	TYPE: `bool \| None \| VariableType` DEFAULT: `None`
`dashboard_id`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`dataset_catalog`	Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips) TYPE: `str \| None \| VariableType` DEFAULT: `None`
`dataset_schema`	Sets the default schema for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips) TYPE: `str \| None \| VariableType` DEFAULT: `None`
`display_name`	The display name of the dashboard TYPE: `str \| VariableType`
`embed_credentials`	Whether to embed credentials in the dashboard. Default is `true` TYPE: `bool \| None \| VariableType` DEFAULT: `None`
`etag`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`file_path`	The path to the dashboard JSON file. Conflicts with `serialized_dashboard` TYPE: `str \| None \| VariableType` DEFAULT: `None`
`lifecycle_state`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`md5`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`path`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`serialized_dashboard`	The contents of the dashboard in serialized string form. Conflicts with `file_path` TYPE: `str \| None \| VariableType` DEFAULT: `None`
`update_time`	TYPE: `str \| None \| VariableType` DEFAULT: `None`
`warehouse_id`	The warehouse ID used to run the dashboard TYPE: `str \| VariableType`

LAKTORY	DESCRIPTION
`access_controls`	Access controls list TYPE: `list[AccessControl \| VariableType] \| VariableType` DEFAULT: `[]`
`name_prefix`	Prefix added to the dashboard display name TYPE: `str \| VariableType` DEFAULT: `None`
`name_suffix`	Suffix added to the dashboard display name TYPE: `str \| VariableType` DEFAULT: `None`
`parent_path_`	The path to a workspace folder (inside laktory root) containing the dashboard. If changed, the query will be recreated. TYPE: `str \| None \| VariableType` DEFAULT: `None`

ATTRIBUTE	DESCRIPTION
`additional_core_resources`	permissions TYPE: `list`

`additional_core_resources` `property` ¤

permissions