Databricks SDK for JavaScript
    Preparing search index...

    Interface ClientOptions

    Options that configure a Databricks API client.

    interface ClientOptions {
        accountId?: string;
        credentials?: Credentials;
        host?: string;
        httpClient?: HttpClient;
        logger?: Logger;
        profileOptions?: ProfileOptions;
        timeout?: number;
        workspaceId?: string;
    }
    Index

    Properties

    accountId? credentials? host? httpClient? logger? profileOptions? timeout? workspaceId?

    Properties

    accountId?: string

    Default Databricks account ID for account-level API paths that contain an {account_id} segment. The request's own accountId field takes precedence; this option is only consulted when the request leaves it unset.

    credentials?: Credentials

    Credentials used to authenticate requests.

    host?: string

    Host for the client.

    httpClient?: HttpClient

    Base HTTP client used as the transport. Replaces the default fetch-based client (e.g. for a proxy, custom TLS, or instrumentation).

    logger?: Logger

    Logger used to record diagnostic messages.

    profileOptions?: ProfileOptions

    Controls how a configuration profile fills the options left unset above.

    Profile resolution is enabled by default: the config file (~/.databrickscfg or $DATABRICKS_CONFIG_FILE) and DATABRICKS_* environment variables supply host, accountId, workspaceId, and credentials whenever the caller does not set them explicitly. Explicit values always win. Disable the file with noProfile, the environment with disableEnv, or select a specific profile/configFile.

    timeout?: number

    Overall API call timeout, in milliseconds, applied by default to every request issued through the client.

    workspaceId?: string

    Databricks workspace ID used to route workspace-level API calls on unified hosts (SPOG). When set, workspace-level methods send the X-Databricks-Workspace-Id header on every request. Accepts either a classic numeric workspace ID or another workspace identifier format that the server understands. Ignored by clients that only expose account-level methods.

    Settings

    Member Visibility

    On This Page

    Properties