Databricks v1.14.0, May 23 23

databricks.getSqlWarehouse

Explore with Pulumi AI

Note If you have a fully automated setup with workspaces created by databricks_mws_workspaces, please make sure to add depends_on attribute in order to prevent default auth: cannot configure default credentials errors.

Retrieves information about a databricks.getSqlWarehouse using its id. This could be retrieved programmatically using databricks.getSqlWarehouses data source.

The following resources are often used in the same context:

End to end workspace management guide.
databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
databricks.SqlDashboard to manage Databricks SQL Dashboards.
databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and data access properties for all databricks.getSqlWarehouse of workspace.
databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.

Example Usage

Retrieve attributes of each SQL warehouses in a workspace

Coming soon!

import pulumi
import pulumi_databricks as databricks

all_sql_warehouses = databricks.get_sql_warehouses()
all_sql_warehouse = [databricks.get_sql_warehouse(id=__value) for __key, __value in data["databricks_sql"]["warehouses"]["ids"]]

import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const allSqlWarehouses = databricks.getSqlWarehouses({});
const allSqlWarehouse = .map(([, ]) => (databricks.getSqlWarehouse({
    id: __value,
})));

Coming soon!

Using getSqlWarehouse

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSqlWarehouse(args: GetSqlWarehouseArgs, opts?: InvokeOptions): Promise<GetSqlWarehouseResult>
function getSqlWarehouseOutput(args: GetSqlWarehouseOutputArgs, opts?: InvokeOptions): Output<GetSqlWarehouseResult>

