@qualithm/arrow-flight-sql-js - v0.4.3
    Preparing search index...

    Type Alias FlightTransport

    Abstract transport type for Flight SQL operations.

    Each runtime provides its own implementation:

    • GrpcJsTransport for Node.js/Bun (using @grpc/grpc-js)
    • GrpcWebTransport for Browser/Cloudflare Workers
    • DenoTransport for Deno (native gRPC or gRPC-web)
    type FlightTransport = {
        close: () => void;
        connect: () => Promise<void>;
        doAction: (
            action: RawAction,
            metadata?: TransportMetadata,
        ) => ReadableStream<RawActionResult>;
        doExchange: (
            metadata?: TransportMetadata,
        ) => DuplexStream<RawFlightData, RawFlightData>;
        doGet: (
            ticket: RawTicket,
            metadata?: TransportMetadata,
        ) => ReadableStream<RawFlightData>;
        doPut: (
            metadata?: TransportMetadata,
        ) => DuplexStream<RawFlightData, RawPutResult>;
        getFlightInfo: (
            descriptor: { cmd?: Uint8Array; path?: string[]; type: number },
            metadata?: TransportMetadata,
        ) => Promise<RawFlightInfo>;
        getSchema: (
            descriptor: { cmd?: Uint8Array; path?: string[]; type: number },
            metadata?: TransportMetadata,
        ) => Promise<{ schema: Uint8Array }>;
        handshake: (
            metadata?: TransportMetadata,
        ) => DuplexStream<RawHandshakeMessage, RawHandshakeMessage>;
        isConnected: () => boolean;
        listActions: (
            metadata?: TransportMetadata,
        ) => ReadableStream<RawActionType>;
        listFlights: (
            criteria?: Uint8Array,
            metadata?: TransportMetadata,
        ) => ReadableStream<RawFlightInfo>;
        setAuthToken: (token: string | null) => void;
    }

    Implemented by

    Index

    Properties

    close connect doAction doExchange doGet doPut getFlightInfo getSchema handshake isConnected listActions listFlights setAuthToken

    Properties

    close: () => void

    Close the connection

    connect: () => Promise<void>

    Connect to the Flight SQL server

    doAction: (
        action: RawAction,
        metadata?: TransportMetadata,
    ) => ReadableStream<RawActionResult>

    DoAction - Execute an action

    doExchange: (
        metadata?: TransportMetadata,
    ) => DuplexStream<RawFlightData, RawFlightData>

    DoExchange - Bidirectional data exchange

    doGet: (
        ticket: RawTicket,
        metadata?: TransportMetadata,
    ) => ReadableStream<RawFlightData>

    DoGet - Retrieve data for a ticket

    doPut: (
        metadata?: TransportMetadata,
    ) => DuplexStream<RawFlightData, RawPutResult>

    DoPut - Upload data

    getFlightInfo: (
        descriptor: { cmd?: Uint8Array; path?: string[]; type: number },
        metadata?: TransportMetadata,
    ) => Promise<RawFlightInfo>

    GetFlightInfo - Get metadata about a flight

    getSchema: (
        descriptor: { cmd?: Uint8Array; path?: string[]; type: number },
        metadata?: TransportMetadata,
    ) => Promise<{ schema: Uint8Array }>

    GetSchema - Get schema for a flight descriptor

    handshake: (
        metadata?: TransportMetadata,
    ) => DuplexStream<RawHandshakeMessage, RawHandshakeMessage>

    Handshake - Authentication handshake

    isConnected: () => boolean

    Check if connected

    listActions: (metadata?: TransportMetadata) => ReadableStream<RawActionType>

    ListActions - List available actions

    listFlights: (
        criteria?: Uint8Array,
        metadata?: TransportMetadata,
    ) => ReadableStream<RawFlightInfo>

    ListFlights - List available flights

    setAuthToken: (token: string | null) => void

    Set authentication token for subsequent requests

    Settings

    Member Visibility

    On This Page

    Properties