Class FlightSqlServer

Namespace

Apache.Arrow.Flight.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

public abstract class FlightSqlServer : FlightServer

Inheritance

object

FlightServer

FlightSqlServer

Inherited Members

FlightServer.ListFlights(FlightCriteria, IAsyncStreamWriter<FlightInfo>, ServerCallContext)

FlightServer.GetSchema(FlightDescriptor, ServerCallContext)

FlightServer.Handshake(IAsyncStreamReader<FlightHandshakeRequest>, IAsyncStreamWriter<FlightHandshakeResponse>, ServerCallContext)

FlightServer.DoExchange(FlightServerRecordBatchStreamReader, FlightServerRecordBatchStreamWriter, ServerCallContext)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FlightSqlServer(ILoggerFactory?)

protected FlightSqlServer(ILoggerFactory? factory = null)

Parameters

factory ILoggerFactory

Fields

CatalogSchema

public static readonly Schema CatalogSchema

Field Value

Schema

DbSchemaFlightSchema

public static readonly Schema DbSchemaFlightSchema

Field Value

Schema

KeyImportExportSchema

public static readonly Schema KeyImportExportSchema

Field Value

Schema

PrimaryKeysSchema

public static readonly Schema PrimaryKeysSchema

Field Value

Schema

SqlInfoSchema

public static readonly Schema SqlInfoSchema

Field Value

Schema

TableTypesSchema

public static readonly Schema TableTypesSchema

Field Value

Schema

TypeInfoSchema

public static readonly Schema TypeInfoSchema

Field Value

Schema

Methods

ClosePreparedStatement(ActionClosePreparedStatementRequest, FlightAction, IAsyncStreamWriter<FlightResult>, ServerCallContext)

protected abstract Task ClosePreparedStatement(ActionClosePreparedStatementRequest request, FlightAction action, IAsyncStreamWriter<FlightResult> streamWriter, ServerCallContext context)

Parameters

request ActionClosePreparedStatementRequest

action FlightAction

streamWriter IAsyncStreamWriter<FlightResult>

context ServerCallContext

Returns

Task

CreatePreparedStatement(ActionCreatePreparedStatementRequest, FlightAction, IAsyncStreamWriter<FlightResult>, ServerCallContext)

protected abstract Task CreatePreparedStatement(ActionCreatePreparedStatementRequest request, FlightAction action, IAsyncStreamWriter<FlightResult> streamWriter, ServerCallContext context)

Parameters

request ActionCreatePreparedStatementRequest

action FlightAction

streamWriter IAsyncStreamWriter<FlightResult>

context ServerCallContext

Returns

Task

DoAction(FlightAction, IAsyncStreamWriter<FlightResult>, ServerCallContext)

Attempts to execute a valid Flight SQL command. For Flight RPC calls implementers should extend this method in order to handle RPC messages.

public override Task DoAction(FlightAction action, IAsyncStreamWriter<FlightResult> responseStream, ServerCallContext context)

Parameters

action FlightAction

responseStream IAsyncStreamWriter<FlightResult>

context ServerCallContext

Returns

Task

DoGet(FlightTicket, FlightServerRecordBatchStreamWriter, ServerCallContext)

Attempts to execute a valid Flight SQL command. For Flight RPC calls implementers should extend this method in order to handle RPC messages.

