hyparquet/types/column.d.ts

Parquet file parser for JavaScript

/**
 * Parse column data from a buffer.
 *
 * @param {DataReader} reader
 * @param {number | undefined} rowLimit maximum number of rows to read (undefined reads all rows)
 * @param {ColumnMetaData} columnMetadata column metadata
 * @param {SchemaTree[]} schemaPath schema path for the column
 * @param {ParquetReadOptions} options read options
 * @returns {DecodedArray[]}
 */
export function readColumn(reader: DataReader, rowLimit: number | undefined, columnMetadata: ColumnMetaData, schemaPath: SchemaTree[], options: ParquetReadOptions): DecodedArray[];
/**
 * Read a page (data or dictionary) from a buffer.
 *
 * @param {DataReader} reader
 * @param {ColumnMetaData} columnMetadata
 * @param {SchemaTree[]} schemaPath
 * @param {SchemaElement} element
 * @param {DecodedArray | undefined} dictionary
 * @param {ParquetReadOptions} options
 * @returns {DecodedArray}
 */
export function readPage(reader: DataReader, columnMetadata: ColumnMetaData, schemaPath: SchemaTree[], element: SchemaElement, dictionary: DecodedArray | undefined, { utf8, compressors }: ParquetReadOptions): DecodedArray;
/**
 * Find the start byte offset for a column chunk.
 *
 * @param {ColumnMetaData} columnMetadata
 * @returns {[bigint, bigint]} byte offset range
 */
export function getColumnRange({ dictionary_page_offset, data_page_offset, total_compressed_size }: ColumnMetaData): [bigint, bigint];
import type { DataReader } from '../src/types.d.ts';
import type { ColumnMetaData } from '../src/types.d.ts';
import type { SchemaTree } from '../src/types.d.ts';
import type { ParquetReadOptions } from '../src/types.d.ts';
import type { DecodedArray } from '../src/types.d.ts';
import type { SchemaElement } from '../src/types.d.ts';
//# sourceMappingURL=column.d.ts.map