@loaders.gl/parquet 3.1.0-alpha.4 → 3.1.0-beta.3

package/dist/parquetjs/parser/parquet-cursor.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParquetCursor = void 0;
+const shred_1 = require("../schema/shred");
+/**
+ * A parquet cursor is used to retrieve rows from a parquet file in order
+ */
+class ParquetCursor {
+    /**
+     * Create a new parquet reader from the file metadata and an envelope reader.
+     * It is usually not recommended to call this constructor directly except for
+     * advanced and internal use cases. Consider using getCursor() on the
+     * ParquetReader instead
+     */
+    constructor(metadata, envelopeReader, schema, columnList) {
+        this.rowGroup = [];
+        this.metadata = metadata;
+        this.envelopeReader = envelopeReader;
+        this.schema = schema;
+        this.columnList = columnList;
+        this.rowGroupIndex = 0;
+    }
+    /**
+     * Retrieve the next row from the cursor. Returns a row or NULL if the end
+     * of the file was reached
+     */
+    async next() {
+        if (this.rowGroup.length === 0) {
+            if (this.rowGroupIndex >= this.metadata.row_groups.length) {
+                // @ts-ignore
+                return null;
+            }
+            const rowBuffer = await this.envelopeReader.readRowGroup(this.schema, this.metadata.row_groups[this.rowGroupIndex], this.columnList);
+            this.rowGroup = (0, shred_1.materializeRecords)(this.schema, rowBuffer);
+            this.rowGroupIndex++;
+        }
+        return this.rowGroup.shift();
+    }
+    /**
+     * Rewind the cursor the the beginning of the file
+     */
+    rewind() {
+        this.rowGroup = [];
+        this.rowGroupIndex = 0;
+    }
+    /**
+     * Implement AsyncIterable
+     */
+    // tslint:disable-next-line:function-name
+    [Symbol.asyncIterator]() {
+        let done = false;
+        return {
+            next: async () => {
+                if (done) {
+                    return { done, value: null };
+                }
+                const value = await this.next();
+                if (value === null) {
+                    return { done: true, value };
+                }
+                return { done: false, value };
+            },
+            return: async () => {
+                done = true;
+                return { done, value: null };
+            },
+            throw: async () => {
+                done = true;
+                return { done: true, value: null };
+            }
+        };
+    }
+}
+exports.ParquetCursor = ParquetCursor;

package/dist/parquetjs/parser/parquet-envelope-reader.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="node" />
+import { ParquetSchema } from '../schema/schema';
+import { ColumnChunk, FileMetaData, RowGroup } from '../parquet-thrift';
+import { ParquetBuffer, ParquetData, ParquetOptions } from '../schema/declare';
+/**
+ * The parquet envelope reader allows direct, unbuffered access to the individual
+ * sections of the parquet file, namely the header, footer and the row groups.
+ * This class is intended for advanced/internal users; if you just want to retrieve
+ * rows from a parquet file use the ParquetReader instead
+ */
+export declare class ParquetEnvelopeReader {
+    read: (position: number, length: number) => Promise<Buffer>;
+    /**
+     * Close this parquet reader. You MUST call this method once you're finished
+     * reading rows
+     */
+    close: () => Promise<void>;
+    fileSize: number;
+    defaultDictionarySize: number;
+    static openBuffer(buffer: Buffer): Promise<ParquetEnvelopeReader>;
+    constructor(read: (position: number, length: number) => Promise<Buffer>, close: () => Promise<void>, fileSize: number, options?: any);
+    readHeader(): Promise<void>;
+    readRowGroup(schema: ParquetSchema, rowGroup: RowGroup, columnList: string[][]): Promise<ParquetBuffer>;
+    /**
+     * Do reading of parquet file's column chunk
+     * @param schema
+     * @param colChunk
+     */
+    readColumnChunk(schema: ParquetSchema, colChunk: ColumnChunk): Promise<ParquetData>;
+    /**
+     * Getting dictionary for allows to flatten values by indices.
+     * @param dictionaryPageOffset
+     * @param options
+     * @param pagesOffset
+     * @returns
+     */
+    getDictionary(dictionaryPageOffset: number, options: ParquetOptions, pagesOffset: number): Promise<string[]>;
+    readFooter(): Promise<FileMetaData>;
+}
+//# sourceMappingURL=parquet-envelope-reader.d.ts.map

