Class FlightClient

Namespace

Apache.Arrow.Flight.Client

Assembly

Apache.Arrow.Flight.dll

public class FlightClient

Inheritance

object

FlightClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FlightClient(CallInvoker)

public FlightClient(CallInvoker callInvoker)

Parameters

callInvoker CallInvoker

FlightClient(ChannelBase)

public FlightClient(ChannelBase grpcChannel)

Parameters

grpcChannel ChannelBase

Methods

DoAction(FlightAction, Metadata)

public AsyncServerStreamingCall<FlightResult> DoAction(FlightAction action, Metadata headers = null)

Parameters

action FlightAction

headers Metadata

Returns

AsyncServerStreamingCall<FlightResult>

DoAction(FlightAction, Metadata, DateTime?, CancellationToken)

public AsyncServerStreamingCall<FlightResult> DoAction(FlightAction action, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

action FlightAction

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

AsyncServerStreamingCall<FlightResult>

DoExchange(FlightDescriptor, Metadata)

public FlightRecordBatchExchangeCall DoExchange(FlightDescriptor flightDescriptor, Metadata headers = null)

Parameters

flightDescriptor FlightDescriptor

headers Metadata

Returns

FlightRecordBatchExchangeCall

DoExchange(FlightDescriptor, Metadata, DateTime?, CancellationToken)

public FlightRecordBatchExchangeCall DoExchange(FlightDescriptor flightDescriptor, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

flightDescriptor FlightDescriptor

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

FlightRecordBatchExchangeCall

GetInfo(FlightDescriptor, Metadata)

public AsyncUnaryCall<FlightInfo> GetInfo(FlightDescriptor flightDescriptor, Metadata headers = null)

Parameters

flightDescriptor FlightDescriptor

headers Metadata

Returns

AsyncUnaryCall<FlightInfo>

GetInfo(FlightDescriptor, Metadata, DateTime?, CancellationToken)

public AsyncUnaryCall<FlightInfo> GetInfo(FlightDescriptor flightDescriptor, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

flightDescriptor FlightDescriptor

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

AsyncUnaryCall<FlightInfo>

GetSchema(FlightDescriptor, Metadata)

public AsyncUnaryCall<Schema> GetSchema(FlightDescriptor flightDescriptor, Metadata headers = null)

Parameters

flightDescriptor FlightDescriptor

headers Metadata

Returns

AsyncUnaryCall<Schema>

GetSchema(FlightDescriptor, Metadata, DateTime?, CancellationToken)

public AsyncUnaryCall<Schema> GetSchema(FlightDescriptor flightDescriptor, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

flightDescriptor FlightDescriptor

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

AsyncUnaryCall<Schema>

GetStream(FlightTicket, Metadata)

public FlightRecordBatchStreamingCall GetStream(FlightTicket ticket, Metadata headers = null)

Parameters

ticket FlightTicket

headers Metadata

Returns

FlightRecordBatchStreamingCall

GetStream(FlightTicket, Metadata, DateTime?, CancellationToken)

public FlightRecordBatchStreamingCall GetStream(FlightTicket ticket, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

ticket FlightTicket

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

FlightRecordBatchStreamingCall

Handshake(Metadata)

public AsyncDuplexStreamingCall<FlightHandshakeRequest, FlightHandshakeResponse> Handshake(Metadata headers = null)

Parameters

headers Metadata

Returns

AsyncDuplexStreamingCall<FlightHandshakeRequest, FlightHandshakeResponse>

Handshake(Metadata, DateTime?, CancellationToken)

public AsyncDuplexStreamingCall<FlightHandshakeRequest, FlightHandshakeResponse> Handshake(Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

AsyncDuplexStreamingCall<FlightHandshakeRequest, FlightHandshakeResponse>

ListActions(Metadata)

public AsyncServerStreamingCall<FlightActionType> ListActions(Metadata headers = null)

Parameters

headers Metadata

Returns

AsyncServerStreamingCall<FlightActionType>

ListActions(Metadata, DateTime?, CancellationToken)

public AsyncServerStreamingCall<FlightActionType> ListActions(Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

AsyncServerStreamingCall<FlightActionType>

ListFlights(FlightCriteria, Metadata)

public AsyncServerStreamingCall<FlightInfo> ListFlights(FlightCriteria criteria = null, Metadata headers = null)

Parameters

criteria FlightCriteria

headers Metadata

Returns

AsyncServerStreamingCall<FlightInfo>

ListFlights(FlightCriteria, Metadata, DateTime?, CancellationToken)

public AsyncServerStreamingCall<FlightInfo> ListFlights(FlightCriteria criteria, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

criteria FlightCriteria

headers Metadata

deadline DateTime?

cancellationToken CancellationToken

Returns

AsyncServerStreamingCall<FlightInfo>

StartPut(FlightDescriptor, Schema, Metadata)

Start a Flight Put request.

public Task<FlightRecordBatchDuplexStreamingCall> StartPut(FlightDescriptor flightDescriptor, Schema schema, Metadata headers = null)

Parameters

flightDescriptor FlightDescriptor

Descriptor for the data to be put

schema Schema

The schema of the data

headers Metadata

gRPC headers to send with the request

Returns

Task<FlightRecordBatchDuplexStreamingCall>

A FlightRecordBatchDuplexStreamingCall object used to write data batches and receive responses

Remarks

Using this method rather than a StartPut overload that doesn't accept a schema means that the schema is sent even if no data batches are sent

StartPut(FlightDescriptor, Schema, Metadata, DateTime?, CancellationToken)

Start a Flight Put request.

public Task<FlightRecordBatchDuplexStreamingCall> StartPut(FlightDescriptor flightDescriptor, Schema schema, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

flightDescriptor FlightDescriptor

Descriptor for the data to be put

schema Schema

The schema of the data

headers Metadata

gRPC headers to send with the request

deadline DateTime?

Optional deadline. The request will be cancelled if this deadline is reached.

cancellationToken CancellationToken

Optional token for cancelling the request

Returns

Task<FlightRecordBatchDuplexStreamingCall>

A FlightRecordBatchDuplexStreamingCall object used to write data batches and receive responses

Remarks

Using this method rather than a StartPut overload that doesn't accept a schema means that the schema is sent even if no data batches are sent

StartPut(FlightDescriptor, Metadata)

Start a Flight Put request.

public FlightRecordBatchDuplexStreamingCall StartPut(FlightDescriptor flightDescriptor, Metadata headers = null)

Parameters

flightDescriptor FlightDescriptor

Descriptor for the data to be put

headers Metadata

gRPC headers to send with the request

Returns

FlightRecordBatchDuplexStreamingCall

A FlightRecordBatchDuplexStreamingCall object used to write data batches and receive responses

StartPut(FlightDescriptor, Metadata, DateTime?, CancellationToken)

Start a Flight Put request.

public FlightRecordBatchDuplexStreamingCall StartPut(FlightDescriptor flightDescriptor, Metadata headers, DateTime? deadline, CancellationToken cancellationToken = default)

Parameters

flightDescriptor FlightDescriptor

Descriptor for the data to be put

headers Metadata

gRPC headers to send with the request

deadline DateTime?

Optional deadline. The request will be cancelled if this deadline is reached.

cancellationToken CancellationToken

Optional token for cancelling the request

Returns

FlightRecordBatchDuplexStreamingCall

A FlightRecordBatchDuplexStreamingCall object used to write data batches and receive responses