Databricks SDK for JavaScript
    Preparing search index...

    Interface ExternalLink

    interface ExternalLink {
        byteCount?: bigint;
        chunkIndex?: number;
        expiration?: string;
        externalLink?: string;
        httpHeaders?: Record<string, string>;
        nextChunkIndex?: number;
        nextChunkInternalLink?: string;
        rowCount?: bigint;
        rowOffset?: bigint;
    }
    Index

    Properties

    byteCount? chunkIndex? expiration? externalLink? httpHeaders? 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.

    expiration?: string

    Indicates the date-time that the given external link will expire and becomes invalid, after which point a new external_link must be requested.

    externalLink?: string

    A URL pointing to a chunk of result data, hosted by an external service, with a short expiration time (<= 15 minutes). As this URL contains a temporary credential, it should be considered sensitive and the client should not expose this URL in a log.

    httpHeaders?: Record<string, string>

    HTTP headers that must be included with a GET request to the external_link. Each header is provided as a key-value pair. Headers are typically used to pass a decryption key to the external service. The values of these headers should be considered sensitive and the client should not expose these values in a log.

    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