Package org.apache.arrow.flight.sql

Class BasicFlightSqlProducer

java.lang.Object

org.apache.arrow.flight.sql.NoOpFlightSqlProducer

org.apache.arrow.flight.sql.BasicFlightSqlProducer

All Implemented Interfaces:

AutoCloseable, FlightProducer, FlightSqlProducer

public abstract class BasicFlightSqlProducer
extends NoOpFlightSqlProducer

A FlightSqlProducer that implements getting FlightInfo for each metadata request.

Nested Class Summary

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

FlightProducer.CallContext, FlightProducer.ServerStreamListener, FlightProducer.StreamListener<T>

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

FlightSqlProducer.Schemas

Constructor Summary

Constructors

Constructor	Description
BasicFlightSqlProducer()

Method Summary

Modifier and Type	Method	Description
protected abstract <T extends com.google.protobuf.Message> List<FlightEndpoint>	determineEndpoints(T request, FlightDescriptor flightDescriptor, Schema schema)	Return a list of FlightEndpoints for the given request and FlightDescriptor.
protected <T extends com.google.protobuf.Message> FlightInfo	generateFlightInfo(T request, FlightDescriptor descriptor, Schema schema)
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	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	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.

Methods inherited from class org.apache.arrow.flight.sql.NoOpFlightSqlProducer

acceptPutPreparedStatementQuery, acceptPutPreparedStatementUpdate, acceptPutStatement, close, closePreparedStatement, createPreparedStatement, getFlightInfoPreparedStatement, getFlightInfoStatement, getSchemaStatement, getStreamCatalogs, getStreamCrossReference, getStreamExportedKeys, getStreamImportedKeys, getStreamPreparedStatement, getStreamPrimaryKeys, getStreamSchemas, getStreamSqlInfo, getStreamStatement, getStreamTables, getStreamTableTypes, getStreamTypeInfo, listFlights

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.arrow.flight.FlightProducer

doExchange, pollFlightInfo

Methods inherited from interface org.apache.arrow.flight.sql.FlightSqlProducer

acceptPut, acceptPutSubstraitPlan, beginSavepoint, beginTransaction, cancelFlightInfo, cancelQuery, closeSession, createPreparedSubstraitPlan, doAction, endSavepoint, endTransaction, getFlightInfo, getFlightInfoSubstraitPlan, getSchema, getSchemaPreparedStatement, getSchemaSubstraitPlan, getSessionOptions, getStream, listActions, renewFlightEndpoint, setSessionOptions

Constructor Details

BasicFlightSqlProducer

public BasicFlightSqlProducer()

Method Details

getFlightInfoSqlInfo

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

Description copied from interface: FlightSqlProducer

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

Specified by:

getFlightInfoSqlInfo in interface FlightSqlProducer

Overrides:

getFlightInfoSqlInfo in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoTypeInfo

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

Description copied from interface: FlightSqlProducer

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

Specified by:

getFlightInfoTypeInfo in interface FlightSqlProducer

Overrides:

getFlightInfoTypeInfo in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoCatalogs

public FlightInfo getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request,
 FlightProducer.CallContext context,
 FlightDescriptor descriptor)

Description copied from interface: FlightSqlProducer

Returns the available catalogs by returning a stream of FlightSql.CommandGetCatalogs objects in Result objects.

Specified by:

getFlightInfoCatalogs in interface FlightSqlProducer

Overrides:

getFlightInfoCatalogs in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoSchemas

public FlightInfo getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request,
 FlightProducer.CallContext context,
 FlightDescriptor descriptor)

Description copied from interface: FlightSqlProducer

Returns the available schemas by returning a stream of FlightSql.CommandGetDbSchemas objects in Result objects.

Specified by:

getFlightInfoSchemas in interface FlightSqlProducer

Overrides:

getFlightInfoSchemas in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoTables

public FlightInfo getFlightInfoTables(FlightSql.CommandGetTables request,
 FlightProducer.CallContext context,
 FlightDescriptor descriptor)

Description copied from interface: FlightSqlProducer

Returns the available tables by returning a stream of FlightSql.CommandGetTables objects in Result objects.

Specified by:

getFlightInfoTables in interface FlightSqlProducer

Overrides:

getFlightInfoTables in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoTableTypes

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

Description copied from interface: FlightSqlProducer

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

Specified by:

getFlightInfoTableTypes in interface FlightSqlProducer

Overrides:

getFlightInfoTableTypes in class NoOpFlightSqlProducer

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoPrimaryKeys

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

Description copied from interface: FlightSqlProducer

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

Specified by:

getFlightInfoPrimaryKeys in interface FlightSqlProducer

Overrides:

getFlightInfoPrimaryKeys in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoExportedKeys

public FlightInfo getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request,
 FlightProducer.CallContext context,
 FlightDescriptor descriptor)

Description copied from interface: FlightSqlProducer

Retrieves a description of the foreign key columns that reference the given table's primary key columns FlightSql.CommandGetExportedKeys objects in Result objects.

Specified by:

getFlightInfoExportedKeys in interface FlightSqlProducer

Overrides:

getFlightInfoExportedKeys in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoImportedKeys

public FlightInfo getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request,
 FlightProducer.CallContext context,
 FlightDescriptor descriptor)

Description copied from interface: FlightSqlProducer

Retrieves a description of the primary key columns that are referenced by given table's foreign key columns FlightSql.CommandGetImportedKeys objects in Result objects.

Specified by:

getFlightInfoImportedKeys in interface FlightSqlProducer

Overrides:

getFlightInfoImportedKeys in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

getFlightInfoCrossReference

public FlightInfo getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request,
 FlightProducer.CallContext context,
 FlightDescriptor descriptor)

Description copied from interface: FlightSqlProducer

Retrieve a description of the foreign key columns that reference the given table's primary key columns FlightSql.CommandGetCrossReference objects in Result objects.

Specified by:

getFlightInfoCrossReference in interface FlightSqlProducer

Overrides:

getFlightInfoCrossReference in class NoOpFlightSqlProducer

Parameters:

request - request filter parameters.

context - Per-call context.

descriptor - The descriptor identifying the data stream.

Returns:

Metadata about the stream.

determineEndpoints

protected abstract <T extends com.google.protobuf.Message>
List<FlightEndpoint> determineEndpoints(T request,
 FlightDescriptor flightDescriptor,
 Schema schema)

Return a list of FlightEndpoints for the given request and FlightDescriptor. This method should validate that the request is supported by this FlightSqlProducer.

generateFlightInfo

protected <T extends com.google.protobuf.Message>
FlightInfo generateFlightInfo(T request,
 FlightDescriptor descriptor,
 Schema schema)