public override Task DoGet(FlightTicket ticket, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

ticket FlightTicket

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetCatalog(CommandGetCatalogs, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetCatalog(CommandGetCatalogs command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetCatalogs

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetCrossReference(CommandGetCrossReference, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetCrossReference(CommandGetCrossReference command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetCrossReference

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetDbSchema(CommandGetDbSchemas, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetDbSchema(CommandGetDbSchemas command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetDbSchemas

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetExportedKeys(CommandGetExportedKeys, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetExportedKeys(CommandGetExportedKeys command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetExportedKeys

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetImportedKeys(CommandGetImportedKeys, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetImportedKeys(CommandGetImportedKeys command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetImportedKeys

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetPreparedStatementQuery(CommandPreparedStatementQuery, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetPreparedStatementQuery(CommandPreparedStatementQuery preparedStatementQuery, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

preparedStatementQuery CommandPreparedStatementQuery

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetPrimaryKeys(CommandGetPrimaryKeys, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetPrimaryKeys(CommandGetPrimaryKeys command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetPrimaryKeys

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetSqlInfo(CommandGetSqlInfo, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetSqlInfo(CommandGetSqlInfo getSqlInfo, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

getSqlInfo CommandGetSqlInfo

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetTableType(CommandGetTableTypes, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetTableType(CommandGetTableTypes command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetTableTypes

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetTables(CommandGetTables, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetTables(CommandGetTables command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetTables

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoGetXbdcTypeInfo(CommandGetXdbcTypeInfo, FlightServerRecordBatchStreamWriter, ServerCallContext)

protected abstract Task DoGetXbdcTypeInfo(CommandGetXdbcTypeInfo command, FlightServerRecordBatchStreamWriter responseStream, ServerCallContext context)

Parameters

command CommandGetXdbcTypeInfo

responseStream FlightServerRecordBatchStreamWriter

context ServerCallContext

Returns

Task

DoPut(FlightServerRecordBatchStreamReader, IAsyncStreamWriter<FlightPutResult>, ServerCallContext)

Attempts to execute a valid Flight SQL command. For Flight RPC calls implementers should extend this method in order to handle RPC messages.

public override Task DoPut(FlightServerRecordBatchStreamReader requestStream, IAsyncStreamWriter<FlightPutResult> responseStream, ServerCallContext context)

Parameters

requestStream FlightServerRecordBatchStreamReader

responseStream IAsyncStreamWriter<FlightPutResult>

context ServerCallContext

Returns

Task

GetCatalogFlightInfo(CommandGetCatalogs, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetCatalogFlightInfo(CommandGetCatalogs command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetCatalogs

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetCommand(FlightDescriptor?)

public static IMessage? GetCommand(FlightDescriptor? request)

Parameters

request FlightDescriptor

Returns

IMessage

GetCommand(FlightTicket)

public static IMessage? GetCommand(FlightTicket ticket)

Parameters

ticket FlightTicket

Returns

IMessage

GetCommand(FlightServerRecordBatchStreamReader)

public static Task<IMessage?> GetCommand(FlightServerRecordBatchStreamReader requestStream)

Parameters

requestStream FlightServerRecordBatchStreamReader

Returns

Task<IMessage>

GetCrossReferenceFlightInfo(CommandGetCrossReference, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetCrossReferenceFlightInfo(CommandGetCrossReference command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetCrossReference

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetDbSchemaFlightInfo(CommandGetDbSchemas, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetDbSchemaFlightInfo(CommandGetDbSchemas command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetDbSchemas

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetExportedKeysFlightInfo(CommandGetExportedKeys, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetExportedKeysFlightInfo(CommandGetExportedKeys command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetExportedKeys

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetFlightInfo(FlightDescriptor, ServerCallContext)

Attempts to execute a valid Flight SQL command. For Flight RPC calls implementers should extend this method in order to handle RPC messages.

public override Task<FlightInfo> GetFlightInfo(FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetImportedKeysFlightInfo(CommandGetImportedKeys, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetImportedKeysFlightInfo(CommandGetImportedKeys command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetImportedKeys

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetPreparedStatementQueryFlightInfo(CommandPreparedStatementQuery, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetPreparedStatementQueryFlightInfo(CommandPreparedStatementQuery preparedStatementQuery, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

preparedStatementQuery CommandPreparedStatementQuery

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetPrimaryKeysFlightInfo(CommandGetPrimaryKeys, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetPrimaryKeysFlightInfo(CommandGetPrimaryKeys command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetPrimaryKeys

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetSqlFlightInfo(CommandGetSqlInfo, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetSqlFlightInfo(CommandGetSqlInfo commandGetSqlInfo, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

commandGetSqlInfo CommandGetSqlInfo

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetStatementQueryFlightInfo(CommandStatementQuery, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetStatementQueryFlightInfo(CommandStatementQuery commandStatementQuery, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

commandStatementQuery CommandStatementQuery

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetTableSchema(bool)

public static Schema GetTableSchema(bool includeTableSchemaField)

Parameters

includeTableSchemaField bool

Returns

Schema

GetTableTypesFlightInfo(CommandGetTableTypes, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetTableTypesFlightInfo(CommandGetTableTypes command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetTableTypes

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetTablesFlightInfo(CommandGetTables, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetTablesFlightInfo(CommandGetTables command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetTables

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

GetXdbcTypeFlightInfo(CommandGetXdbcTypeInfo, FlightDescriptor, ServerCallContext)

protected abstract Task<FlightInfo> GetXdbcTypeFlightInfo(CommandGetXdbcTypeInfo command, FlightDescriptor flightDescriptor, ServerCallContext context)

Parameters

command CommandGetXdbcTypeInfo

flightDescriptor FlightDescriptor

context ServerCallContext

Returns

Task<FlightInfo>

ListActions(IAsyncStreamWriter<FlightActionType>, ServerCallContext)

Lists actions supported by Flight SQL. For Flight RPC actions support implementers should extend this method to return additional supported actions.

public override Task ListActions(IAsyncStreamWriter<FlightActionType> responseStream, ServerCallContext context)

Parameters

responseStream IAsyncStreamWriter<FlightActionType>

context ServerCallContext

Returns

Task

PutPreparedStatementQuery(CommandPreparedStatementQuery, FlightServerRecordBatchStreamReader, IAsyncStreamWriter<FlightPutResult>, ServerCallContext)

protected abstract Task PutPreparedStatementQuery(CommandPreparedStatementQuery command, FlightServerRecordBatchStreamReader requestStream, IAsyncStreamWriter<FlightPutResult> responseStream, ServerCallContext context)

Parameters

command CommandPreparedStatementQuery

requestStream FlightServerRecordBatchStreamReader

responseStream IAsyncStreamWriter<FlightPutResult>

context ServerCallContext

Returns

Task

PutPreparedStatementUpdate(CommandPreparedStatementUpdate, FlightServerRecordBatchStreamReader, IAsyncStreamWriter<FlightPutResult>, ServerCallContext)

protected abstract Task PutPreparedStatementUpdate(CommandPreparedStatementUpdate command, FlightServerRecordBatchStreamReader requestStream, IAsyncStreamWriter<FlightPutResult> responseStream, ServerCallContext context)

Parameters

command CommandPreparedStatementUpdate

requestStream FlightServerRecordBatchStreamReader

responseStream IAsyncStreamWriter<FlightPutResult>

context ServerCallContext

Returns

Task

PutStatementUpdate(CommandStatementUpdate, FlightServerRecordBatchStreamReader, IAsyncStreamWriter<FlightPutResult>, ServerCallContext)

protected abstract Task PutStatementUpdate(CommandStatementUpdate command, FlightServerRecordBatchStreamReader requestStream, IAsyncStreamWriter<FlightPutResult> responseStream, ServerCallContext context)

Parameters

command CommandStatementUpdate

requestStream FlightServerRecordBatchStreamReader

responseStream IAsyncStreamWriter<FlightPutResult>

context ServerCallContext

Returns

Task

SupportsAction(FlightAction)

public static bool SupportsAction(FlightAction action)

Parameters

action FlightAction

Returns

bool