def get_sql_warehouse(auto_stop_mins: Optional[int] = None,
                      channel: Optional[GetSqlWarehouseChannel] = None,
                      cluster_size: Optional[str] = None,
                      data_source_id: Optional[str] = None,
                      enable_photon: Optional[bool] = None,
                      enable_serverless_compute: Optional[bool] = None,
                      id: Optional[str] = None,
                      instance_profile_arn: Optional[str] = None,
                      jdbc_url: Optional[str] = None,
                      max_num_clusters: Optional[int] = None,
                      min_num_clusters: Optional[int] = None,
                      name: Optional[str] = None,
                      num_clusters: Optional[int] = None,
                      odbc_params: Optional[GetSqlWarehouseOdbcParams] = None,
                      spot_instance_policy: Optional[str] = None,
                      state: Optional[str] = None,
                      tags: Optional[GetSqlWarehouseTags] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSqlWarehouseResult
def get_sql_warehouse_output(auto_stop_mins: Optional[pulumi.Input[int]] = None,
                      channel: Optional[pulumi.Input[GetSqlWarehouseChannelArgs]] = None,
                      cluster_size: Optional[pulumi.Input[str]] = None,
                      data_source_id: Optional[pulumi.Input[str]] = None,
                      enable_photon: Optional[pulumi.Input[bool]] = None,
                      enable_serverless_compute: Optional[pulumi.Input[bool]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      instance_profile_arn: Optional[pulumi.Input[str]] = None,
                      jdbc_url: Optional[pulumi.Input[str]] = None,
                      max_num_clusters: Optional[pulumi.Input[int]] = None,
                      min_num_clusters: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      num_clusters: Optional[pulumi.Input[int]] = None,
                      odbc_params: Optional[pulumi.Input[GetSqlWarehouseOdbcParamsArgs]] = None,
                      spot_instance_policy: Optional[pulumi.Input[str]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[GetSqlWarehouseTagsArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSqlWarehouseResult]

func GetSqlWarehouse(ctx *Context, args *GetSqlWarehouseArgs, opts ...InvokeOption) (*GetSqlWarehouseResult, error)
func GetSqlWarehouseOutput(ctx *Context, args *GetSqlWarehouseOutputArgs, opts ...InvokeOption) GetSqlWarehouseResultOutput

> Note: This function is named GetSqlWarehouse in the Go SDK.

public static class GetSqlWarehouse 
{
    public static Task<GetSqlWarehouseResult> InvokeAsync(GetSqlWarehouseArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlWarehouseResult> Invoke(GetSqlWarehouseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSqlWarehouseResult> getSqlWarehouse(GetSqlWarehouseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: databricks:index/getSqlWarehouse:getSqlWarehouse
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The ID of the SQL warehouse
AutoStopMins int: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
Channel GetSqlWarehouseChannel: block, consisting of following fields:
ClusterSize string: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
DataSourceId string: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
EnablePhoton bool: Whether to enable Photon.
EnableServerlessCompute bool: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
InstanceProfileArn string
JdbcUrl string: JDBC connection string.
MaxNumClusters int: Maximum number of clusters available when a SQL warehouse is running.
MinNumClusters int: Minimum number of clusters available when a SQL warehouse is running.
Name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
NumClusters int
OdbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
SpotInstancePolicy string: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
State string
Tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

Id string: The ID of the SQL warehouse
AutoStopMins int: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
Channel GetSqlWarehouseChannel: block, consisting of following fields:
ClusterSize string: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
DataSourceId string: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
EnablePhoton bool: Whether to enable Photon.
EnableServerlessCompute bool: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
InstanceProfileArn string
JdbcUrl string: JDBC connection string.
MaxNumClusters int: Maximum number of clusters available when a SQL warehouse is running.
MinNumClusters int: Minimum number of clusters available when a SQL warehouse is running.
Name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
NumClusters int
OdbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
SpotInstancePolicy string: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
State string
Tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

id String: The ID of the SQL warehouse
autoStopMins Integer: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel GetSqlWarehouseChannel: block, consisting of following fields:
clusterSize String: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
dataSourceId String: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enablePhoton Boolean: Whether to enable Photon.
enableServerlessCompute Boolean: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
instanceProfileArn String
jdbcUrl String: JDBC connection string.
maxNumClusters Integer: Maximum number of clusters available when a SQL warehouse is running.
minNumClusters Integer: Minimum number of clusters available when a SQL warehouse is running.
name String: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
numClusters Integer
odbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spotInstancePolicy String: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state String
tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

id string: The ID of the SQL warehouse
autoStopMins number: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel GetSqlWarehouseChannel: block, consisting of following fields:
clusterSize string: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
dataSourceId string: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enablePhoton boolean: Whether to enable Photon.
enableServerlessCompute boolean: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
instanceProfileArn string
jdbcUrl string: JDBC connection string.
maxNumClusters number: Maximum number of clusters available when a SQL warehouse is running.
minNumClusters number: Minimum number of clusters available when a SQL warehouse is running.
name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
numClusters number
odbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spotInstancePolicy string: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state string
tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

id str: The ID of the SQL warehouse
auto_stop_mins int: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel GetSqlWarehouseChannel: block, consisting of following fields:
cluster_size str: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
data_source_id str: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enable_photon bool: Whether to enable Photon.
enable_serverless_compute bool: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
instance_profile_arn str
jdbc_url str: JDBC connection string.
max_num_clusters int: Maximum number of clusters available when a SQL warehouse is running.
min_num_clusters int: Minimum number of clusters available when a SQL warehouse is running.
name str: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
num_clusters int
odbc_params GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spot_instance_policy str: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state str
tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

id String: The ID of the SQL warehouse
autoStopMins Number: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel Property Map: block, consisting of following fields:
clusterSize String: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
dataSourceId String: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enablePhoton Boolean: Whether to enable Photon.
enableServerlessCompute Boolean: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
instanceProfileArn String
jdbcUrl String: JDBC connection string.
maxNumClusters Number: Maximum number of clusters available when a SQL warehouse is running.
minNumClusters Number: Minimum number of clusters available when a SQL warehouse is running.
name String: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
numClusters Number
odbcParams Property Map: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spotInstancePolicy String: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state String
tags Property Map: Databricks tags all warehouse resources with these tags.

getSqlWarehouse Result

The following output properties are available:

AutoStopMins int: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
Channel GetSqlWarehouseChannel: block, consisting of following fields:
ClusterSize string: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
DataSourceId string: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
EnablePhoton bool: Whether to enable Photon.
EnableServerlessCompute bool: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
Id string
InstanceProfileArn string
JdbcUrl string: JDBC connection string.
MaxNumClusters int: Maximum number of clusters available when a SQL warehouse is running.
MinNumClusters int: Minimum number of clusters available when a SQL warehouse is running.
Name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
NumClusters int
OdbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
SpotInstancePolicy string: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
State string
Tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

AutoStopMins int: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
Channel GetSqlWarehouseChannel: block, consisting of following fields:
ClusterSize string: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
DataSourceId string: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
EnablePhoton bool: Whether to enable Photon.
EnableServerlessCompute bool: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
Id string
InstanceProfileArn string
JdbcUrl string: JDBC connection string.
MaxNumClusters int: Maximum number of clusters available when a SQL warehouse is running.
MinNumClusters int: Minimum number of clusters available when a SQL warehouse is running.
Name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
NumClusters int
OdbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
SpotInstancePolicy string: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
State string
Tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

autoStopMins Integer: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel GetSqlWarehouseChannel: block, consisting of following fields:
clusterSize String: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
dataSourceId String: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enablePhoton Boolean: Whether to enable Photon.
enableServerlessCompute Boolean: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
id String
instanceProfileArn String
jdbcUrl String: JDBC connection string.
maxNumClusters Integer: Maximum number of clusters available when a SQL warehouse is running.
minNumClusters Integer: Minimum number of clusters available when a SQL warehouse is running.
name String: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
numClusters Integer
odbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spotInstancePolicy String: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state String
tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

autoStopMins number: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel GetSqlWarehouseChannel: block, consisting of following fields:
clusterSize string: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
dataSourceId string: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enablePhoton boolean: Whether to enable Photon.
enableServerlessCompute boolean: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
id string
instanceProfileArn string
jdbcUrl string: JDBC connection string.
maxNumClusters number: Maximum number of clusters available when a SQL warehouse is running.
minNumClusters number: Minimum number of clusters available when a SQL warehouse is running.
name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
numClusters number
odbcParams GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spotInstancePolicy string: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state string
tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

auto_stop_mins int: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel GetSqlWarehouseChannel: block, consisting of following fields:
cluster_size str: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
data_source_id str: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enable_photon bool: Whether to enable Photon.
enable_serverless_compute bool: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
id str
instance_profile_arn str
jdbc_url str: JDBC connection string.
max_num_clusters int: Maximum number of clusters available when a SQL warehouse is running.
min_num_clusters int: Minimum number of clusters available when a SQL warehouse is running.
name str: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
num_clusters int
odbc_params GetSqlWarehouseOdbcParams: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spot_instance_policy str: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state str
tags GetSqlWarehouseTags: Databricks tags all warehouse resources with these tags.

autoStopMins Number: Time in minutes until an idle SQL warehouse terminates all clusters and stops.
channel Property Map: block, consisting of following fields:
clusterSize String: The size of the clusters allocated to the warehouse: "2X-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "2X-Large", "3X-Large", "4X-Large".
dataSourceId String: ID of the data source for this warehouse. This is used to bind an Databricks SQL query to an warehouse.
enablePhoton Boolean: Whether to enable Photon.
enableServerlessCompute Boolean: Whether this SQL warehouse is a serverless SQL warehouse. If this value is true, warehouse_type must be PRO.
id String
instanceProfileArn String
jdbcUrl String: JDBC connection string.
maxNumClusters Number: Maximum number of clusters available when a SQL warehouse is running.
minNumClusters Number: Minimum number of clusters available when a SQL warehouse is running.
name String: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.
numClusters Number
odbcParams Property Map: ODBC connection params: odbc_params.hostname, odbc_params.path, odbc_params.protocol, and odbc_params.port.
spotInstancePolicy String: The spot policy to use for allocating instances to clusters: COST_OPTIMIZED or RELIABILITY_OPTIMIZED.
state String
tags Property Map: Databricks tags all warehouse resources with these tags.

Supporting Types

GetSqlWarehouseChannel

Name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.

Name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.

name String: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.

name string: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.

name str: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.

name String: Name of the Databricks SQL release channel. Possible values are: CHANNEL_NAME_PREVIEW and CHANNEL_NAME_CURRENT. Default is CHANNEL_NAME_CURRENT.