subcategory |
---|
Databricks SQL |
This resource is used to manage Databricks SQL Endpoints. To create SQL endpoints you must have databricks_sql_access
on your databricks_group or databricks_user.
data "databricks_current_user" "me" {}
resource "databricks_sql_endpoint" "this" {
name = "Endpoint of ${data.databricks_current_user.me.alphanumeric}"
cluster_size = "Small"
max_num_clusters = 1
tags {
custom_tags {
key = "City"
value = "Amsterdam"
}
}
}
The following arguments are supported:
name
- (Required) Name of the SQL endpoint. Must be unique.cluster_size
- (Required) The size of the clusters allocated to the endpoint: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".min_num_clusters
- Minimum number of clusters available when a SQL endpoint is running. The default is1
.max_num_clusters
- Maximum number of clusters available when a SQL endpoint is running. This field is required. If multi-cluster load balancing is not enabled, this is default to1
.auto_stop_mins
- Time in minutes until an idle SQL endpoint terminates all clusters and stops. This field is optional. The default is 0, which means auto stop is disabled.instance_profile_arn
- databricks_instance_profile used to access storage from the SQL endpoint. This field is optional.tags
- Databricks tags all endpoint resources with these tags.spot_instance_policy
- The spot policy to use for allocating instances to clusters:COST_OPTIMIZED
orRELIABILITY_OPTIMIZED
. This field is optional. Default isCOST_OPTIMIZED
.enable_photon
- Whether to enable Photon. This field is optional and is enabled by default.
In addition to all arguments above, the following attributes are exported:
jdbc_url
- JDBC connection string.odbc_params
- ODBC connection params:odbc_params.hostname
,odbc_params.path
,odbc_params.protocol
, andodbc_params.port
.data_source_id
- ID of the data source for this endpoint. This is used to bind an SQLA query to an endpoint.
- databricks_permissions can control which groups or individual users can Can Use or Can Manage SQL endpoints.
databricks_sql_access
on databricks_group or databricks_user.
The timeouts
block allows you to specify create
timeouts. It usually takes 10-20 minutes to provision Databricks SQL endpoint.
timeouts {
create = "30m"
}
You can import a databricks_sql_endpoint
resource with ID like the following:
$ terraform import databricks_sql_endpoint.this <endpoint-id>
The following resources are often used in the same context:
- End to end workspace management guide.
- databricks_instance_profile to manage AWS EC2 instance profiles that users can launch databricks_cluster and access data, like databricks_mount.
- databricks_sql_dashboard to manage Databricks SQL Dashboards.
- 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.