package/dist/parquetjs/parser/parquet-envelope-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parquet-envelope-reader.d.ts","sourceRoot":"","sources":["../../../src/parquetjs/parser/parquet-envelope-reader.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAC,WAAW,EAAoB,YAAY,EAAE,QAAQ,EAAO,MAAM,mBAAmB,CAAC;AAC9F,OAAO,EACL,aAAa,EAEb,WAAW,EAEX,cAAc,EACf,MAAM,mBAAmB,CAAC;AAM3B;;;;;GAKG;AACH,qBAAa,qBAAqB;IACzB,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACnE;;;OAGG;IACI,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,EAAE,MAAM,CAAC;WAExB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;gBAQrE,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC3D,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAC1B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,GAAG;IAQT,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAc3B,YAAY,CAChB,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,EAAE,EAAE,GACrB,OAAO,CAAC,aAAa,CAAC;IAgBzB;;;;OAIG;IACG,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAoDzF;;;;;;OAMG;IACG,aAAa,CACjB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,cAAc,EACvB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,EAAE,CAAC;IAwBd,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;CAqB1C"}

package/dist/parquetjs/parser/parquet-envelope-reader.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParquetEnvelopeReader = void 0;
+const constants_1 = require("../../constants");
+const parquet_thrift_1 = require("../parquet-thrift");
+const read_utils_1 = require("../utils/read-utils");
+const decoders_1 = require("./decoders");
+const DEFAULT_DICTIONARY_SIZE = 1e6;
+/**
+ * The parquet envelope reader allows direct, unbuffered access to the individual
+ * sections of the parquet file, namely the header, footer and the row groups.
+ * This class is intended for advanced/internal users; if you just want to retrieve
+ * rows from a parquet file use the ParquetReader instead
+ */
+class ParquetEnvelopeReader {
+    constructor(read, close, fileSize, options) {
+        this.read = read;
+        this.close = close;
+        this.fileSize = fileSize;
+        this.defaultDictionarySize = options?.defaultDictionarySize || DEFAULT_DICTIONARY_SIZE;
+    }
+    static async openBuffer(buffer) {
+        const readFn = (position, length) => Promise.resolve(buffer.slice(position, position + length));
+        const closeFn = () => Promise.resolve();
+        return new ParquetEnvelopeReader(readFn, closeFn, buffer.length);
+    }
+    async readHeader() {
+        const buffer = await this.read(0, constants_1.PARQUET_MAGIC.length);
+        const magic = buffer.toString();
+        switch (magic) {
+            case constants_1.PARQUET_MAGIC:
+                break;
+            case constants_1.PARQUET_MAGIC_ENCRYPTED:
+                throw new Error('Encrypted parquet file not supported');
+            default:
+                throw new Error(`Invalid parquet file (magic=${magic})`);
+        }
+    }
+    async readRowGroup(schema, rowGroup, columnList) {
+        const buffer = {
+            rowCount: Number(rowGroup.num_rows),
+            columnData: {}
+        };
+        for (const colChunk of rowGroup.columns) {
+            const colMetadata = colChunk.meta_data;
+            const colKey = colMetadata?.path_in_schema;
+            if (columnList.length > 0 && (0, read_utils_1.fieldIndexOf)(columnList, colKey) < 0) {
+                continue; // eslint-disable-line no-continue
+            }
+            buffer.columnData[colKey.join()] = await this.readColumnChunk(schema, colChunk);
+        }
+        return buffer;
+    }
+    /**
+     * Do reading of parquet file's column chunk
+     * @param schema
+     * @param colChunk
+     */
+    async readColumnChunk(schema, colChunk) {
+        if (colChunk.file_path !== undefined && colChunk.file_path !== null) {
+            throw new Error('external references are not supported');
+        }
+        const field = schema.findField(colChunk.meta_data?.path_in_schema);
+        const type = (0, read_utils_1.getThriftEnum)(parquet_thrift_1.Type, colChunk.meta_data?.type);
+        if (type !== field.primitiveType) {
+            throw new Error(`chunk type not matching schema: ${type}`);
+        }
+        const compression = (0, read_utils_1.getThriftEnum)(parquet_thrift_1.CompressionCodec, colChunk.meta_data?.codec);
+        const pagesOffset = Number(colChunk.meta_data?.data_page_offset);
+        let pagesSize = Number(colChunk.meta_data?.total_compressed_size);
+        if (!colChunk.file_path) {
+            pagesSize = Math.min(this.fileSize - pagesOffset, Number(colChunk.meta_data?.total_compressed_size));
+        }
+        const options = {
+            type,
+            rLevelMax: field.rLevelMax,
+            dLevelMax: field.dLevelMax,
+            compression,
+            column: field,
+            numValues: colChunk.meta_data?.num_values,
+            dictionary: []
+        };
+        let dictionary;
+        const dictionaryPageOffset = colChunk?.meta_data?.dictionary_page_offset;
+        if (dictionaryPageOffset) {
+            const dictionaryOffset = Number(dictionaryPageOffset);
+            // Getting dictionary from column chunk to iterate all over indexes to get dataPage values.
+            dictionary = await this.getDictionary(dictionaryOffset, options, pagesOffset);
+        }
+        dictionary = options.dictionary?.length ? options.dictionary : dictionary;
+        const pagesBuf = await this.read(pagesOffset, pagesSize);
+        return await (0, decoders_1.decodeDataPages)(pagesBuf, { ...options, dictionary });
+    }
+    /**
+     * Getting dictionary for allows to flatten values by indices.
+     * @param dictionaryPageOffset
+     * @param options
+     * @param pagesOffset
+     * @returns
+     */
+    async getDictionary(dictionaryPageOffset, options, pagesOffset) {
+        if (dictionaryPageOffset === 0) {
+            // dictionarySize = Math.min(this.fileSize - pagesOffset, this.defaultDictionarySize);
+            // pagesBuf = await this.read(pagesOffset, dictionarySize);
+            // In this case we are working with parquet-mr files format. Problem is described below:
+            // https://stackoverflow.com/questions/55225108/why-is-dictionary-page-offset-0-for-plain-dictionary-encoding
+            // We need to get dictionary page from column chunk if it exists.
+            // Now if we use code commented above we don't get DICTIONARY_PAGE we get DATA_PAGE instead.
+            return [];
+        }
+        const dictionarySize = Math.min(this.fileSize - dictionaryPageOffset, this.defaultDictionarySize);
+        const pagesBuf = await this.read(dictionaryPageOffset, dictionarySize);
+        const cursor = { buffer: pagesBuf, offset: 0, size: pagesBuf.length };
+        const decodedPage = await (0, decoders_1.decodePage)(cursor, options);
+        return decodedPage.dictionary;
+    }
+    async readFooter() {
+        const trailerLen = constants_1.PARQUET_MAGIC.length + 4;
+        const trailerBuf = await this.read(this.fileSize - trailerLen, trailerLen);
+        const magic = trailerBuf.slice(4).toString();
+        if (magic !== constants_1.PARQUET_MAGIC) {
+            throw new Error(`Not a valid parquet file (magic="${magic})`);
+        }
+        const metadataSize = trailerBuf.readUInt32LE(0);
+        const metadataOffset = this.fileSize - metadataSize - trailerLen;
+        if (metadataOffset < constants_1.PARQUET_MAGIC.length) {
+            throw new Error(`Invalid metadata size ${metadataOffset}`);
+        }
+        const metadataBuf = await this.read(metadataOffset, metadataSize);
+        // let metadata = new parquet_thrift.FileMetaData();
+        // parquet_util.decodeThrift(metadata, metadataBuf);
+        const { metadata } = (0, read_utils_1.decodeFileMetadata)(metadataBuf);
+        return metadata;
+    }
+}
+exports.ParquetEnvelopeReader = ParquetEnvelopeReader;

