query_visualizations_legacy

Creates, updates, deletes, gets or lists a query_visualizations_legacy resource.

Overview

Name	query_visualizations_legacy
Type	Resource
Id	databricks_workspace.sql.query_visualizations_legacy

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
update	insert	id, deployment_name		Updates visualization in the query.
create	insert	deployment_name, options, query_id, type		Creates visualization in the query.
delete	delete	id, deployment_name		Removes a visualization from the query.

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
id	string	Widget ID returned by :method:queryvisualizations/create

INSERT examples

update

Updates visualization in the query.

INSERT INTO databricks_workspace.sql.query_visualizations_legacy (
created_at,
description,
name,
options,
query,
type,
updated_at,
id,
deployment_name
)
SELECT 
'{{ created_at }}',
'{{ description }}',
'{{ name }}',
'{{ options }}',
'{{ query }}',
'{{ type }}',
'{{ updated_at }}',
'{{ id }}',
'{{ deployment_name }}'
RETURNING
id,
name,
created_at,
description,
options,
query,
type,
updated_at
;

create

Creates visualization in the query.

INSERT INTO databricks_workspace.sql.query_visualizations_legacy (
options,
query_id,
type,
description,
name,
deployment_name
)
SELECT 
'{{ options }}' /* required */,
'{{ query_id }}' /* required */,
'{{ type }}' /* required */,
'{{ description }}',
'{{ name }}',
'{{ deployment_name }}'
RETURNING
id,
name,
created_at,
description,
options,
query,
type,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: query_visualizations_legacy
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the query_visualizations_legacy resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the query_visualizations_legacy resource.
  - name: created_at
    value: "{{ created_at }}"
    description: |
      :param description: str (optional) A short description of this visualization. This is not displayed in the UI.
  - name: description
    value: "{{ description }}"
    description: |
      A short description of this visualization. This is not displayed in the UI.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the visualization that appears on dashboards and the query screen.
  - name: options
    value: "{{ options }}"
    description: |
      The options object varies widely from one visualization type to the next and is unsupported. Databricks does not recommend modifying visualization settings in JSON.
  - name: query
    description: |
      :param type: str (optional) The type of visualization: chart, table, pivot table, and so on.
    value:
      can_edit: {{ can_edit }}
      created_at: "{{ created_at }}"
      data_source_id: "{{ data_source_id }}"
      description: "{{ description }}"
      id: "{{ id }}"
      is_archived: {{ is_archived }}
      is_draft: {{ is_draft }}
      is_favorite: {{ is_favorite }}
      is_safe: {{ is_safe }}
      last_modified_by:
        email: "{{ email }}"
        id: {{ id }}
        name: "{{ name }}"
      last_modified_by_id: {{ last_modified_by_id }}
      latest_query_data_id: "{{ latest_query_data_id }}"
      name: "{{ name }}"
      options:
        catalog: "{{ catalog }}"
        moved_to_trash_at: "{{ moved_to_trash_at }}"
        parameters:
          - enumOptions: "{{ enumOptions }}"
            multiValuesOptions:
              prefix: "{{ prefix }}"
              separator: "{{ separator }}"
              suffix: "{{ suffix }}"
            name: "{{ name }}"
            queryId: "{{ queryId }}"
            title: "{{ title }}"
            type: "{{ type }}"
            value: "{{ value }}"
        schema: "{{ schema }}"
      parent: "{{ parent }}"
      permission_tier: "{{ permission_tier }}"
      query: "{{ query }}"
      query_hash: "{{ query_hash }}"
      run_as_role: "{{ run_as_role }}"
      tags:
        - "{{ tags }}"
      updated_at: "{{ updated_at }}"
      user:
        email: "{{ email }}"
        id: {{ id }}
        name: "{{ name }}"
      user_id: {{ user_id }}
      visualizations:
        - created_at: "{{ created_at }}"
          description: "{{ description }}"
          id: "{{ id }}"
          name: "{{ name }}"
          options: "{{ options }}"
          query:
            can_edit: {{ can_edit }}
            created_at: "{{ created_at }}"
            data_source_id: "{{ data_source_id }}"
            description: "{{ description }}"
            id: "{{ id }}"
            is_archived: {{ is_archived }}
            is_draft: {{ is_draft }}
            is_favorite: {{ is_favorite }}
            is_safe: {{ is_safe }}
            last_modified_by:
              email: "{{ email }}"
              id: {{ id }}
              name: "{{ name }}"
            last_modified_by_id: {{ last_modified_by_id }}
            latest_query_data_id: "{{ latest_query_data_id }}"
            name: "{{ name }}"
            options:
              catalog: "{{ catalog }}"
              moved_to_trash_at: "{{ moved_to_trash_at }}"
              parameters:
                - enumOptions: "{{ enumOptions }}"
                  multiValuesOptions:
                    prefix: "{{ prefix }}"
                    separator: "{{ separator }}"
                    suffix: "{{ suffix }}"
                  name: "{{ name }}"
                  queryId: "{{ queryId }}"
                  title: "{{ title }}"
                  type: "{{ type }}"
                  value: "{{ value }}"
              schema: "{{ schema }}"
            parent: "{{ parent }}"
            permission_tier: "{{ permission_tier }}"
            query: "{{ query }}"
            query_hash: "{{ query_hash }}"
            run_as_role: "{{ run_as_role }}"
            tags:
              - "{{ tags }}"
            updated_at: "{{ updated_at }}"
            user:
              email: "{{ email }}"
              id: {{ id }}
              name: "{{ name }}"
            user_id: {{ user_id }}
            visualizations:
              - created_at: "{{ created_at }}"
                description: "{{ description }}"
                id: "{{ id }}"
                name: "{{ name }}"
                options: "{{ options }}"
                query:
                  can_edit: {{ can_edit }}
                  created_at: "{{ created_at }}"
                  data_source_id: "{{ data_source_id }}"
                  description: "{{ description }}"
                  id: "{{ id }}"
                  is_archived: {{ is_archived }}
                  is_draft: {{ is_draft }}
                  is_favorite: {{ is_favorite }}
                  is_safe: {{ is_safe }}
                  last_modified_by: "{{ last_modified_by }}"
                  last_modified_by_id: {{ last_modified_by_id }}
                  latest_query_data_id: "{{ latest_query_data_id }}"
                  name: "{{ name }}"
                  options: "{{ options }}"
                  parent: "{{ parent }}"
                  permission_tier: "{{ permission_tier }}"
                  query: "{{ query }}"
                  query_hash: "{{ query_hash }}"
                  run_as_role: "{{ run_as_role }}"
                  tags: "{{ tags }}"
                  updated_at: "{{ updated_at }}"
                  user: "{{ user }}"
                  user_id: {{ user_id }}
                  visualizations: "{{ visualizations }}"
                type: "{{ type }}"
                updated_at: "{{ updated_at }}"
          type: "{{ type }}"
          updated_at: "{{ updated_at }}"
  - name: type
    value: "{{ type }}"
    description: |
      The type of visualization: chart, table, pivot table, and so on.
  - name: updated_at
    value: "{{ updated_at }}"
    description: |
      :returns: :class:`LegacyVisualization`
  - name: query_id
    value: "{{ query_id }}"
    description: |
      The identifier returned by :method:queries/create

DELETE examples

delete

Removes a visualization from the query.

DELETE FROM databricks_workspace.sql.query_visualizations_legacy
WHERE id = '{{ id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;