Databricks SDK for JavaScript
    Preparing search index...

    Interface EndpointInfo

    interface EndpointInfo {
        autoStopMins?: number;
        channel?: Channel;
        clusterSize?: string;
        creatorName?: string;
        enablePhoton?: boolean;
        enableServerlessCompute?: boolean;
        health?: EndpointHealth;
        id?: string;
        instanceProfileArn?: string;
        jdbcUrl?: string;
        maxNumClusters?: number;
        minNumClusters?: number;
        name?: string;
        numActiveSessions?: bigint;
        numClusters?: number;
        odbcParams?: OdbcParams;
        spotInstancePolicy?: EndpointSpotInstancePolicy;
        state?: EndpointState;
        tags?: EndpointTags;
        warehouseType?: WarehouseType;
    }
    Index

    Properties

    autoStopMins? channel? clusterSize? creatorName? enablePhoton? enableServerlessCompute? health? id? instanceProfileArn? jdbcUrl? maxNumClusters? minNumClusters? name? numActiveSessions? numClusters? odbcParams? spotInstancePolicy? state? 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
    • Auto
    creatorName?: string

    warehouse creator name

    enablePhoton?: boolean

    Configures whether the warehouse should use Photon optimized clusters.

    Defaults to true.

    enableServerlessCompute?: boolean

    Configures whether the warehouse should use serverless compute

    health?: EndpointHealth

    Optional health status. Assume the warehouse is healthy if this field is not set.

    id?: string

    unique identifier for warehouse

    instanceProfileArn?: string

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

    jdbcUrl?: string

    the jdbc connection string for this warehouse

    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.
    numActiveSessions?: bigint

    Deprecated. current number of active sessions for the warehouse

    numClusters?: number

    current number of clusters running for the service

    odbcParams?: OdbcParams

    ODBC parameters for the SQL warehouse

    spotInstancePolicy?: EndpointSpotInstancePolicy

    Configurations whether the endpoint should use spot instances.

    state?: EndpointState

    state of the endpoint

    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