Databricks SDK for JavaScript
    Preparing search index...

    Interface QueryInfo

    interface QueryInfo {
        cacheQueryId?: string;
        channelUsed?: ChannelInfo;
        clientApplication?: string;
        duration?: bigint;
        endpointId?: string;
        errorMessage?: string;
        executedAsUserId?: bigint;
        executedAsUserName?: string;
        executionEndTimeMs?: bigint;
        isFinal?: boolean;
        lookupKey?: string;
        metrics?: QueryMetrics;
        plansState?: PlansState;
        queryEndTimeMs?: bigint;
        queryId?: string;
        querySource?: ExternalQuerySource;
        queryStartTimeMs?: bigint;
        queryTags?: QueryTag[];
        queryText?: string;
        rowsProduced?: bigint;
        sessionId?: string;
        sparkUiUrl?: string;
        statementType?: QueryStatementType;
        status?: QueryStatus;
        userId?: bigint;
        userName?: string;
        warehouseId?: string;
    }
    Index

    Properties

    cacheQueryId? channelUsed? clientApplication? duration? endpointId? errorMessage? executedAsUserId? executedAsUserName? executionEndTimeMs? isFinal? lookupKey? metrics? plansState? queryEndTimeMs? queryId? querySource? queryStartTimeMs? queryTags? queryText? rowsProduced? sessionId? sparkUiUrl? statementType? status? userId? userName? warehouseId?

    Properties

    cacheQueryId?: string

    The ID of the cached query if this result retrieved from cache

    channelUsed?: ChannelInfo

    SQL Warehouse channel information at the time of query execution

    clientApplication?: string

    Client application that ran the statement. For example: Databricks SQL Editor, Tableau, and Power BI. This field is derived from information provided by client applications. While values are expected to remain static over time, this cannot be guaranteed.

    duration?: bigint

    Total time of the statement execution. This value does not include the time taken to retrieve the results, which can result in a discrepancy between this value and the start-to-finish wall-clock time.

    endpointId?: string

    Alias for warehouse_id.

    errorMessage?: string

    Message describing why the query could not complete.

    executedAsUserId?: bigint

    The ID of the user whose credentials were used to run the query.

    executedAsUserName?: string

    The email address or username of the user whose credentials were used to run the query.

    executionEndTimeMs?: bigint

    The time execution of the query ended.

    isFinal?: boolean

    Whether more updates for the query are expected.

    lookupKey?: string

    A key that can be used to look up query details.

    metrics?: QueryMetrics

    Metrics about query execution.

    plansState?: PlansState

    Whether plans exist for the execution, or the reason why they are missing

    queryEndTimeMs?: bigint

    The time the query ended.

    queryId?: string

    The query ID.

    querySource?: ExternalQuerySource

    A struct that contains key-value pairs representing entities that were involved in the execution of this statement, such as jobs, notebooks, or dashboards. This field only records entities.

    queryStartTimeMs?: bigint

    The time the query started.

    queryTags?: QueryTag[]

    A query execution can be optionally annotated with query tags

    queryText?: string

    The text of the query.

    rowsProduced?: bigint

    The number of results returned by the query.

    sessionId?: string

    The spark session UUID that query ran on. This is either the Spark Connect, DBSQL, or SDP session ID.

    sparkUiUrl?: string

    URL to the Spark UI query plan.

    statementType?: QueryStatementType

    Type of statement for this query

    status?: QueryStatus

    Query status with one the following values:

    • QUEUED: Query has been received and queued.
    • RUNNING: Query has started.
    • CANCELED: Query has been cancelled by the user.
    • FAILED: Query has failed.
    • FINISHED: Query has completed.
    userId?: bigint

    The ID of the user who ran the query.

    userName?: string

    The email address or username of the user who ran the query.

    warehouseId?: string

    Warehouse ID.

    Settings

    Member Visibility

    On This Page

    Properties