iceberg-js
    Preparing search index...

    Interface IcebergRestCatalogOptions

    Configuration options for the Iceberg REST Catalog client.

    interface IcebergRestCatalogOptions {
        accessDelegation?: AccessDelegation[];
        auth?: AuthConfig;
        baseUrl: string;
        catalogName?: string;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        warehouse?: string;
    }
    Index

    Properties

    accessDelegation? auth? baseUrl catalogName? fetch? warehouse?

    Properties

    accessDelegation?: AccessDelegation[]

    Access delegation mechanisms to request from the server. When specified, the X-Iceberg-Access-Delegation header will be sent with supported operations (createTable, loadTable).

    ['vended-credentials']

    ['vended-credentials', 'remote-signing']
    auth?: AuthConfig

    Authentication configuration

    baseUrl: string

    Base URL of the Iceberg REST Catalog API

    catalogName?: string

    Alias for warehouse kept for backward compatibility. If both are set, warehouse wins.

    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Custom fetch implementation (defaults to globalThis.fetch)

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    warehouse?: string

    Warehouse identifier. The client passes this to GET /v1/config?warehouse=… on first use; the server-returned overrides.prefix is then used for all subsequent requests. This is the spec-recommended way to address a warehouse (e.g., a Cloudflare R2 bucket) and replaces the older catalogName flow.

    Settings

    Member Visibility

    On This Page

    Properties