Class GrpcJsTransport

Transport implementation using @grpc/grpc-js. Works with Node.js and Bun runtimes.

Implements

FlightTransport

Index

Constructors

Methods

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

Constructors

constructor

new GrpcJsTransport(options: TransportOptions): GrpcJsTransport
Parameters
- options: TransportOptions
Returns GrpcJsTransport
- Defined in transport-grpc-js.ts:108

Methods

close

close(): void
Close the connection

Returns void
Implementation of FlightTransport.close
- Defined in transport-grpc-js.ts:149

connect

connect(): Promise<void>
Connect to the Flight SQL server

Returns Promise<void>
Implementation of FlightTransport.connect
- Defined in transport-grpc-js.ts:117

doAction

doAction(
action: RawAction,
metadata?: TransportMetadata,
): ReadableStream<RawActionResult>
DoAction - Execute an action
Parameters
- action: RawAction
- Optionalmetadata: TransportMetadata
Returns ReadableStream<RawActionResult>
Implementation of FlightTransport.doAction
- Defined in transport-grpc-js.ts:244

doExchange

doExchange(
metadata?: TransportMetadata,
): DuplexStream<RawFlightData, RawFlightData>
DoExchange - Bidirectional data exchange
Parameters
- Optionalmetadata: TransportMetadata
Returns DuplexStream<RawFlightData, RawFlightData>
Implementation of FlightTransport.doExchange
- Defined in transport-grpc-js.ts:300

doGet

doGet(
ticket: RawTicket,
metadata?: TransportMetadata,
): ReadableStream<RawFlightData>
DoGet - Retrieve data for a ticket
Parameters
- ticket: RawTicket
- Optionalmetadata: TransportMetadata
Returns ReadableStream<RawFlightData>
Implementation of FlightTransport.doGet
- Defined in transport-grpc-js.ts:231

doPut

doPut(metadata?: TransportMetadata): DuplexStream<RawFlightData, RawPutResult>
DoPut - Upload data
Parameters
- Optionalmetadata: TransportMetadata
Returns DuplexStream<RawFlightData, RawPutResult>
Implementation of FlightTransport.doPut
- Defined in transport-grpc-js.ts:287

getFlightInfo

getFlightInfo(
    descriptor: {
        cmd?: Uint8Array<ArrayBufferLike>;
        path?: string[];
        type: number;
    },
    metadata?: TransportMetadata,
): Promise<RawFlightInfo>
GetFlightInfo - Get metadata about a flight
Parameters
- descriptor: { cmd?: Uint8Array<ArrayBufferLike>; path?: string[]; type: number }
- Optionalmetadata: TransportMetadata
Returns Promise<RawFlightInfo>
Implementation of FlightTransport.getFlightInfo
- Defined in transport-grpc-js.ts:171

getSchema

getSchema(
    descriptor: {
        cmd?: Uint8Array<ArrayBufferLike>;
        path?: string[];
        type: number;
    },
    metadata?: TransportMetadata,
): Promise<{ schema: Uint8Array }>
GetSchema - Get schema for a flight descriptor
Parameters
- descriptor: { cmd?: Uint8Array<ArrayBufferLike>; path?: string[]; type: number }
- Optionalmetadata: TransportMetadata
Returns Promise<{ schema: Uint8Array }>
Implementation of FlightTransport.getSchema
- Defined in transport-grpc-js.ts:199

handshake

handshake(
metadata?: TransportMetadata,
): DuplexStream<RawHandshakeMessage, RawHandshakeMessage>
Handshake - Authentication handshake
Parameters
- Optionalmetadata: TransportMetadata
Returns DuplexStream<RawHandshakeMessage, RawHandshakeMessage>
Implementation of FlightTransport.handshake
- Defined in transport-grpc-js.ts:313

isConnected

isConnected(): boolean
Check if connected

Returns boolean
Implementation of FlightTransport.isConnected
- Defined in transport-grpc-js.ts:159

listActions

listActions(metadata?: TransportMetadata): ReadableStream<RawActionType>
ListActions - List available actions
Parameters
- Optionalmetadata: TransportMetadata
Returns ReadableStream<RawActionType>
Implementation of FlightTransport.listActions
- Defined in transport-grpc-js.ts:257

listFlights

listFlights(
criteria?: Uint8Array<ArrayBufferLike>,
metadata?: TransportMetadata,
): ReadableStream<RawFlightInfo>
ListFlights - List available flights
Parameters
- Optionalcriteria: Uint8Array<ArrayBufferLike>
- Optionalmetadata: TransportMetadata
Returns ReadableStream<RawFlightInfo>
Implementation of FlightTransport.listFlights
- Defined in transport-grpc-js.ts:270

setAuthToken

setAuthToken(token: string | null): void
Set authentication token for subsequent requests
Parameters
- token: string | null
Returns void
Implementation of FlightTransport.setAuthToken
- Defined in transport-grpc-js.ts:163

Class GrpcJsTransport

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GrpcJsTransport

Methods

close

Returns void

connect

Returns Promise<void>

doAction

Parameters

Returns ReadableStream<RawActionResult>

doExchange

Parameters

Returns DuplexStream<RawFlightData, RawFlightData>

doGet

Parameters

Returns ReadableStream<RawFlightData>

doPut

Parameters

Returns DuplexStream<RawFlightData, RawPutResult>

getFlightInfo

Parameters

Returns Promise<RawFlightInfo>

getSchema

Parameters

Returns Promise<{ schema: Uint8Array }>

handshake

Parameters

Returns DuplexStream<RawHandshakeMessage, RawHandshakeMessage>

isConnected

Returns boolean

listActions

Parameters

Returns ReadableStream<RawActionType>

listFlights

Parameters

Returns ReadableStream<RawFlightInfo>

setAuthToken

Parameters

Returns void

Settings

On This Page