FlightSqlProducer (Apache Arrow Java Root POM 16.1.0 API)

All Superinterfaces:

AutoCloseable, FlightProducer

All Known Implementing Classes:

BasicFlightSqlProducer, FlightSqlScenarioProducer, NoOpFlightSqlProducer
```
public interface FlightSqlProducer
extends FlightProducer, AutoCloseable
```
API to Implement an Arrow Flight SQL producer.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class FlightSqlProducer.Schemas
Default schema templates for the FlightSqlProducer.
- Nested classes/interfaces inherited from interface org.apache.arrow.flight.FlightProducer
  FlightProducer.CallContext, FlightProducer.ServerStreamListener, FlightProducer.StreamListener<T>

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FlightSqlProducer.Schemas` Default schema templates for the `FlightSqlProducer`.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default Runnable`	`acceptPut(FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)` Depending on the provided command, method either: 1.
`Runnable`	`acceptPutPreparedStatementQuery(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)` Accepts uploaded parameter values for a particular prepared statement query.
`Runnable`	`acceptPutPreparedStatementUpdate(FlightSql.CommandPreparedStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)` Accepts uploaded data for a particular prepared statement data stream.
`Runnable`	`acceptPutStatement(FlightSql.CommandStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)` Accepts uploaded data for a particular SQL query based data stream.
`default Runnable`	`acceptPutSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream)` Handle a Substrait plan with uploaded data.
`default void`	`beginSavepoint(FlightSql.ActionBeginSavepointRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightSql.ActionBeginSavepointResult> listener)` Create a savepoint within a transaction.
`default void`	`beginTransaction(FlightSql.ActionBeginTransactionRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightSql.ActionBeginTransactionResult> listener)` Begin a transaction.
`default void`	`cancelFlightInfo(CancelFlightInfoRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<CancelStatus> listener)` Explicitly cancel a query.
`default void`	`cancelQuery(FlightInfo info, FlightProducer.CallContext context, FlightProducer.StreamListener<CancelResult> listener)` Deprecated. Prefer `#cancelFlightInfo(CancelFlightInfoRequest, CallContext, StreamListener)`.
`void`	`closePreparedStatement(FlightSql.ActionClosePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)` Closes a prepared statement on the server.
`default void`	`closeSession(CloseSessionRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<CloseSessionResult> listener)` Close/invalidate the session.
`void`	`createPreparedStatement(FlightSql.ActionCreatePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)` Creates a prepared statement on the server and returns a handle and metadata for in a `FlightSql.ActionCreatePreparedStatementResult` object in a `Result` object.
`default void`	`createPreparedSubstraitPlan(FlightSql.ActionCreatePreparedSubstraitPlanRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightSql.ActionCreatePreparedStatementResult> listener)` Pre-compile a Substrait plan.
`default void`	`doAction(FlightProducer.CallContext context, Action action, FlightProducer.StreamListener<Result> listener)` Performs the requested Flight SQL action.
`default void`	`endSavepoint(FlightSql.ActionEndSavepointRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)` Release or roll back to a savepoint.
`default void`	`endTransaction(FlightSql.ActionEndTransactionRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener)` Commit or roll back to a transaction.
`default FlightInfo`	`getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)` Depending on the provided command, method either: 1.
`FlightInfo`	`getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the available catalogs by returning a stream of `FlightSql.CommandGetCatalogs` objects in `Result` objects.
`FlightInfo`	`getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Retrieve a description of the foreign key columns that reference the given table's primary key columns `FlightSql.CommandGetCrossReference` objects in `Result` objects.
`FlightInfo`	`getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Retrieves a description of the foreign key columns that reference the given table's primary key columns `FlightSql.CommandGetExportedKeys` objects in `Result` objects.
`FlightInfo`	`getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Retrieves a description of the primary key columns that are referenced by given table's foreign key columns `FlightSql.CommandGetImportedKeys` objects in `Result` objects.
`FlightInfo`	`getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)` Gets information about a particular prepared statement data stream.
`FlightInfo`	`getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the available primary keys by returning a stream of `FlightSql.CommandGetPrimaryKeys` objects in `Result` objects.
`FlightInfo`	`getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the available schemas by returning a stream of `FlightSql.CommandGetDbSchemas` objects in `Result` objects.
`FlightInfo`	`getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the SQL Info of the server by returning a `FlightSql.CommandGetSqlInfo` in a `Result`.
`FlightInfo`	`getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)` Evaluate a SQL query.
`default FlightInfo`	`getFlightInfoSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)` Evaluate a Substrait plan.
`FlightInfo`	`getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the available tables by returning a stream of `FlightSql.CommandGetTables` objects in `Result` objects.
`FlightInfo`	`getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the available table types by returning a stream of `FlightSql.CommandGetTableTypes` objects in `Result` objects.
`FlightInfo`	`getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns a description of all the data types supported by source.
`default SchemaResult`	`getSchema(FlightProducer.CallContext context, FlightDescriptor descriptor)` Returns the schema of the result produced by the SQL query.
`default SchemaResult`	`getSchemaPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)` Get the schema of the result set of a prepared statement.
`SchemaResult`	`getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)` Get the result schema for a SQL query.
`default SchemaResult`	`getSchemaSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)` Get the result schema for a Substrait plan.
`default void`	`getSessionOptions(GetSessionOptionsRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<GetSessionOptionsResult> listener)` Get server session option(s).
`default void`	`getStream(FlightProducer.CallContext context, Ticket ticket, FlightProducer.ServerStreamListener listener)` Depending on the provided command, method either: 1.
`void`	`getStreamCatalogs(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for catalogs based data stream.
`void`	`getStreamCrossReference(FlightSql.CommandGetCrossReference command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for cross reference based data stream.
`void`	`getStreamExportedKeys(FlightSql.CommandGetExportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for foreign keys based data stream.
`void`	`getStreamImportedKeys(FlightSql.CommandGetImportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for foreign keys based data stream.
`void`	`getStreamPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for a particular prepared statement query instance.
`void`	`getStreamPrimaryKeys(FlightSql.CommandGetPrimaryKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for primary keys based data stream.
`void`	`getStreamSchemas(FlightSql.CommandGetDbSchemas command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for schemas based data stream.
`void`	`getStreamSqlInfo(FlightSql.CommandGetSqlInfo command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for SQL info based data stream.
`void`	`getStreamStatement(FlightSql.TicketStatementQuery ticket, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for a SQL query based data stream.
`void`	`getStreamTables(FlightSql.CommandGetTables command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for tables based data stream.
`void`	`getStreamTableTypes(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for table types based data stream.
`void`	`getStreamTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener)` Returns data for type info based data stream.
`default void`	`listActions(FlightProducer.CallContext context, FlightProducer.StreamListener<ActionType> listener)` Lists all available Flight SQL actions.
`default void`	`renewFlightEndpoint(RenewFlightEndpointRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<FlightEndpoint> listener)` Renew the duration of the given endpoint.
`default void`	`setSessionOptions(SetSessionOptionsRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<SetSessionOptionsResult> listener)` Set server session options(s).

Methods inherited from interface org.apache.arrow.flight.FlightProducer
doExchange, listFlights, pollFlightInfo

Methods inherited from interface java.lang.AutoCloseable
close

Method Detail

getFlightInfo
```
default FlightInfo getFlightInfo(FlightProducer.CallContext context,
                                 FlightDescriptor descriptor)
```
Depending on the provided command, method either: 1. Return information about a SQL query, or 2. Return information about a prepared statement. In this case, parameters binding is allowed.

Specified by:

getFlightInfo in interface FlightProducer

Parameters:

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

information about the given SQL query, or the given prepared statement.

getSchema
```
default SchemaResult getSchema(FlightProducer.CallContext context,
                               FlightDescriptor descriptor)
```
Returns the schema of the result produced by the SQL query.

Specified by:

getSchema in interface FlightProducer

Parameters:

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

the result set schema.

getStream
```
default void getStream(FlightProducer.CallContext context,
                       Ticket ticket,
                       FlightProducer.ServerStreamListener listener)
```
Depending on the provided command, method either: 1. Return data for a stream produced by executing the provided SQL query, or 2. Return data for a prepared statement. In this case, parameters binding is allowed.

Specified by:

getStream in interface FlightProducer

Parameters:

context - Per-call context.

ticket - The application-defined ticket identifying this stream.

listener - An interface for sending data back to the client.

acceptPut
```
default Runnable acceptPut(FlightProducer.CallContext context,
                           FlightStream flightStream,
                           FlightProducer.StreamListener<PutResult> ackStream)
```
Depending on the provided command, method either: 1. Execute provided SQL query as an update statement, or 2. Execute provided update SQL query prepared statement. In this case, parameters binding is allowed, or 3. Binds parameters to the provided prepared statement.

Specified by:

acceptPut in interface FlightProducer

Parameters:

context - Per-call context.

flightStream - The data stream being uploaded.

ackStream - The data stream listener for update result acknowledgement.

Returns:

a Runnable to process the stream.

listActions
```
default void listActions(FlightProducer.CallContext context,
                         FlightProducer.StreamListener<ActionType> listener)
```
Lists all available Flight SQL actions.

Specified by:

listActions in interface FlightProducer

Parameters:

context - Per-call context.

listener - An interface for sending data back to the client.

doAction

default void doAction(FlightProducer.CallContext context,
                      Action action,
                      FlightProducer.StreamListener<Result> listener)

Performs the requested Flight SQL action.

Specified by:: doAction in interface FlightProducer
Parameters:: context - Per-call context.; action - Client-supplied parameters.; listener - A stream of responses.

beginSavepoint

default void beginSavepoint(FlightSql.ActionBeginSavepointRequest request,
                            FlightProducer.CallContext context,
                            FlightProducer.StreamListener<FlightSql.ActionBeginSavepointResult> listener)

Create a savepoint within a transaction.

Parameters:: request - The savepoint request.; context - Per-call context.; listener - The newly created savepoint ID.

beginTransaction

default void beginTransaction(FlightSql.ActionBeginTransactionRequest request,
                              FlightProducer.CallContext context,
                              FlightProducer.StreamListener<FlightSql.ActionBeginTransactionResult> listener)

Begin a transaction.

Parameters:: request - The transaction request.; context - Per-call context.; listener - The newly created transaction ID.

cancelFlightInfo

default void cancelFlightInfo(CancelFlightInfoRequest request,
                              FlightProducer.CallContext context,
                              FlightProducer.StreamListener<CancelStatus> listener)

Explicitly cancel a query.

Parameters:: request - The CancelFlightInfoRequest for the query to cancel.; context - Per-call context.; listener - An interface for sending data back to the client.

cancelQuery

@Deprecated
default void cancelQuery(FlightInfo info,
                                     FlightProducer.CallContext context,
                                     FlightProducer.StreamListener<CancelResult> listener)

Deprecated. Prefer #cancelFlightInfo(CancelFlightInfoRequest, CallContext, StreamListener).

Explicitly cancel a query.

Parameters:: info - The FlightInfo of the query to cancel.; context - Per-call context.; listener - Whether cancellation succeeded.

setSessionOptions

default void setSessionOptions(SetSessionOptionsRequest request,
                               FlightProducer.CallContext context,
                               FlightProducer.StreamListener<SetSessionOptionsResult> listener)

Set server session options(s).

Parameters:: request - The session options to set. For *DBC driver compatibility, servers should support converting values from strings.; context - Per-call context.; listener - An interface for sending data back to the client.

getSessionOptions

default void getSessionOptions(GetSessionOptionsRequest request,
                               FlightProducer.CallContext context,
                               FlightProducer.StreamListener<GetSessionOptionsResult> listener)

Get server session option(s).

Parameters:: request - The (empty) GetSessionOptionsRequest.; context - Per-call context.; listener - An interface for sending data back to the client.

closeSession

default void closeSession(CloseSessionRequest request,
                          FlightProducer.CallContext context,
                          FlightProducer.StreamListener<CloseSessionResult> listener)

Close/invalidate the session.

Parameters:: request - The (empty) CloseSessionRequest.; context - Per-call context.; listener - An interface for sending data back to the client.

createPreparedStatement
```
void createPreparedStatement(FlightSql.ActionCreatePreparedStatementRequest request,
                             FlightProducer.CallContext context,
                             FlightProducer.StreamListener<Result> listener)
```
Creates a prepared statement on the server and returns a handle and metadata for in a FlightSql.ActionCreatePreparedStatementResult object in a Result object.

Parameters:

request - The sql command to generate the prepared statement.

context - Per-call context.

listener - A stream of responses.

createPreparedSubstraitPlan

default void createPreparedSubstraitPlan(FlightSql.ActionCreatePreparedSubstraitPlanRequest request,
                                         FlightProducer.CallContext context,
                                         FlightProducer.StreamListener<FlightSql.ActionCreatePreparedStatementResult> listener)

Pre-compile a Substrait plan.

Parameters:: request - The plan.; context - Per-call context.; listener - The resulting prepared statement.

closePreparedStatement

void closePreparedStatement(FlightSql.ActionClosePreparedStatementRequest request,
                            FlightProducer.CallContext context,
                            FlightProducer.StreamListener<Result> listener)

Closes a prepared statement on the server. No result is expected.

Parameters:: request - The sql command to generate the prepared statement.; context - Per-call context.; listener - A stream of responses.

endSavepoint

default void endSavepoint(FlightSql.ActionEndSavepointRequest request,
                          FlightProducer.CallContext context,
                          FlightProducer.StreamListener<Result> listener)

Release or roll back to a savepoint.

Parameters:: 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.

endTransaction

default void endTransaction(FlightSql.ActionEndTransactionRequest request,
                            FlightProducer.CallContext context,
                            FlightProducer.StreamListener<Result> listener)

Commit or roll back to a transaction.

Parameters:: 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.

getFlightInfoStatement

FlightInfo getFlightInfoStatement(FlightSql.CommandStatementQuery command,
                                  FlightProducer.CallContext context,
                                  FlightDescriptor descriptor)

Evaluate a SQL query.

Parameters:: command - The SQL query.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getFlightInfoSubstraitPlan

default FlightInfo getFlightInfoSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command,
                                              FlightProducer.CallContext context,
                                              FlightDescriptor descriptor)

Evaluate a Substrait plan.

Parameters:: command - The Substrait plan.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getFlightInfoPreparedStatement

FlightInfo getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command,
                                          FlightProducer.CallContext context,
                                          FlightDescriptor descriptor)

Gets information about a particular prepared statement data stream.

Parameters:: command - The prepared statement to generate the data stream.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getSchemaStatement

SchemaResult getSchemaStatement(FlightSql.CommandStatementQuery command,
                                FlightProducer.CallContext context,
                                FlightDescriptor descriptor)

Get the result schema for a SQL query.

Parameters:: command - The SQL query.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: the schema of the result set.

getSchemaPreparedStatement

default SchemaResult getSchemaPreparedStatement(FlightSql.CommandPreparedStatementQuery command,
                                                FlightProducer.CallContext context,
                                                FlightDescriptor descriptor)

Get the schema of the result set of a prepared statement.

Parameters:: command - The prepared statement handle.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: the schema of the result set.

getSchemaSubstraitPlan

default SchemaResult getSchemaSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command,
                                            FlightProducer.CallContext context,
                                            FlightDescriptor descriptor)

Get the result schema for a Substrait plan.

Parameters:: command - The Substrait plan.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Schema for the stream.

getStreamStatement

void getStreamStatement(FlightSql.TicketStatementQuery ticket,
                        FlightProducer.CallContext context,
                        FlightProducer.ServerStreamListener listener)

Returns data for a SQL query based data stream.

Parameters:: ticket - Ticket message containing the statement handle.; context - Per-call context.; listener - An interface for sending data back to the client.

getStreamPreparedStatement

void getStreamPreparedStatement(FlightSql.CommandPreparedStatementQuery command,
                                FlightProducer.CallContext context,
                                FlightProducer.ServerStreamListener listener)

Returns data for a particular prepared statement query instance.

Parameters:: command - The prepared statement to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

acceptPutStatement

Runnable acceptPutStatement(FlightSql.CommandStatementUpdate command,
                            FlightProducer.CallContext context,
                            FlightStream flightStream,
                            FlightProducer.StreamListener<PutResult> ackStream)

Accepts uploaded data for a particular SQL query based data stream.

`PutResult`s must be in the form of a FlightSql.DoPutUpdateResult.

Parameters:: command - The sql command to generate the data stream.; context - Per-call context.; flightStream - The data stream being uploaded.; ackStream - The result data stream.
Returns:: A runnable to process the stream.

acceptPutSubstraitPlan

default Runnable acceptPutSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command,
                                        FlightProducer.CallContext context,
                                        FlightStream flightStream,
                                        FlightProducer.StreamListener<PutResult> ackStream)

Handle a Substrait plan with uploaded data.

Parameters:: command - The Substrait plan to evaluate.; context - Per-call context.; flightStream - The data stream being uploaded.; ackStream - The result data stream.
Returns:: A runnable to process the stream.

acceptPutPreparedStatementUpdate

Runnable acceptPutPreparedStatementUpdate(FlightSql.CommandPreparedStatementUpdate command,
                                          FlightProducer.CallContext context,
                                          FlightStream flightStream,
                                          FlightProducer.StreamListener<PutResult> ackStream)

Accepts uploaded data for a particular prepared statement data stream.

`PutResult`s must be in the form of a FlightSql.DoPutUpdateResult.

Parameters:: command - The prepared statement to generate the data stream.; context - Per-call context.; flightStream - The data stream being uploaded.; ackStream - The result data stream.
Returns:: A runnable to process the stream.

acceptPutPreparedStatementQuery

Runnable acceptPutPreparedStatementQuery(FlightSql.CommandPreparedStatementQuery command,
                                         FlightProducer.CallContext context,
                                         FlightStream flightStream,
                                         FlightProducer.StreamListener<PutResult> ackStream)

Accepts uploaded parameter values for a particular prepared statement query.

Parameters:: 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.
Returns:: A runnable to process the stream.

getFlightInfoSqlInfo

FlightInfo getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request,
                                FlightProducer.CallContext context,
                                FlightDescriptor descriptor)

Returns the SQL Info of the server by returning a FlightSql.CommandGetSqlInfo in a Result.

Parameters:: request - request filter parameters.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getStreamSqlInfo

void getStreamSqlInfo(FlightSql.CommandGetSqlInfo command,
                      FlightProducer.CallContext context,
                      FlightProducer.ServerStreamListener listener)

Returns data for SQL info based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoTypeInfo

FlightInfo getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request,
                                 FlightProducer.CallContext context,
                                 FlightDescriptor descriptor)

Returns a description of all the data types supported by source.

Parameters:: request - request filter parameters.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getStreamTypeInfo

void getStreamTypeInfo(FlightSql.CommandGetXdbcTypeInfo request,
                       FlightProducer.CallContext context,
                       FlightProducer.ServerStreamListener listener)

Returns data for type info based data stream.

Parameters:: context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoCatalogs
```
FlightInfo getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request,
                                 FlightProducer.CallContext context,
                                 FlightDescriptor descriptor)
```
Returns the available catalogs by returning a stream of FlightSql.CommandGetCatalogs objects in Result objects.

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getStreamCatalogs

void getStreamCatalogs(FlightProducer.CallContext context,
                       FlightProducer.ServerStreamListener listener)

Returns data for catalogs based data stream.

Parameters:: context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoSchemas
```
FlightInfo getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request,
                                FlightProducer.CallContext context,
                                FlightDescriptor descriptor)
```
Returns the available schemas by returning a stream of FlightSql.CommandGetDbSchemas objects in Result objects.

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getStreamSchemas

void getStreamSchemas(FlightSql.CommandGetDbSchemas command,
                      FlightProducer.CallContext context,
                      FlightProducer.ServerStreamListener listener)

Returns data for schemas based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoTables
```
FlightInfo getFlightInfoTables(FlightSql.CommandGetTables request,
                               FlightProducer.CallContext context,
                               FlightDescriptor descriptor)
```
Returns the available tables by returning a stream of FlightSql.CommandGetTables objects in Result objects.

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getStreamTables

void getStreamTables(FlightSql.CommandGetTables command,
                     FlightProducer.CallContext context,
                     FlightProducer.ServerStreamListener listener)

Returns data for tables based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoTableTypes

FlightInfo getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request,
                                   FlightProducer.CallContext context,
                                   FlightDescriptor descriptor)

Returns the available table types by returning a stream of FlightSql.CommandGetTableTypes objects in Result objects.

Parameters:: context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getStreamTableTypes

void getStreamTableTypes(FlightProducer.CallContext context,
                         FlightProducer.ServerStreamListener listener)

Returns data for table types based data stream.

Parameters:: context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoPrimaryKeys

FlightInfo getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request,
                                    FlightProducer.CallContext context,
                                    FlightDescriptor descriptor)

Returns the available primary keys by returning a stream of FlightSql.CommandGetPrimaryKeys objects in Result objects.

Parameters:: request - request filter parameters.; context - Per-call context.; descriptor - The descriptor identifying the data stream.
Returns:: Metadata about the stream.

getStreamPrimaryKeys

void getStreamPrimaryKeys(FlightSql.CommandGetPrimaryKeys command,
                          FlightProducer.CallContext context,
                          FlightProducer.ServerStreamListener listener)

Returns data for primary keys based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

getFlightInfoExportedKeys
```
FlightInfo getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request,
                                     FlightProducer.CallContext context,
                                     FlightDescriptor descriptor)
```
Retrieves a description of the foreign key columns that reference the given table's primary key columns FlightSql.CommandGetExportedKeys objects in Result objects.

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoImportedKeys
```
FlightInfo getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request,
                                     FlightProducer.CallContext context,
                                     FlightDescriptor descriptor)
