Databricks SDK for JavaScript
    Preparing search index...

    Interface EditWarehouseRequest

    This is an incremental edit functionality, so all fields except id are optional. If a field is set, the corresponding configuration in the SQL warehouse is modified. If a field is unset, the existing configuration value in the SQL warehouse is retained. Thus, this API is not idempotent.

    interface EditWarehouseRequest {
        autoStopMins?: number;
        channel?: Channel;
        clusterSize?: string;
        creatorName?: string;
        customerVersionLabel?: string;
        enablePhoton?: boolean;
        enableServerlessCompute?: boolean;
        id?: string;
        instanceProfileArn?: string;
        maxDbu?: number;
        maxNumClusters?: number;
        minNumClusters?: number;
        name?: string;
        reydenClusterSizeMultiplier?: number;
        spotInstancePolicy?: EndpointSpotInstancePolicy;
        statementTimeout?: number;
        tags?: EndpointTags;
        warehouseType?: WarehouseType;
    }
    Index

    Properties

    autoStopMins? channel? clusterSize? creatorName? customerVersionLabel? enablePhoton? enableServerlessCompute? id? instanceProfileArn? maxDbu? maxNumClusters? minNumClusters? name? reydenClusterSizeMultiplier? spotInstancePolicy? statementTimeout? tags? warehouseType?

    Properties

    autoStopMins?: number

    The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries) before it is automatically stopped.

    Supported values:

    • Must be == 0 or >= 10 mins
    • 0 indicates no autostop.

    Defaults to 120 mins

    channel?: Channel

    Channel Details

    clusterSize?: string

    Size of the clusters allocated for this warehouse. Increasing the size of a spark cluster allows you to run larger queries on it. If you want to increase the number of concurrent queries, please tune max_num_clusters.

    Supported values:

    • 2X-Small
    • X-Small
    • Small
    • Medium
    • Large
    • X-Large
    • 2X-Large
    • 3X-Large
    • 4X-Large
    • 5X-Large
    creatorName?: string

    warehouse creator name

    customerVersionLabel?: string

    Compute version label for a REALTIME warehouse. This field is output only.

    enablePhoton?: boolean

    Configures whether the warehouse should use Photon optimized clusters.

    Defaults to true.

    enableServerlessCompute?: boolean

    Configures whether the warehouse should use serverless compute

    id?: string

    Required. Id of the warehouse to configure.

    instanceProfileArn?: string

    Deprecated. Instance profile used to pass IAM role to the cluster

    maxDbu?: number

    Maximum compute capacity of a real-time SQL warehouse, in DBU per hour. Must be at least the minimum DBU for the selected warehouse size and no greater than the configured DBU limit. Actual capacity may be below this ceiling.

    maxNumClusters?: number

    Maximum number of clusters that the autoscaler will create to handle concurrent queries.

    Supported values:

    • Must be >= min_num_clusters
    • Must be <= 40.

    Defaults to min_clusters if unset.

    minNumClusters?: number

    Minimum number of available clusters that will be maintained for this SQL warehouse. Increasing this will ensure that a larger number of clusters are always running and therefore may reduce the cold start time for new queries. This is similar to reserved vs. revocable cores in a resource manager.

    Supported values:

    • Must be > 0
    • Must be <= min(max_num_clusters, 30)

    Defaults to 1

    name?: string

    Logical name for the cluster.

    Supported values:

    • Must be unique within an org.
    • Must be less than 100 characters.
    reydenClusterSizeMultiplier?: number

    Cluster size multiplier for Reyden warehouses. Scales the effective compute capacity relative to the nominal virtual cluster size. Only meaningful when the warehouse is of Reyden type.

    Accepted range: 1.0 to the workspace-configured maximum (decimals allowed). The default maximum is 100.0.

    • Values below 1.0 are normalized to 1.0.
    • Values above the configured maximum are capped at that maximum.
    • When absent, the warehouse is treated as having a multiplier of 1.0.
    spotInstancePolicy?: EndpointSpotInstancePolicy

    Configurations whether the endpoint should use spot instances.

    statementTimeout?: number

    Warehouse statement timeout in seconds.

    tags?: EndpointTags

    A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated with this SQL warehouse.

    Supported values:

    • Number of tags < 45.
    warehouseType?: WarehouseType

    Warehouse type: PRO or CLASSIC. If you want to use serverless compute, you must set to PRO and also set the field enable_serverless_compute to true.

    Settings

    Member Visibility

    On This Page

    Properties