snowflake-sdk/dist/lib/connection/result/chunk.d.ts

Node.js driver for Snowflake

export = Chunk;
/**
 * Creates a new Chunk.
 *
 * @param options
 * @constructor
 */
declare function Chunk(options: any): void;
declare class Chunk {
    /**
     * Creates a new Chunk.
     *
     * @param options
     * @constructor
     */
    constructor(options: any);
    _compressedSize: any;
    _uncompressedSize: any;
    _statement: any;
    _services: any;
    _startIndex: any;
    _url: any;
    _columns: any;
    _mapColumnNameToIndices: any;
    _chunkHeaders: any;
    _rowset: any;
    _endIndex: number;
    _id: string;
    /**
     * Returns the compressed size of this chunk's contents on S3/Blob.
     * A value of -1 means the contents of this chunk are not stored on S3/Blob.
     *
     * @returns {Number}
     */
    getCompressedSize(): number;
    /**
     * Returns the uncompressed size of this chunk's contents on S3/Blob.
     * A value of -1 means the contents of this chunk are not stored on S3/Blob.
     *
     * @returns {Number}
     */
    getUncompressedSize(): number;
    /**
     * Returns the row index of the first row in this chunk.
     *
     * @returns {Number}
     */
    getStartIndex(): number;
    /**
     * Returns the row index of the last row in this chunk.
     *
     * @returns {Number}
     */
    getEndIndex(): number;
    /**
     * Returns the id of this chunk.
     *
     * @returns {String}
     */
    getId(): string;
    /**
     * Determines if this chunk overlaps with a given window.
     *
     * @param {Number} start The start index of the window.
     * @param {Number} end The end index of the window.
     *
     * @returns {Boolean}
     */
    overlapsWithWindow(start: number, end: number): boolean;
    /**
     * Returns the rows in this chunk.
     *
     * @returns {Object[]}
     */
    getRows(): Object[];
    _rowsetAsString: any;
    _rows: any[] | undefined;
    /**
     * Clears out the rows in this chunk if it has a valid url or if the force flag
     * is true.
     *
     * @param force
     */
    clearRows(force: any): void;
    /**
     * Updates this chunk's url.
     *
     * @param url
     */
    setUrl(url: any): void;
    /**
     * Returns true if this chunk's contents are loaded, false otherwise.
     *
     * @returns {Boolean}
     */
    isLoaded(): boolean;
    /**
     * Returns true if this chunk is currently in the process of loading its
     * contents, false otherwise.
     *
     * @returns {Boolean}
     */
    isLoading(): boolean;
    /**
     * Loads the contents of this chunk.
     *
     * @param callback
     */
    load(callback: any): void;
    _isLoading: boolean | undefined;
}