package/dist/parquetjs/parser/parquet-reader.d.ts

@@ -0,0 +1,68 @@
+/// <reference types="node" />
+import { ParquetEnvelopeReader } from './parquet-envelope-reader';
+import { FileMetaData } from '../parquet-thrift';
+import { ParquetSchema } from '../schema/schema';
+import { ParquetCursor } from './parquet-cursor';
+/**
+ * A parquet reader allows retrieving the rows from a parquet file in order.
+ * The basic usage is to create a reader and then retrieve a cursor/iterator
+ * which allows you to consume row after row until all rows have been read. It is
+ * important that you call close() after you are finished reading the file to
+ * avoid leaking file descriptors.
+ */
+export declare class ParquetReader<T> implements AsyncIterable<T> {
+    /**
+     * return a new parquet reader initialized with a read function
+     */
+    static openBlob<T>(blob: Blob): Promise<ParquetReader<T>>;
+    /**
+     * return a new parquet reader initialized with a read function
+     */
+    static openArrayBuffer<T>(arrayBuffer: ArrayBuffer): Promise<ParquetReader<T>>;
+    static openBuffer<T>(buffer: Buffer): Promise<ParquetReader<T>>;
+    metadata: FileMetaData;
+    envelopeReader: ParquetEnvelopeReader;
+    schema: ParquetSchema;
+    /**
+     * Create a new parquet reader from the file metadata and an envelope reader.
+     * It is not recommended to call this constructor directly except for advanced
+     * and internal use cases. Consider using one of the open{File,Buffer} methods
+     * instead
+     */
+    constructor(metadata: FileMetaData, envelopeReader: ParquetEnvelopeReader);
+    /**
+     * Close this parquet reader. You MUST call this method once you're finished
+     * reading rows
+     */
+    close(): Promise<void>;
+    /**
+     * Return a cursor to the file. You may open more than one cursor and use
+     * them concurrently. All cursors become invalid once close() is called on
+     * the reader object.
+     *
+     * The required_columns parameter controls which columns are actually read
+     * from disk. An empty array or no value implies all columns. A list of column
+     * names means that only those columns should be loaded from disk.
+     */
+    getCursor(): ParquetCursor<T>;
+    getCursor<K extends keyof T>(columnList: (K | K[])[]): ParquetCursor<Pick<T, K>>;
+    getCursor(columnList: (string | string[])[]): ParquetCursor<Partial<T>>;
+    /**
+     * Return the number of rows in this file. Note that the number of rows is
+     * not neccessarily equal to the number of rows in each column.
+     */
+    getRowCount(): number;
+    /**
+     * Returns the ParquetSchema for this file
+     */
+    getSchema(): ParquetSchema;
+    /**
+     * Returns the user (key/value) metadata for this file
+     */
+    getMetadata(): Record<string, string>;
+    /**
+     * Implement AsyncIterable
+     */
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+}
+//# sourceMappingURL=parquet-reader.d.ts.map

