hyparquet/types/schema.d.ts

Parquet file parser for JavaScript

/**
 * Get schema elements from the root to the given element name.
 *
 * @param {SchemaElement[]} schema
 * @param {string[]} name path to the element
 * @returns {SchemaTree[]} list of schema elements
 */
export declare function getSchemaPath(schema: SchemaElement[], name: string[]): SchemaTree[];
/**
 * Get schema tree nodes from the root of a prebuilt tree to the given element name.
 *
 * @param {SchemaTree} tree root of the schema tree
 * @param {string[]} name path to the element
 * @returns {SchemaTree[]} list of schema elements
 */
export declare function getTreePath(tree: SchemaTree, name: string[]): SchemaTree[];
/**
 * Get all physical (leaf) column names.
 *
 * @param {SchemaTree} schemaTree
 * @returns {string[]} list of physical column names
 */
export declare function getPhysicalColumns(schemaTree: SchemaTree): string[];
/**
 * Get the max repetition level for a given schema path.
 *
 * @param {SchemaTree[]} schemaPath
 * @returns {number} max repetition level
 */
export declare function getMaxRepetitionLevel(schemaPath: SchemaTree[]): number;
/**
 * Get the max definition level for a given schema path.
 *
 * @param {SchemaTree[]} schemaPath
 * @returns {number} max definition level
 */
export declare function getMaxDefinitionLevel(schemaPath: SchemaTree[]): number;
/**
 * Check if a column is list-like.
 *
 * @param {SchemaTree} schema
 * @returns {boolean} true if list-like
 */
export declare function isListLike(schema: SchemaTree): boolean;
/**
 * Check if a column is map-like.
 *
 * @param {SchemaTree} schema
 * @returns {boolean} true if map-like
 */
export declare function isMapLike(schema: SchemaTree): boolean;
/**
 * Returns true if a column is non-nested.
 *
 * @param {SchemaTree[]} schemaPath
 * @returns {boolean}
 */
export declare function isFlatColumn(schemaPath: SchemaTree[]): boolean;
import type { SchemaElement, SchemaTree } from '../src/types.js';
/**
 * @import {SchemaElement, SchemaTree} from '../src/types.js'
 */
//# sourceMappingURL=schema.d.ts.map