sql_visualization.md

subcategory
Databricks SQL

databricks_sql_visualization Resource

To manage SQLA resources you must have databricks_sql_access on your databricks_group or databricks_user.

Note: documentation for this resource is a work in progress.

A visualization is always tied to a query. Every query may have one or more visualizations.

Example Usage

resource "databricks_sql_visualization" "q1v1" {
  query_id    = databricks_sql_query.q1.id
  type        = "table"
  name        = "My Table"
  description = "Some Description"

  // The options encoded in this field are passed verbatim to the SQLA API.
  options = jsonencode(
    {
      "itemsPerPage" : 25,
      "columns" : [
        {
          "name" : "p1",
          "type" : "string"
          "title" : "Parameter 1",
          "displayAs" : "string",
        },
        {
          "name" : "p2",
          "type" : "string"
          "title" : "Parameter 2",
          "displayAs" : "link",
          "highlightLinks" : true,
        }
      ]
    }
  )
}

Import

You can import a databricks_sql_visualization resource with ID like the following:

$ terraform import databricks_sql_visualization.this <query-id>/<visualization-id>

Related Resources

The following resources are often used in the same context:

• End to end workspace management guide.
• databricks_sql_dashboard to manage Databricks SQL Dashboards.
• databricks_sql_endpoint to manage Databricks SQL Endpoints.
• databricks_sql_global_config to configure the security policy, databricks_instance_profile, and data access properties for all databricks_sql_endpoint of workspace.
• databricks_sql_permissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.