package/dist/parquetjs/parser/parquet-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parquet-reader.d.ts","sourceRoot":"","sources":["../../../src/parquetjs/parser/parquet-reader.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,qBAAqB,EAAC,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAI/C;;;;;;GAMG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC;IACvD;;OAEG;WACU,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAkB/D;;OAEG;WACU,eAAe,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;WAevE,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAY9D,QAAQ,EAAE,YAAY,CAAC;IACvB,cAAc,EAAE,qBAAqB,CAAC;IACtC,MAAM,EAAE,aAAa,CAAC;IAE7B;;;;;OAKG;gBACS,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,qBAAqB;IAYzE;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAM5B;;;;;;;;OAQG;IACH,SAAS,IAAI,aAAa,CAAC,CAAC,CAAC;IAE7B,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChF,SAAS,CAAC,UAAU,EAAE,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAkBvE;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;OAEG;IACH,SAAS,IAAI,aAAa;IAI1B;;OAEG;IACH,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAQrC;;OAEG;IAEH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;CAG3C"}

package/dist/parquetjs/parser/parquet-reader.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParquetReader = void 0;
+// Forked from https://github.com/kbajalc/parquets under MIT license (Copyright (c) 2017 ironSource Ltd.)
+const parquet_envelope_reader_1 = require("./parquet-envelope-reader");
+const schema_1 = require("../schema/schema");
+const parquet_cursor_1 = require("./parquet-cursor");
+const constants_1 = require("../../constants");
+const decoders_1 = require("./decoders");
+/**
+ * A parquet reader allows retrieving the rows from a parquet file in order.
+ * The basic usage is to create a reader and then retrieve a cursor/iterator
+ * which allows you to consume row after row until all rows have been read. It is
+ * important that you call close() after you are finished reading the file to
+ * avoid leaking file descriptors.
+ */
+class ParquetReader {
+    /**
+     * Create a new parquet reader from the file metadata and an envelope reader.
+     * It is not recommended to call this constructor directly except for advanced
+     * and internal use cases. Consider using one of the open{File,Buffer} methods
+     * instead
+     */
+    constructor(metadata, envelopeReader) {
+        if (metadata.version !== constants_1.PARQUET_VERSION) {
+            throw new Error('invalid parquet version');
+        }
+        this.metadata = metadata;
+        this.envelopeReader = envelopeReader;
+        const root = this.metadata.schema[0];
+        const { schema } = (0, decoders_1.decodeSchema)(this.metadata.schema, 1, root.num_children);
+        this.schema = new schema_1.ParquetSchema(schema);
+    }
+    /**
+     * return a new parquet reader initialized with a read function
+     */
+    static async openBlob(blob) {
+        const readFn = async (start, length) => {
+            const arrayBuffer = await blob.slice(start, start + length).arrayBuffer();
+            return Buffer.from(arrayBuffer);
+        };
+        const closeFn = async () => { };
+        const size = blob.size;
+        const envelopeReader = new parquet_envelope_reader_1.ParquetEnvelopeReader(readFn, closeFn, size);
+        try {
+            await envelopeReader.readHeader();
+            const metadata = await envelopeReader.readFooter();
+            return new ParquetReader(metadata, envelopeReader);
+        }
+        catch (err) {
+            await envelopeReader.close();
+            throw err;
+        }
+    }
+    /**
+     * return a new parquet reader initialized with a read function
+     */
+    static async openArrayBuffer(arrayBuffer) {
+        const readFn = async (start, length) => Buffer.from(arrayBuffer, start, length);
+        const closeFn = async () => { };
+        const size = arrayBuffer.byteLength;
+        const envelopeReader = new parquet_envelope_reader_1.ParquetEnvelopeReader(readFn, closeFn, size);
+        try {
+            await envelopeReader.readHeader();
+            const metadata = await envelopeReader.readFooter();
+            return new ParquetReader(metadata, envelopeReader);
+        }
+        catch (err) {
+            await envelopeReader.close();
+            throw err;
+        }
+    }
+    static async openBuffer(buffer) {
+        const envelopeReader = await parquet_envelope_reader_1.ParquetEnvelopeReader.openBuffer(buffer);
+        try {
+            await envelopeReader.readHeader();
+            const metadata = await envelopeReader.readFooter();
+            return new ParquetReader(metadata, envelopeReader);
+        }
+        catch (err) {
+            await envelopeReader.close();
+            throw err;
+        }
+    }
+    /**
+     * Close this parquet reader. You MUST call this method once you're finished
+     * reading rows
+     */
+    async close() {
+        await this.envelopeReader.close();
+        // this.envelopeReader = null;
+        // this.metadata = null;
+    }
+    getCursor(columnList) {
+        if (!columnList) {
+            // tslint:disable-next-line:no-parameter-reassignment
+            columnList = [];
+        }
+        // tslint:disable-next-line:no-parameter-reassignment
+        columnList = columnList.map((x) => (Array.isArray(x) ? x : [x]));
+        return new parquet_cursor_1.ParquetCursor(this.metadata, this.envelopeReader, this.schema, columnList);
+    }
+    /**
+     * Return the number of rows in this file. Note that the number of rows is
+     * not neccessarily equal to the number of rows in each column.
+     */
+    getRowCount() {
+        return Number(this.metadata.num_rows);
+    }
+    /**
+     * Returns the ParquetSchema for this file
+     */
+    getSchema() {
+        return this.schema;
+    }
+    /**
+     * Returns the user (key/value) metadata for this file
+     */
+    getMetadata() {
+        const md = {};
+        for (const kv of this.metadata.key_value_metadata) {
+            md[kv.key] = kv.value;
+        }
+        return md;
+    }
+    /**
+     * Implement AsyncIterable
+     */
+    // tslint:disable-next-line:function-name
+    [Symbol.asyncIterator]() {
+        return this.getCursor()[Symbol.asyncIterator]();
+    }
+}
+exports.ParquetReader = ParquetReader;

