@loaders.gl/parquet 5.0.0-alpha.2 → 5.0.0-alpha.4

package/dist/iceberg-table-source.d.ts

@@ -0,0 +1,63 @@
+import type { CoreAPI, ScanQueryMetadata, ScanQueryMetadataOptions, TableScanSource } from '@loaders.gl/loader-utils';
+import { DataSource as BaseDataSource } from '@loaders.gl/loader-utils';
+import type { IcebergSpatialFilter, IcebergDeleteFile, IcebergParquetFile, IcebergScanPlan, IcebergSnapshot, IcebergTableMetadata, IcebergTableSourceOptions } from "./iceberg-types.js";
+import type { ParquetDatasetBatch, ParquetPredicate, ParquetDatasetReadOptions, ParquetDatasetExplain, ParquetDatasetSourceOptions } from "./parquet-source-types.js";
+/** Options accepted by `IcebergTableSource`. */
+export type IcebergSourceOptions = ParquetDatasetSourceOptions & {
+    iceberg?: IcebergTableSourceOptions;
+};
+/** Options for scanning the current Iceberg snapshot as Parquet batches. */
+export type IcebergScanOptions = ParquetDatasetReadOptions & {
+    /** Reads a specific snapshot instead of the table's current snapshot. */
+    snapshotId?: number;
+    /** Reads the snapshot selected by a named Iceberg branch or tag. */
+    snapshotRef?: string;
+    /** Applies Iceberg position deletes after Parquet batches are decoded. */
+    applyDeletes?: boolean;
+    /** Conservatively prunes files whose declared geometry bounds miss this envelope. */
+    spatialFilter?: IcebergSpatialFilter;
+};
+/**
+ * Read-only Iceberg table metadata source.
+ *
+ * The source owns Iceberg metadata and manifest discovery, then delegates selected data files to
+ * `ParquetDatasetSource` for projection, filtering, range access, workers, and Arrow materialization.
+ */
+export declare class IcebergTableSource extends BaseDataSource<string, IcebergSourceOptions> implements TableScanSource<ParquetDatasetBatch, ParquetPredicate> {
+    private metadataPromise;
+    private readonly closeController;
+    private closed;
+    constructor(data: string, options?: IcebergSourceOptions, coreApi?: CoreAPI);
+    /** Loads and validates the table metadata JSON. Results are cached for the source lifetime. */
+    getMetadata(signal?: AbortSignal): Promise<IcebergTableMetadata>;
+    /** Returns the snapshot selected by the table metadata, if one exists. */
+    getCurrentSnapshot(signal?: AbortSignal): Promise<IcebergSnapshot | undefined>;
+    /** Returns a selected snapshot, defaulting to the table's current snapshot. */
+    private getSnapshot;
+    /** Builds a data and delete-file plan from one snapshot without opening data files. */
+    getScanPlan(signal?: AbortSignal, snapshotId?: number, snapshotRef?: string): Promise<IcebergScanPlan>;
+    /** Reads the selected snapshot's active Parquet data files. */
+    getParquetFiles(signal?: AbortSignal, snapshotId?: number, snapshotRef?: string): Promise<readonly IcebergParquetFile[]>;
+    /** Reads delete files from the selected snapshot without applying them to Parquet rows. */
+    getDeleteFiles(signal?: AbortSignal, snapshotId?: number, snapshotRef?: string): Promise<readonly IcebergDeleteFile[]>;
+    /** Discovers the current snapshot schema and aggregate file statistics without decoding rows. */
+    getQueryMetadata(options?: ScanQueryMetadataOptions): Promise<ScanQueryMetadata>;
+    /** Explains Iceberg manifest pruning and the delegated Parquet dataset plan. */
+    explain(options?: IcebergScanOptions): Promise<ParquetDatasetExplain>;
+    /** Common table-scan entry point for the selected Iceberg snapshot. */
+    read(options?: IcebergScanOptions): AsyncIterable<ParquetDatasetBatch>;
+    /** Reads the current snapshot as Arrow batches through the existing Parquet dataset source. */
+    scan(options?: IcebergScanOptions): AsyncIterable<ParquetDatasetBatch>;
+    /** Creates the delegated Parquet dataset after Iceberg metadata-level pruning. */
+    private createParquetDataset;
+    /** Permanently closes the source and aborts an in-flight metadata request. */
+    close(): Promise<void>;
+    private loadMetadata;
+    private readAvroRecords;
+    /** Reads position-delete files into a source-file to row-position index. */
+    private loadPositionDeletes;
+    /** Reads equality-delete files and resolves their Iceberg field IDs to current schema names. */
+    private loadEqualityDeletes;
+    private assertOpen;
+}
+//# sourceMappingURL=iceberg-table-source.d.ts.map

package/dist/iceberg-table-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iceberg-table-source.d.ts","sourceRoot":"","sources":["../src/iceberg-table-source.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,OAAO,EACP,iBAAiB,EACjB,wBAAwB,EACxB,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAEL,UAAU,IAAI,cAAc,EAE7B,MAAM,0BAA0B,CAAC;AAGlC,OAAO,KAAK,EAGV,oBAAoB,EACpB,iBAAiB,EAEjB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,yBAAyB,EAC1B,2BAAwB;AAIzB,OAAO,KAAK,EACV,mBAAmB,EAGnB,gBAAgB,EAEhB,yBAAyB,EACzB,qBAAqB,EACrB,2BAA2B,EAC5B,kCAA+B;AAmBhC,gDAAgD;AAChD,MAAM,MAAM,oBAAoB,GAAG,2BAA2B,GAAG;IAC/D,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG;IAC3D,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qFAAqF;IACrF,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACtC,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,kBACX,SAAQ,cAAc,CAAC,MAAM,EAAE,oBAAoB,CACnD,YAAW,eAAe,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;IAEjE,OAAO,CAAC,eAAe,CAA8C;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IACzD,OAAO,CAAC,MAAM,CAAS;gBAEX,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,EAAE,OAAO,CAAC,EAAE,OAAO;IAI/E,+FAA+F;IACzF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWtE,0EAA0E;IACpE,kBAAkB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAIpF,+EAA+E;YACjE,WAAW;IAkBzB,uFAAuF;IACjF,WAAW,CACf,MAAM,CAAC,EAAE,WAAW,EACpB,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,eAAe,CAAC;IAiD3B,+DAA+D;IACzD,eAAe,CACnB,MAAM,CAAC,EAAE,WAAW,EACpB,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,SAAS,kBAAkB,EAAE,CAAC;IAIzC,2FAA2F;IACrF,cAAc,CAClB,MAAM,CAAC,EAAE,WAAW,EACpB,UAAU,CAAC,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,SAAS,iBAAiB,EAAE,CAAC;IAIxC,iGAAiG;IAC3F,gBAAgB,CAAC,OAAO,GAAE,wBAA6B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA2B1F,gFAAgF;IAC1E,OAAO,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAY/E,uEAAuE;IACvE,IAAI,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa,CAAC,mBAAmB,CAAC;IAI1E,+FAA+F;IACxF,IAAI,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa,CAAC,mBAAmB,CAAC;IAyDjF,kFAAkF;IAClF,OAAO,CAAC,oBAAoB;IAqC5B,8EAA8E;IACxE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAOd,YAAY;YAmBZ,eAAe;IAiB7B,4EAA4E;YAC9D,mBAAmB;IA0BjC,gGAAgG;YAClF,mBAAmB;IA2BjC,OAAO,CAAC,UAAU;CAGnB"}