@iqmo/hyparquet/types/read.d.ts

Parquet file parser for JavaScript

/**
 * Read parquet data rows from a file-like object.
 * Reads the minimal number of row groups and columns to satisfy the request.
 *
 * Returns a void promise when complete, and to throw errors.
 * Data is returned in onComplete, not the return promise, because
 * if onComplete is undefined, we parse the data, and emit chunks, but skip
 * computing the row view directly. This saves on allocation if the caller
 * wants to cache the full chunks, and make their own view of the data from
 * the chunks.
 *
 * @param {ParquetReadOptions} options read options
 * @returns {Promise<void>} resolves when all requested rows and columns are parsed, all errors are thrown here
 */
export function parquetRead(options: ParquetReadOptions): Promise<void>;
/**
 * Read a row group from a file-like object.
 *
 * @param {ParquetReadOptions} options read options
 * @param {RowGroup} rowGroup row group to read
 * @param {number} groupStart row index of the first row in the group
 * @returns {Promise<any[][]>} resolves to row data
 */
export function readRowGroup(options: ParquetReadOptions, rowGroup: RowGroup, groupStart: number): Promise<any[][]>;
import type { ParquetReadOptions } from '../src/types.d.ts';
import type { RowGroup } from '../src/types.d.ts';
//# sourceMappingURL=read.d.ts.map