```
Retrieves a description of the primary key columns that are referenced by given table's foreign key columns FlightSql.CommandGetImportedKeys objects in Result objects.

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoCrossReference
```
FlightInfo getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request,
                                       FlightProducer.CallContext context,
                                       FlightDescriptor descriptor)
```
Retrieve a description of the foreign key columns that reference the given table's primary key columns FlightSql.CommandGetCrossReference objects in Result objects.

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getStreamExportedKeys

void getStreamExportedKeys(FlightSql.CommandGetExportedKeys command,
                           FlightProducer.CallContext context,
                           FlightProducer.ServerStreamListener listener)

Returns data for foreign keys based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

getStreamImportedKeys

void getStreamImportedKeys(FlightSql.CommandGetImportedKeys command,
                           FlightProducer.CallContext context,
                           FlightProducer.ServerStreamListener listener)

Returns data for foreign keys based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

getStreamCrossReference

void getStreamCrossReference(FlightSql.CommandGetCrossReference command,
                             FlightProducer.CallContext context,
                             FlightProducer.ServerStreamListener listener)

Returns data for cross reference based data stream.

Parameters:: command - The command to generate the data stream.; context - Per-call context.; listener - An interface for sending data back to the client.

renewFlightEndpoint

default void renewFlightEndpoint(RenewFlightEndpointRequest request,
                                 FlightProducer.CallContext context,
                                 FlightProducer.StreamListener<FlightEndpoint> listener)

Renew the duration of the given endpoint.

Parameters:: request - The endpoint to renew.; context - Per-call context.; listener - An interface for sending data back to the client.

Interface FlightSqlProducer

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.arrow.flight.FlightProducer