Interface FlightData

A batch of Arrow data as part of a stream of batches.

Generated

from protobuf message arrow.flight.protocol.FlightData

interface FlightData {
    appMetadata: Uint8Array;
    dataBody: Uint8Array;
    dataHeader: Uint8Array;
    flightDescriptor?: FlightDescriptor;
}

Properties

appMetadata dataBody dataHeader flightDescriptor?

Properties

appMetadata

appMetadata: Uint8Array

Application-defined metadata.

Generated

from protobuf field: bytes app_metadata = 3;

dataBody

dataBody: Uint8Array

The actual batch of Arrow data. Preferably handled with minimal-copies coming last in the definition to help with sidecar patterns (it is expected that some implementations will fetch this field off the wire with specialized code to avoid extra memory copies).

Generated

from protobuf field: bytes data_body = 1000;

dataHeader

dataHeader: Uint8Array

Header for message data as described in Message.fbs::Message.

Generated

from protobuf field: bytes data_header = 2;

OptionalflightDescriptor

flightDescriptor?: FlightDescriptor

The descriptor of the data. This is only relevant when a client is starting a new DoPut stream.

Generated

from protobuf field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 1;

Settings

Member Visibility

On This Page

Properties