w.query_visualizations_legacy: Query Visualizations (legacy)

class databricks.sdk.service.sql.QueryVisualizationsLegacyAPI

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.

Note: A new version of the Databricks SQL API is now available. Please see the latest version. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

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

Add visualization to a query.

Creates visualization in the query.

Note: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/create instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

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:

LegacyVisualization

delete(id: str)

Remove visualization.

Removes a visualization from the query.

Note: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/delete instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

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[LegacyQuery], type: Optional[str], updated_at: Optional[str]]) → LegacyVisualization

Edit existing visualization.

Updates visualization in the query.

Note: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/update instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

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 – LegacyQuery (optional)

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

  • updated_at – str (optional)

Returns:

LegacyVisualization