package/dist/parquetjs/schema/declare.d.ts

@@ -0,0 +1,80 @@
+import Int64 from 'node-int64';
+import type { PageHeader } from '../parquet-thrift';
+export declare type ParquetCodec = 'PLAIN' | 'RLE' | 'PLAIN_DICTIONARY';
+export declare type ParquetCompression = 'UNCOMPRESSED' | 'GZIP' | 'SNAPPY' | 'LZO' | 'BROTLI' | 'LZ4' | 'LZ4_RAW' | 'ZSTD';
+export declare type RepetitionType = 'REQUIRED' | 'OPTIONAL' | 'REPEATED';
+export declare type ParquetType = PrimitiveType | OriginalType;
+/**
+ * Physical type
+ */
+export declare type PrimitiveType = 'BOOLEAN' | 'INT32' | 'INT64' | 'INT96' | 'FLOAT' | 'DOUBLE' | 'BYTE_ARRAY' | 'FIXED_LEN_BYTE_ARRAY';
+/**
+ * Logical type
+ */
+export declare type OriginalType = 'UTF8' | 'DECIMAL_INT32' | 'DECIMAL_INT64' | 'DECIMAL_BYTE_ARRAY' | 'DECIMAL_FIXED_LEN_BYTE_ARRAY' | 'DATE' | 'TIME_MILLIS' | 'TIME_MICROS' | 'TIMESTAMP_MILLIS' | 'TIMESTAMP_MICROS' | 'UINT_8' | 'UINT_16' | 'UINT_32' | 'UINT_64' | 'INT_8' | 'INT_16' | 'INT_32' | 'INT_64' | 'JSON' | 'BSON' | 'INTERVAL';
+export declare type ParquetDictionary = string[];
+export interface SchemaDefinition {
+    [string: string]: FieldDefinition;
+}
+export interface FieldDefinition {
+    type?: ParquetType;
+    typeLength?: number;
+    presision?: number;
+    scale?: number;
+    encoding?: ParquetCodec;
+    compression?: ParquetCompression;
+    optional?: boolean;
+    repeated?: boolean;
+    fields?: SchemaDefinition;
+}
+export interface ParquetField {
+    name: string;
+    path: string[];
+    key: string;
+    primitiveType?: PrimitiveType;
+    originalType?: OriginalType;
+    repetitionType: RepetitionType;
+    typeLength?: number;
+    presision?: number;
+    scale?: number;
+    encoding?: ParquetCodec;
+    compression?: ParquetCompression;
+    rLevelMax: number;
+    dLevelMax: number;
+    isNested?: boolean;
+    fieldCount?: number;
+    fields?: Record<string, ParquetField>;
+}
+export interface ParquetOptions {
+    type: ParquetType;
+    rLevelMax: number;
+    dLevelMax: number;
+    compression: ParquetCompression;
+    column: ParquetField;
+    numValues?: Int64;
+    dictionary?: ParquetDictionary;
+}
+export interface ParquetData {
+    dlevels: number[];
+    rlevels: number[];
+    values: any[];
+    count: number;
+    pageHeaders: PageHeader[];
+}
+export interface ParquetPageData {
+    dlevels: number[];
+    rlevels: number[];
+    values: any[];
+    count: number;
+    dictionary?: ParquetDictionary;
+    pageHeader: PageHeader;
+}
+export interface ParquetRecord {
+    [key: string]: any;
+}
+export declare class ParquetBuffer {
+    rowCount: number;
+    columnData: Record<string, ParquetData>;
+    constructor(rowCount?: number, columnData?: Record<string, ParquetData>);
+}
+//# sourceMappingURL=declare.d.ts.map

