Databricks SDK for JavaScript
    Preparing search index...

    Interface QueryMetrics

    A query metric that encapsulates a set of measurements for a single query. Metrics come from the driver and are stored in the history service database.

    interface QueryMetrics {
        compilationTimeMs?: bigint;
        executionTimeMs?: bigint;
        networkSentBytes?: bigint;
        overloadingQueueStartTimestamp?: bigint;
        photonTotalTimeMs?: bigint;
        projectedRemainingTaskTotalTimeMs?: bigint;
        projectedRemainingWallclockTimeMs?: bigint;
        provisioningQueueStartTimestamp?: bigint;
        prunedBytes?: bigint;
        prunedFilesCount?: bigint;
        queryCompilationStartTimestamp?: bigint;
        readBytes?: bigint;
        readCacheBytes?: bigint;
        readFilesBytes?: bigint;
        readFilesCount?: bigint;
        readPartitionsCount?: bigint;
        readRemoteBytes?: bigint;
        remainingTaskCount?: bigint;
        resultFetchTimeMs?: bigint;
        resultFromCache?: boolean;
        rowsProducedCount?: bigint;
        rowsReadCount?: bigint;
        runnableTasks?: bigint;
        spillToDiskBytes?: bigint;
        taskTimeOverTimeRange?: TaskTimeOverRange;
        taskTotalTimeMs?: bigint;
        totalTimeMs?: bigint;
        workToBeDone?: bigint;
        writeRemoteBytes?: bigint;
    }
    Index

    Properties

    compilationTimeMs? executionTimeMs? networkSentBytes? overloadingQueueStartTimestamp? photonTotalTimeMs? projectedRemainingTaskTotalTimeMs? projectedRemainingWallclockTimeMs? provisioningQueueStartTimestamp? prunedBytes? prunedFilesCount? queryCompilationStartTimestamp? readBytes? readCacheBytes? readFilesBytes? readFilesCount? readPartitionsCount? readRemoteBytes? remainingTaskCount? resultFetchTimeMs? resultFromCache? rowsProducedCount? rowsReadCount? runnableTasks? spillToDiskBytes? taskTimeOverTimeRange? taskTotalTimeMs? totalTimeMs? workToBeDone? writeRemoteBytes?

    Properties

    compilationTimeMs?: bigint

    Time spent loading metadata and optimizing the query, in milliseconds.

    executionTimeMs?: bigint

    Time spent executing the query, in milliseconds.

    networkSentBytes?: bigint

    Total amount of data sent over the network between executor nodes during shuffle, in bytes.

    overloadingQueueStartTimestamp?: bigint

    Timestamp of when the query was enqueued waiting while the warehouse was at max load. This field is optional and will not appear if the query skipped the overloading queue.

    photonTotalTimeMs?: bigint

    Total execution time for all individual Photon query engine tasks in the query, in milliseconds.

    projectedRemainingTaskTotalTimeMs?: bigint

    projected remaining work to be done aggregated across all stages in the query, in milliseconds

    projectedRemainingWallclockTimeMs?: bigint

    projected lower bound on remaining total task time based on projected_remaining_task_total_time_ms / maximum concurrency

    provisioningQueueStartTimestamp?: bigint

    Timestamp of when the query was enqueued waiting for a cluster to be provisioned for the warehouse. This field is optional and will not appear if the query skipped the provisioning queue.

    prunedBytes?: bigint

    Total number of file bytes in all tables not read due to pruning

    prunedFilesCount?: bigint

    Total number of files from all tables not read due to pruning

    queryCompilationStartTimestamp?: bigint

    Timestamp of when the underlying compute started compilation of the query.

    readBytes?: bigint

    Total size of data read by the query, in bytes.

    readCacheBytes?: bigint

    Size of persistent data read from the cache, in bytes.

    readFilesBytes?: bigint

    Total number of file bytes in all tables read

    readFilesCount?: bigint

    Number of files read after pruning

    readPartitionsCount?: bigint

    Number of partitions read after pruning.

    readRemoteBytes?: bigint

    Size of persistent data read from cloud object storage on your cloud tenant, in bytes.

    remainingTaskCount?: bigint

    number of remaining tasks to complete this is based on the current status and could be bigger or smaller in the future based on future updates

    resultFetchTimeMs?: bigint

    Time spent fetching the query results after the execution finished, in milliseconds.

    resultFromCache?: boolean

    true if the query result was fetched from cache, false otherwise.

    rowsProducedCount?: bigint

    Total number of rows returned by the query.

    rowsReadCount?: bigint

    Total number of rows read by the query.

    runnableTasks?: bigint

    number of remaining tasks to complete, calculated by autoscaler StatementAnalysis.scala deprecated: use remaining_task_count instead

    spillToDiskBytes?: bigint

    Size of data temporarily written to disk while executing the query, in bytes.

    taskTimeOverTimeRange?: TaskTimeOverRange

    sum of task times completed in a range of wall clock time, approximated to a configurable number of points aggregated over all stages and jobs in the query (based on task_total_time_ms)

    taskTotalTimeMs?: bigint

    Sum of execution time for all of the query’s tasks, in milliseconds.

    totalTimeMs?: bigint

    Total execution time of the query from the client’s point of view, in milliseconds.

    workToBeDone?: bigint

    remaining work to be done across all stages in the query, calculated by autoscaler StatementAnalysis.scala, in milliseconds deprecated: using projected_remaining_task_total_time_ms instead

    writeRemoteBytes?: bigint

    Size pf persistent data written to cloud object storage in your cloud tenant, in bytes.

    Settings

    Member Visibility

    On This Page

    Properties