w.query_visualizations: Query Visualizations

class databricks.sdk.service.sql.QueryVisualizationsAPI

This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace. Data structures may change over time.

create(query_id: str, type: str, options: Any [, description: Optional[str], name: Optional[str]]) → Visualization

Add visualization to a query.

Parameters:

  • query_id – str The identifier returned by :method:queries/create

  • type – str The type of visualization: chart, table, pivot table, and so on.

  • options – Any The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.

  • description – str (optional) A short description of this visualization. This is not displayed in the UI.

  • name – str (optional) The name of the visualization that appears on dashboards and the query screen.

Returns:

Visualization

delete(id: str)

Remove visualization.

Parameters:

id – str Widget ID returned by :method:queryvizualisations/create

update(id: str [, created_at: Optional[str], description: Optional[str], name: Optional[str], options: Optional[Any], query: Optional[Query], type: Optional[str], updated_at: Optional[str]]) → Visualization

Edit existing visualization.

Parameters:

  • id – str The UUID for this visualization.

  • created_at – str (optional)

  • description – str (optional) A short description of this visualization. This is not displayed in the UI.

  • name – str (optional) The name of the visualization that appears on dashboards and the query screen.

  • options – Any (optional) The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.

  • query – Query (optional)

  • type – str (optional) The type of visualization: chart, table, pivot table, and so on.

  • updated_at – str (optional)

Returns:

Visualization