package/dist/parquetjs/schema/declare.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"declare.d.ts","sourceRoot":"","sources":["../../../src/parquetjs/schema/declare.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAElD,oBAAY,YAAY,GAAG,OAAO,GAAG,KAAK,GAAG,kBAAkB,CAAC;AAChE,oBAAY,kBAAkB,GAC1B,cAAc,GACd,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,KAAK,GACL,SAAS,GACT,MAAM,CAAC;AACX,oBAAY,cAAc,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;AAClE,oBAAY,WAAW,GAAG,aAAa,GAAG,YAAY,CAAC;AAEvD;;GAEG;AACH,oBAAY,aAAa,GAErB,SAAS,GACT,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,sBAAsB,CAAC;AAE3B;;GAEG;AACH,oBAAY,YAAY,GAEpB,MAAM,GAMN,eAAe,GACf,eAAe,GACf,oBAAoB,GACpB,8BAA8B,GAC9B,MAAM,GACN,aAAa,GACb,aAAa,GACb,kBAAkB,GAClB,kBAAkB,GAClB,QAAQ,GACR,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,UAAU,CAAC;AAEf,oBAAY,iBAAiB,GAAG,MAAM,EAAE,CAAC;AAEzC,MAAM,WAAW,gBAAgB;IAC/B,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,kBAAkB,CAAC;IAChC,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,CAAC,EAAE,KAAK,CAAC;IAClB,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,GAAG,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,qBAAa,aAAa;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC5B,QAAQ,GAAE,MAAU,EAAE,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAM;CAI/E"}

