java.lang.Object
org.apache.arrow.flight.sql.NoOpFlightSqlProducer
- All Implemented Interfaces:
AutoCloseable,FlightProducer,FlightSqlProducer
- Direct Known Subclasses:
BasicFlightSqlProducer
A
FlightSqlProducer that throws on all FlightSql-specific operations.-
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 -
Method Summary
Modifier and TypeMethodDescriptionacceptPutPreparedStatementQuery(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Accepts uploaded parameter values for a particular prepared statement query.acceptPutPreparedStatementUpdate(FlightSql.CommandPreparedStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Accepts uploaded data for a particular prepared statement data stream.acceptPutStatement(FlightSql.CommandStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Accepts uploaded data for a particular SQL query based data stream.acceptPutStatementBulkIngest(FlightSql.CommandStatementIngest command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Accepts uploaded data for a particular bulk ingest data stream.voidclose()voidclosePreparedStatement(FlightSql.ActionClosePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener) Closes a prepared statement on the server.voidcreatePreparedStatement(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 aFlightSql.ActionCreatePreparedStatementResultobject in aResultobject.getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns the available catalogs by returning a stream ofFlightSql.CommandGetCatalogsobjects inResultobjects.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 columnsFlightSql.CommandGetCrossReferenceobjects inResultobjects.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 columnsFlightSql.CommandGetExportedKeysobjects inResultobjects.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 columnsFlightSql.CommandGetImportedKeysobjects inResultobjects.getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor) Gets information about a particular prepared statement data stream.getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns the available primary keys by returning a stream ofFlightSql.CommandGetPrimaryKeysobjects inResultobjects.getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns the available schemas by returning a stream ofFlightSql.CommandGetDbSchemasobjects inResultobjects.getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns the SQL Info of the server by returning aFlightSql.CommandGetSqlInfoin aResult.getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor) Evaluate a SQL query.getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns the available tables by returning a stream ofFlightSql.CommandGetTablesobjects inResultobjects.getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns the available table types by returning a stream ofFlightSql.CommandGetTableTypesobjects inResultobjects.getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor) Returns a description of all the data types supported by source.getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor) Get the result schema for a SQL query.voidgetStreamCatalogs(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for catalogs based data stream.voidgetStreamCrossReference(FlightSql.CommandGetCrossReference command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for cross reference based data stream.voidgetStreamExportedKeys(FlightSql.CommandGetExportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for foreign keys based data stream.voidgetStreamImportedKeys(FlightSql.CommandGetImportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for foreign keys based data stream.voidgetStreamPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for a particular prepared statement query instance.voidgetStreamPrimaryKeys(FlightSql.CommandGetPrimaryKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for primary keys based data stream.voidgetStreamSchemas(FlightSql.CommandGetDbSchemas command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for schemas based data stream.voidgetStreamSqlInfo(FlightSql.CommandGetSqlInfo command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for SQL info based data stream.voidgetStreamStatement(FlightSql.TicketStatementQuery ticket, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for a SQL query based data stream.voidgetStreamTables(FlightSql.CommandGetTables command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for tables based data stream.voidgetStreamTableTypes(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for table types based data stream.voidgetStreamTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Returns data for type info based data stream.voidlistFlights(FlightProducer.CallContext context, Criteria criteria, FlightProducer.StreamListener<FlightInfo> listener) List available data streams on this service.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.arrow.flight.FlightProducer
doExchange, pollFlightInfoMethods 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
-
NoOpFlightSqlProducer
public NoOpFlightSqlProducer()
-
-
Method Details
-
createPreparedStatement
public void createPreparedStatement(FlightSql.ActionCreatePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener) Description copied from interface:FlightSqlProducerCreates a prepared statement on the server and returns a handle and metadata for in aFlightSql.ActionCreatePreparedStatementResultobject in aResultobject.- Specified by:
createPreparedStatementin interfaceFlightSqlProducer- Parameters:
request- The sql command to generate the prepared statement.context- Per-call context.listener- A stream of responses.
-
closePreparedStatement
public void closePreparedStatement(FlightSql.ActionClosePreparedStatementRequest request, FlightProducer.CallContext context, FlightProducer.StreamListener<Result> listener) Description copied from interface:FlightSqlProducerCloses a prepared statement on the server. No result is expected.- Specified by:
closePreparedStatementin interfaceFlightSqlProducer- Parameters:
request- The sql command to generate the prepared statement.context- Per-call context.listener- A stream of responses.
-
getFlightInfoStatement
public FlightInfo getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerEvaluate a SQL query.- Specified by:
getFlightInfoStatementin interfaceFlightSqlProducer- Parameters:
command- The SQL query.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getFlightInfoPreparedStatement
public FlightInfo getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerGets information about a particular prepared statement data stream.- Specified by:
getFlightInfoPreparedStatementin interfaceFlightSqlProducer- 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
public SchemaResult getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerGet the result schema for a SQL query.- Specified by:
getSchemaStatementin interfaceFlightSqlProducer- Parameters:
command- The SQL query.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- the schema of the result set.
-
getStreamStatement
public void getStreamStatement(FlightSql.TicketStatementQuery ticket, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for a SQL query based data stream.- Specified by:
getStreamStatementin interfaceFlightSqlProducer- Parameters:
ticket- Ticket message containing the statement handle.context- Per-call context.listener- An interface for sending data back to the client.
-
getStreamPreparedStatement
public void getStreamPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for a particular prepared statement query instance.- Specified by:
getStreamPreparedStatementin interfaceFlightSqlProducer- 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
public Runnable acceptPutStatement(FlightSql.CommandStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Description copied from interface:FlightSqlProducerAccepts uploaded data for a particular SQL query based data stream.`PutResult`s must be in the form of a
FlightSql.DoPutUpdateResult.- Specified by:
acceptPutStatementin interfaceFlightSqlProducer- 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.
-
acceptPutStatementBulkIngest
public Runnable acceptPutStatementBulkIngest(FlightSql.CommandStatementIngest command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Description copied from interface:FlightSqlProducerAccepts uploaded data for a particular bulk ingest data stream.`PutResult`s must be in the form of a
FlightSql.DoPutUpdateResult.- Specified by:
acceptPutStatementBulkIngestin interfaceFlightSqlProducer- Parameters:
command- The bulk ingestion request.context- Per-call context.flightStream- The data stream being uploaded.ackStream- The result data stream.- Returns:
- A runnable to process the stream.
-
acceptPutPreparedStatementUpdate
public Runnable acceptPutPreparedStatementUpdate(FlightSql.CommandPreparedStatementUpdate command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Description copied from interface:FlightSqlProducerAccepts uploaded data for a particular prepared statement data stream.`PutResult`s must be in the form of a
FlightSql.DoPutUpdateResult.- Specified by:
acceptPutPreparedStatementUpdatein interfaceFlightSqlProducer- 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
public Runnable acceptPutPreparedStatementQuery(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightStream flightStream, FlightProducer.StreamListener<PutResult> ackStream) Description copied from interface:FlightSqlProducerAccepts uploaded parameter values for a particular prepared statement query.- Specified by:
acceptPutPreparedStatementQueryin interfaceFlightSqlProducer- 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
public FlightInfo getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns the SQL Info of the server by returning aFlightSql.CommandGetSqlInfoin aResult.- Specified by:
getFlightInfoSqlInfoin interfaceFlightSqlProducer- Parameters:
request- request filter parameters.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamSqlInfo
public void getStreamSqlInfo(FlightSql.CommandGetSqlInfo command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for SQL info based data stream.- Specified by:
getStreamSqlInfoin interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoTypeInfo
public FlightInfo getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns a description of all the data types supported by source.- Specified by:
getFlightInfoTypeInfoin interfaceFlightSqlProducer- Parameters:
request- request filter parameters.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamTypeInfo
public void getStreamTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for type info based data stream.- Specified by:
getStreamTypeInfoin interfaceFlightSqlProducercontext- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoCatalogs
public FlightInfo getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns the available catalogs by returning a stream ofFlightSql.CommandGetCatalogsobjects inResultobjects.- Specified by:
getFlightInfoCatalogsin interfaceFlightSqlProducer- Parameters:
request- request filter parameters.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamCatalogs
public void getStreamCatalogs(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for catalogs based data stream.- Specified by:
getStreamCatalogsin interfaceFlightSqlProducer- Parameters:
context- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoSchemas
public FlightInfo getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns the available schemas by returning a stream ofFlightSql.CommandGetDbSchemasobjects inResultobjects.- Specified by:
getFlightInfoSchemasin interfaceFlightSqlProducer- Parameters:
request- request filter parameters.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamSchemas
public void getStreamSchemas(FlightSql.CommandGetDbSchemas command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for schemas based data stream.- Specified by:
getStreamSchemasin interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoTables
public FlightInfo getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns the available tables by returning a stream ofFlightSql.CommandGetTablesobjects inResultobjects.- Specified by:
getFlightInfoTablesin interfaceFlightSqlProducer- Parameters:
request- request filter parameters.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamTables
public void getStreamTables(FlightSql.CommandGetTables command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for tables based data stream.- Specified by:
getStreamTablesin interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoTableTypes
public FlightInfo getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns the available table types by returning a stream ofFlightSql.CommandGetTableTypesobjects inResultobjects.- Specified by:
getFlightInfoTableTypesin interfaceFlightSqlProducercontext- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamTableTypes
public void getStreamTableTypes(FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for table types based data stream.- Specified by:
getStreamTableTypesin interfaceFlightSqlProducer- Parameters:
context- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoPrimaryKeys
public FlightInfo getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerReturns the available primary keys by returning a stream ofFlightSql.CommandGetPrimaryKeysobjects inResultobjects.- Specified by:
getFlightInfoPrimaryKeysin interfaceFlightSqlProducer- Parameters:
request- request filter parameters.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamPrimaryKeys
public void getStreamPrimaryKeys(FlightSql.CommandGetPrimaryKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for primary keys based data stream.- Specified by:
getStreamPrimaryKeysin interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
getFlightInfoExportedKeys
public FlightInfo getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor) Description copied from interface:FlightSqlProducerRetrieves a description of the foreign key columns that reference the given table's primary key columnsFlightSql.CommandGetExportedKeysobjects inResultobjects.- Specified by:
getFlightInfoExportedKeysin interfaceFlightSqlProducer- 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:FlightSqlProducerRetrieves a description of the primary key columns that are referenced by given table's foreign key columnsFlightSql.CommandGetImportedKeysobjects inResultobjects.- Specified by:
getFlightInfoImportedKeysin interfaceFlightSqlProducer- 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:FlightSqlProducerRetrieve a description of the foreign key columns that reference the given table's primary key columnsFlightSql.CommandGetCrossReferenceobjects inResultobjects.- Specified by:
getFlightInfoCrossReferencein interfaceFlightSqlProducer- Parameters:
request- request filter parameters.context- Per-call context.descriptor- The descriptor identifying the data stream.- Returns:
- Metadata about the stream.
-
getStreamExportedKeys
public void getStreamExportedKeys(FlightSql.CommandGetExportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for foreign keys based data stream.- Specified by:
getStreamExportedKeysin interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
getStreamImportedKeys
public void getStreamImportedKeys(FlightSql.CommandGetImportedKeys command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for foreign keys based data stream.- Specified by:
getStreamImportedKeysin interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
getStreamCrossReference
public void getStreamCrossReference(FlightSql.CommandGetCrossReference command, FlightProducer.CallContext context, FlightProducer.ServerStreamListener listener) Description copied from interface:FlightSqlProducerReturns data for cross reference based data stream.- Specified by:
getStreamCrossReferencein interfaceFlightSqlProducer- Parameters:
command- The command to generate the data stream.context- Per-call context.listener- An interface for sending data back to the client.
-
close
- Specified by:
closein interfaceAutoCloseable- Throws:
Exception
-
listFlights
public void listFlights(FlightProducer.CallContext context, Criteria criteria, FlightProducer.StreamListener<FlightInfo> listener) Description copied from interface:FlightProducerList available data streams on this service.- Specified by:
listFlightsin interfaceFlightProducer- Parameters:
context- Per-call context.criteria- Application-defined criteria for filtering streams.listener- An interface for sending data back to the client.
-