Uses of Class
org.apache.arrow.flight.FlightDescriptor

Packages that use FlightDescriptor

Package	Description
org.apache.arrow.flight
org.apache.arrow.flight.integration.tests
org.apache.arrow.flight.sql

Uses of FlightDescriptor in org.apache.arrow.flight

Methods in org.apache.arrow.flight that return FlightDescriptor

Modifier and Type	Method	Description
static FlightDescriptor	FlightDescriptor.command(byte[] cmd)
static FlightDescriptor	FlightDescriptor.deserialize(ByteBuffer serialized)	Parse the serialized form of this protocol message.
FlightDescriptor	FlightInfo.getDescriptor()
FlightDescriptor	FlightStream.getDescriptor()	Get the descriptor for this stream.
static FlightDescriptor	FlightDescriptor.path(Iterable<String> path)
static FlightDescriptor	FlightDescriptor.path(String... path)

Methods in org.apache.arrow.flight that return types with arguments of type FlightDescriptor

Modifier and Type	Method	Description
Optional<FlightDescriptor>	PollInfo.getFlightDescriptor()	The FlightDescriptor that should be used to get further updates on this query.

Methods in org.apache.arrow.flight with parameters of type FlightDescriptor

Modifier and Type	Method	Description
static FlightInfo.Builder	FlightInfo.builder(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints)	Create a builder for FlightInfo.
FlightClient.ExchangeReaderWriter	FlightClient.doExchange(FlightDescriptor descriptor, CallOption... options)	Initiate a bidirectional data exchange with the server.
FlightInfo	FlightProducer.getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)	Get information about a particular data stream.
FlightInfo	NoOpFlightProducer.getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightClient.getInfo(FlightDescriptor descriptor, CallOption... options)	Get info on a stream.
SchemaResult	FlightClient.getSchema(FlightDescriptor descriptor, CallOption... options)	Get schema for a stream.
default SchemaResult	FlightProducer.getSchema(FlightProducer.CallContext context, FlightDescriptor descriptor)	Get schema for a particular data stream.
default PollInfo	FlightProducer.pollFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)	Begin or get an update on execution of a long-running query.
PollInfo	FlightClient.pollInfo(FlightDescriptor descriptor, CallOption... options)	Start or get info on execution of a long-running query.
FlightClient.ClientStreamListener	FlightClient.startPut(FlightDescriptor descriptor, FlightClient.PutListener metadataListener, CallOption... options)	Create or append a descriptor with another stream.
FlightClient.ClientStreamListener	FlightClient.startPut(FlightDescriptor descriptor, VectorSchemaRoot root, FlightClient.PutListener metadataListener, CallOption... options)	Create or append a descriptor with another stream.
FlightClient.ClientStreamListener	FlightClient.startPut(FlightDescriptor descriptor, VectorSchemaRoot root, DictionaryProvider provider, FlightClient.PutListener metadataListener, CallOption... options)	Create or append a descriptor with another stream.

Constructors in org.apache.arrow.flight with parameters of type FlightDescriptor

Modifier	Constructor	Description
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records)	Constructs a new instance.
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records, boolean ordered, IpcOption option)	Constructs a new instance.
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records, boolean ordered, IpcOption option, byte[] appMetadata)	Constructs a new instance.
	FlightInfo(Schema schema, FlightDescriptor descriptor, List<FlightEndpoint> endpoints, long bytes, long records, IpcOption option)	Constructs a new instance.
	PollInfo(FlightInfo flightInfo, FlightDescriptor flightDescriptor, Double progress, Instant expirationTime)	Create a new PollInfo.

Uses of FlightDescriptor in org.apache.arrow.flight.integration.tests

Methods in org.apache.arrow.flight.integration.tests with parameters of type FlightDescriptor

Modifier and Type	Method	Description
FlightInfo	IntegrationProducer.getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlScenarioProducer.getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
SchemaResult	FlightSqlScenarioProducer.getSchemaPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
SchemaResult	FlightSqlScenarioProducer.getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
SchemaResult	FlightSqlScenarioProducer.getSchemaSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)

Uses of FlightDescriptor in org.apache.arrow.flight.sql

Methods in org.apache.arrow.flight.sql with parameters of type FlightDescriptor

Modifier and Type	Method	Description
protected abstract <T extends com.google.protobuf.Message> List<FlightEndpoint>	BasicFlightSqlProducer.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	BasicFlightSqlProducer.generateFlightInfo(T request, FlightDescriptor descriptor, Schema schema)
default FlightInfo	FlightSqlProducer.getFlightInfo(FlightProducer.CallContext context, FlightDescriptor descriptor)	Depending on the provided command, method either: 1.
FlightInfo	BasicFlightSqlProducer.getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoCatalogs(FlightSql.CommandGetCatalogs request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoCrossReference(FlightSql.CommandGetCrossReference request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoExportedKeys(FlightSql.CommandGetExportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoImportedKeys(FlightSql.CommandGetImportedKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)	Gets information about a particular prepared statement data stream.
FlightInfo	NoOpFlightSqlProducer.getFlightInfoPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoPrimaryKeys(FlightSql.CommandGetPrimaryKeys request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoSchemas(FlightSql.CommandGetDbSchemas request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoSqlInfo(FlightSql.CommandGetSqlInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)	Evaluate a SQL query.
FlightInfo	NoOpFlightSqlProducer.getFlightInfoStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
default FlightInfo	FlightSqlProducer.getFlightInfoSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)	Evaluate a Substrait plan.
FlightInfo	BasicFlightSqlProducer.getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoTables(FlightSql.CommandGetTables request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.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	NoOpFlightSqlProducer.getFlightInfoTableTypes(FlightSql.CommandGetTableTypes request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	BasicFlightSqlProducer.getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
FlightInfo	FlightSqlProducer.getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)	Returns a description of all the data types supported by source.
FlightInfo	NoOpFlightSqlProducer.getFlightInfoTypeInfo(FlightSql.CommandGetXdbcTypeInfo request, FlightProducer.CallContext context, FlightDescriptor descriptor)
SchemaResult	FlightSqlClient.getSchema(FlightDescriptor descriptor, CallOption... options)	Get schema for a stream.
default SchemaResult	FlightSqlProducer.getSchema(FlightProducer.CallContext context, FlightDescriptor descriptor)	Returns the schema of the result produced by the SQL query.
default SchemaResult	FlightSqlProducer.getSchemaPreparedStatement(FlightSql.CommandPreparedStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)	Get the schema of the result set of a prepared statement.
SchemaResult	FlightSqlProducer.getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)	Get the result schema for a SQL query.
SchemaResult	NoOpFlightSqlProducer.getSchemaStatement(FlightSql.CommandStatementQuery command, FlightProducer.CallContext context, FlightDescriptor descriptor)
default SchemaResult	FlightSqlProducer.getSchemaSubstraitPlan(FlightSql.CommandStatementSubstraitPlan command, FlightProducer.CallContext context, FlightDescriptor descriptor)	Get the result schema for a Substrait plan.