package/dist/parquetjs/schema/declare.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParquetBuffer = void 0;
+class ParquetBuffer {
+    constructor(rowCount = 0, columnData = {}) {
+        this.rowCount = rowCount;
+        this.columnData = columnData;
+    }
+}
+exports.ParquetBuffer = ParquetBuffer;

package/dist/parquetjs/schema/schema.d.ts

@@ -0,0 +1,26 @@
+import { FieldDefinition, ParquetBuffer, ParquetCompression, ParquetField, ParquetRecord, SchemaDefinition } from './declare';
+/**
+ * A parquet file schema
+ */
+export declare class ParquetSchema {
+    schema: Record<string, FieldDefinition>;
+    fields: Record<string, ParquetField>;
+    fieldList: ParquetField[];
+    /**
+     * Create a new schema from a JSON schema definition
+     */
+    constructor(schema: SchemaDefinition);
+    /**
+     * Retrieve a field definition
+     */
+    findField(path: string | string[]): ParquetField;
+    /**
+     * Retrieve a field definition and all the field's ancestors
+     */
+    findFieldBranch(path: string | string[]): ParquetField[];
+    shredRecord(record: ParquetRecord, buffer: ParquetBuffer): void;
+    materializeRecords(buffer: ParquetBuffer): ParquetRecord[];
+    compress(type: ParquetCompression): this;
+    buffer(): ParquetBuffer;
+}
+//# sourceMappingURL=schema.d.ts.map

package/dist/parquetjs/schema/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/parquetjs/schema/schema.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,aAAa,EAEb,gBAAgB,EACjB,MAAM,WAAW,CAAC;AAInB;;GAEG;AACH,qBAAa,aAAa;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACrC,SAAS,EAAE,YAAY,EAAE,CAAC;IAEjC;;OAEG;gBACS,MAAM,EAAE,gBAAgB;IAMpC;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY;IAiBhD;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,EAAE;IAgBxD,WAAW,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,GAAG,IAAI;IAI/D,kBAAkB,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,EAAE;IAI1D,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAMxC,MAAM,IAAI,aAAa;CAGxB"}