public interface FlightSqlProducer extends FlightProducer, AutoCloseable
Modifier and Type | Interface and Description |
---|---|
static class |
FlightSqlProducer.Schemas
Default schema templates for the
FlightSqlProducer . |
FlightProducer.CallContext, FlightProducer.ServerStreamListener, FlightProducer.StreamListener<T>
doExchange, listFlights, pollFlightInfo
close
default FlightInfo getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)
getFlightInfo
in interface FlightProducer
context
- Per-call context.descriptor
- The descriptor identifying the data stream.default SchemaResult getSchema(FlightProducer.CallContext context, FlightDescriptor descriptor)
getSchema
in interface FlightProducer
context
- Per-call context.descriptor
- The descriptor identifying the data stream.default void getStream(FlightProducer.CallContext context, Ticket ticket, FlightProducer.ServerStreamListener listener)
getStream
in interface FlightProducer
context
- Per-call context.ticket
- The application-defined ticket identifying this stream.listener
- An interface for sending data back to the client.default Runnable acceptPut(FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)
acceptPut
in interface FlightProducer
context
- Per-call context.flightStream
- The data stream being uploaded.ackStream
- The data stream listener for update result acknowledgement.default void listActions(FlightProducer.CallContext context, FlightProducer.StreamListener<ActionType> listener)
listActions
in interface FlightProducer
context
- Per-call context.listener
- An interface for sending data back to the client.default void doAction(FlightProducer.CallContext context, Action action, FlightProducer.StreamListener<Result> listener)
doAction
in interface FlightProducer
context
- Per-call context.action
- Client-supplied parameters.listener
- A stream of responses.default void beginSavepoint(FlightSql.ActionBeginSavepointRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightSql.ActionBeginSavepointResult> listener)
request
- The savepoint request.context
- Per-call context.listener
- The newly created savepoint ID.default void beginTransaction(FlightSql.ActionBeginTransactionRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightSql.ActionBeginTransactionResult> listener)
request
- The transaction request.context
- Per-call context.listener
- The newly created transaction ID.default void cancelFlightInfo(CancelFlightInfoRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<CancelStatus> listener)
request
- The CancelFlightInfoRequest for the query to cancel.context
- Per-call context.listener
- An interface for sending data back to the client.@Deprecated default void cancelQuery(FlightInfo info, FlightProducer.CallContext context, FlightProducer.StreamListener<CancelResult> listener)
#cancelFlightInfo(FlightInfo, CallContext, StreamListener)
.info
- The FlightInfo of the query to cancel.context
- Per-call context.listener
- Whether cancellation succeeded.void createPreparedStatement(FlightSql.ActionCreatePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)
FlightSql.ActionCreatePreparedStatementResult
object in a Result
object.request
- The sql command to generate the prepared statement.context
- Per-call context.listener
- A stream of responses.default void createPreparedSubstraitPlan(FlightSql.ActionCreatePreparedSubstraitPlanRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightSql.ActionCreatePreparedStatementResult> listener)
request
- The plan.context
- Per-call context.listener
- The resulting prepared statement.void closePreparedStatement(FlightSql.ActionClosePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)
request
- The sql command to generate the prepared statement.context
- Per-call context.listener
- A stream of responses.default void endSavepoint(FlightSql.ActionEndSavepointRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)
request
- The savepoint, and whether to release/rollback.context
- Per-call context.listener
- Call StreamListener#onCompleted()
or
StreamListener#onError(Throwable)
when done; do not send a result.default void endTransaction(FlightSql.ActionEndTransactionRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)
request
- The transaction, and whether to release/rollback.context
- Per-call context.listener
- Call StreamListener#onCompleted()
or
StreamListener#onError(Throwable)
when done; do not send a result.FlightInfo getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
command
- The SQL query.context
- Per-call context.descriptor
- The descriptor identifying the data stream.default FlightInfo getFlightInfoSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)
command
- The Substrait plan.context
- Per-call context.descriptor
- The descriptor identifying the data stream.FlightInfo getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
command
- The prepared statement to generate the data stream.context
- Per-call context.descriptor
- The descriptor identifying the data stream.SchemaResult getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
command
- The SQL query.context
- Per-call context.descriptor
- The descriptor identifying the data stream.default SchemaResult getSchemaPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
command
- The prepared statement handle.context
- Per-call context.descriptor
- The descriptor identifying the data stream.default SchemaResult getSchemaSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)
command
- The Substrait plan.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamStatement(FlightSql.TicketStatementQuery ticket, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
ticket
- Ticket message containing the statement handle.context
- Per-call context.listener
- An interface for sending data back to the client.void getStreamPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The prepared statement to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.Runnable acceptPutStatement(FlightSql.CommandStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)
`PutResult`s must be in the form of a FlightSql.DoPutUpdateResult
.
command
- The sql command to generate the data stream.context
- Per-call context.flightStream
- The data stream being uploaded.ackStream
- The result data stream.default Runnable acceptPutSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)
command
- The Substrait plan to evaluate.context
- Per-call context.flightStream
- The data stream being uploaded.ackStream
- The result data stream.Runnable acceptPutPreparedStatementUpdate(FlightSql.CommandPreparedStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)
`PutResult`s must be in the form of a FlightSql.DoPutUpdateResult
.
command
- The prepared statement to generate the data stream.context
- Per-call context.flightStream
- The data stream being uploaded.ackStream
- The result data stream.Runnable acceptPutPreparedStatementQuery(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)
command
- The prepared statement the parameter values will bind to.context
- Per-call context.flightStream
- The data stream being uploaded.ackStream
- The result data stream.FlightInfo getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetSqlInfo
in a Result
.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamSqlInfo(FlightSql.CommandGetSqlInfo command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
request
- request filter parameters.descriptor
- The descriptor identifying the data stream.void getStreamTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetCatalogs
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamCatalogs(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetDbSchemas
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamSchemas(FlightSql.CommandGetDbSchemas command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetTables
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamTables(FlightSql.CommandGetTables command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetTableTypes
objects in Result
objects.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamTableTypes(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetPrimaryKeys
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamPrimaryKeys(FlightSql.CommandGetPrimaryKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.FlightInfo getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetExportedKeys
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.FlightInfo getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetImportedKeys
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.FlightInfo getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightSql.CommandGetCrossReference
objects in Result
objects.request
- request filter parameters.context
- Per-call context.descriptor
- The descriptor identifying the data stream.void getStreamExportedKeys(FlightSql.CommandGetExportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.void getStreamImportedKeys(FlightSql.CommandGetImportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.void getStreamCrossReference(FlightSql.CommandGetCrossReference command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)
command
- The command to generate the data stream.context
- Per-call context.listener
- An interface for sending data back to the client.default void renewFlightEndpoint(RenewFlightEndpointRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightEndpoint> listener)
request
- The endpoint to renew.context
- Per-call context.listener
- An interface for sending data back to the client.Copyright © 2023 The Apache Software Foundation. All rights reserved.