icebird
Version:
Apache Iceberg client for javascript
30 lines • 1.61 kB
TypeScript
/**
* Reads data from the Iceberg table with optional row-level delete processing.
* Row indices are zero-based and rowEnd is exclusive.
*
* @param {object} options
* @param {string} options.tableUrl - Base S3 URL of the table.
* @param {number} [options.rowStart] - The starting global row index to fetch (inclusive).
* @param {number} [options.rowEnd] - The ending global row index to fetch (exclusive).
* @param {string} [options.metadataFileName] - Name of the Iceberg metadata file.
* @param {TableMetadata} [options.metadata] - Pre-fetched Iceberg metadata.
* @param {RequestInit} [options.requestInit] - Optional fetch request initialization.
* @returns {Promise<Array<Record<string, any>>>} Array of data records.
*/
export function icebergRead({ tableUrl, rowStart, rowEnd, metadataFileName, metadata, requestInit, }: {
tableUrl: string;
rowStart?: number | undefined;
rowEnd?: number | undefined;
metadataFileName?: string | undefined;
metadata?: TableMetadata | undefined;
requestInit?: RequestInit | undefined;
}): Promise<Array<Record<string, any>>>;
export { avroMetadata } from "./avro.metadata.js";
export { avroData } from "./avro.data.js";
import type { TableMetadata } from '../src/types.js';
import { icebergMetadata } from './iceberg.metadata.js';
import { icebergManifests } from './iceberg.manifest.js';
import { icebergLatestVersion } from './iceberg.metadata.js';
import { icebergListVersions } from './iceberg.metadata.js';
export { icebergMetadata, icebergManifests, icebergLatestVersion, icebergListVersions };
//# sourceMappingURL=iceberg.d.ts.map