Databricks SDK for JavaScript
    Preparing search index...

    Interface ResultData

    Contains the result data of a single chunk when using INLINE disposition. When using EXTERNAL_LINKS disposition, the array external_links is used instead to provide URLs to the result data in cloud storage. Exactly one of these alternatives is used. (While the external_links array prepares the API to return multiple links in a single response. Currently only a single link is returned.)

    interface ResultData {
        byteCount?: bigint;
        chunkIndex?: number;
        dataArray?: JsonValue[][];
        externalLinks?: ExternalLink[];
        nextChunkIndex?: number;
        nextChunkInternalLink?: string;
        rowCount?: bigint;
        rowOffset?: bigint;
    }
    Index

    Properties

    byteCount? chunkIndex? dataArray? externalLinks? nextChunkIndex? nextChunkInternalLink? rowCount? rowOffset?

    Properties

    byteCount?: bigint

    The number of bytes in the result chunk. This field is not available when using INLINE disposition.

    chunkIndex?: number

    The position within the sequence of result set chunks.

    dataArray?: JsonValue[][]

    The JSON_ARRAY format is an array of arrays of values, where each non-null value is formatted as a string. Null values are encoded as JSON null.

    externalLinks?: ExternalLink[]
    nextChunkIndex?: number

    When fetching, provides the chunk_index for the next chunk. If absent, indicates there are no more chunks. The next chunk can be fetched with a :method:statementexecution/getstatementresultchunkn request.

    nextChunkInternalLink?: string

    When fetching, provides a link to fetch the next chunk. If absent, indicates there are no more chunks. This link is an absolute path to be joined with your $DATABRICKS_HOST, and should be treated as an opaque link. This is an alternative to using next_chunk_index.

    rowCount?: bigint

    The number of rows within the result chunk.

    rowOffset?: bigint

    The starting row offset within the result set.

    Settings

    Member Visibility

    On This Page

    Properties