sql_widget.md

subcategory
Databricks SQL

databricks_sql_widget Resource

-> Note: Please switch to databricks_dashboard to author new AI/BI dashboards using the latest tooling

To manage SQL 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 widget is always tied to a Legacy dashboard. Every dashboard may have one or more widgets.

Example Usage

resource "databricks_sql_widget" "d1w1" {
  dashboard_id = databricks_sql_dashboard.d1.id
  text         = "Hello! I'm a **text widget**!"

  position {
    size_x = 3
    size_y = 4
    pos_x  = 0
    pos_y  = 0
  }
}

resource "databricks_sql_widget" "d1w2" {
  dashboard_id     = databricks_sql_dashboard.d1.id
  visualization_id = databricks_sql_visualization.q1v1.id

  position {
    size_x = 3
    size_y = 4
    pos_x  = 3
    pos_y  = 0
  }
}

Import

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

terraform import databricks_sql_widget.this <dashboard-id>/<widget-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.