org.apache.arrow.flight.sql

Class FlightSqlClient

java.lang.Object

org.apache.arrow.flight.sql.FlightSqlClient

All Implemented Interfaces:

AutoCloseable

public class FlightSqlClient
extends Object
implements AutoCloseable

Flight client with Flight SQL semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlightSqlClient.PreparedStatement Helper class to encapsulate Flight SQL prepared statement logic.

Constructor Summary

Constructors

Constructor and Description
FlightSqlClient(FlightClient client)

Method Summary

Modifier and Type	Method and Description
void	close()
FlightInfo	execute(String query, CallOption... options) Execute a query on the server.
long	executeUpdate(String query, CallOption... options) Execute an update query on the server.
FlightInfo	getCatalogs(CallOption... options) Request a list of catalogs.
FlightInfo	getCrossReference(TableRef pkTableRef, TableRef fkTableRef, CallOption... options) Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).
FlightInfo	getExportedKeys(TableRef tableRef, CallOption... options) Retrieves a description about the foreign key columns that reference the primary key columns of the given table.
FlightInfo	getImportedKeys(TableRef tableRef, CallOption... options) Retrieves the foreign key columns for the given table.
FlightInfo	getPrimaryKeys(TableRef tableRef, CallOption... options) Request the primary keys for a table.
SchemaResult	getSchema(FlightDescriptor descriptor, CallOption... options) Get schema for a stream.
FlightInfo	getSchemas(String catalog, String dbSchemaFilterPattern, CallOption... options) Request a list of schemas.
FlightInfo	getSqlInfo(FlightSql.SqlInfo... info) Request a set of Flight SQL metadata.
FlightInfo	getSqlInfo(FlightSql.SqlInfo[] info, CallOption... options) Request a set of Flight SQL metadata.
FlightInfo	getSqlInfo(int[] info, CallOption... options) Request a set of Flight SQL metadata.
FlightInfo	getSqlInfo(Iterable<Integer> info, CallOption... options) Request a set of Flight SQL metadata.
FlightStream	getStream(Ticket ticket, CallOption... options) Retrieve a stream from the server.
FlightInfo	getTables(String catalog, String dbSchemaFilterPattern, String tableFilterPattern, List<String> tableTypes, boolean includeSchema, CallOption... options) Request a list of tables.
FlightInfo	getTableTypes(CallOption... options) Request a list of table types.
FlightInfo	getXdbcTypeInfo(CallOption... options) Request the information about all the data types supported.
FlightInfo	getXdbcTypeInfo(int dataType, CallOption... options) Request the information about the data types supported related to a filter data type.
FlightSqlClient.PreparedStatement	prepare(String query, CallOption... options) Create a prepared statement on the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlightSqlClient

public FlightSqlClient(FlightClient client)

Method Detail

execute

public FlightInfo execute(String query,
                          CallOption... options)

Execute a query on the server.

Parameters:

query - The query to execute.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

executeUpdate

public long executeUpdate(String query,
                          CallOption... options)

Execute an update query on the server.

Parameters:

query - The query to execute.

options - RPC-layer hints for this call.

Returns:

the number of rows affected.

getCatalogs

public FlightInfo getCatalogs(CallOption... options)

Request a list of catalogs.

Parameters:

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getSchemas

public FlightInfo getSchemas(String catalog,
                             String dbSchemaFilterPattern,
                             CallOption... options)

Request a list of schemas.

Parameters:

catalog - The catalog.

dbSchemaFilterPattern - The schema filter pattern.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getSchema

public SchemaResult getSchema(FlightDescriptor descriptor,
                              CallOption... options)

Get schema for a stream.

Parameters:

descriptor - The descriptor for the stream.

options - RPC-layer hints for this call.

getStream

public FlightStream getStream(Ticket ticket,
                              CallOption... options)

Retrieve a stream from the server.

Parameters:

ticket - The ticket granting access to the data stream.

options - RPC-layer hints for this call.

getSqlInfo

public FlightInfo getSqlInfo(FlightSql.SqlInfo... info)

Request a set of Flight SQL metadata.

Parameters:

info - The set of metadata to retrieve. None to retrieve all metadata.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getSqlInfo

public FlightInfo getSqlInfo(FlightSql.SqlInfo[] info,
                             CallOption... options)

Request a set of Flight SQL metadata.

Parameters:

info - The set of metadata to retrieve. None to retrieve all metadata.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getSqlInfo

public FlightInfo getSqlInfo(int[] info,
                             CallOption... options)

Request a set of Flight SQL metadata. Use this method if you would like to retrieve custom metadata, where the custom metadata key values start from 10_000.

Parameters:

info - The set of metadata to retrieve. None to retrieve all metadata.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getSqlInfo

public FlightInfo getSqlInfo(Iterable<Integer> info,
                             CallOption... options)

Request a set of Flight SQL metadata. Use this method if you would like to retrieve custom metadata, where the custom metadata key values start from 10_000.

Parameters:

info - The set of metadata to retrieve. None to retrieve all metadata.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getXdbcTypeInfo

public FlightInfo getXdbcTypeInfo(int dataType,
                                  CallOption... options)

Request the information about the data types supported related to a filter data type.

Parameters:

dataType - the data type to be used as filter.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getXdbcTypeInfo

public FlightInfo getXdbcTypeInfo(CallOption... options)

Request the information about all the data types supported.

Parameters:

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getTables

public FlightInfo getTables(String catalog,
                            String dbSchemaFilterPattern,
                            String tableFilterPattern,
                            List<String> tableTypes,
                            boolean includeSchema,
                            CallOption... options)

Request a list of tables.

Parameters:

catalog - The catalog.

dbSchemaFilterPattern - The schema filter pattern.

tableFilterPattern - The table filter pattern.

tableTypes - The table types to include.

includeSchema - True to include the schema upon return, false to not include the schema.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getPrimaryKeys

public FlightInfo getPrimaryKeys(TableRef tableRef,
                                 CallOption... options)

Request the primary keys for a table.

Parameters:

tableRef - An object which hold info about catalog, dbSchema and table.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getExportedKeys

public FlightInfo getExportedKeys(TableRef tableRef,
                                  CallOption... options)

Retrieves a description about the foreign key columns that reference the primary key columns of the given table.

Parameters:

tableRef - An object which hold info about catalog, dbSchema and table.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getImportedKeys

public FlightInfo getImportedKeys(TableRef tableRef,
                                  CallOption... options)

Retrieves the foreign key columns for the given table.

Parameters:

tableRef - An object which hold info about catalog, dbSchema and table.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getCrossReference

public FlightInfo getCrossReference(TableRef pkTableRef,
                                    TableRef fkTableRef,
                                    CallOption... options)

Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).

Parameters:

pkTableRef - An object which hold info about catalog, dbSchema and table from a primary table.

fkTableRef - An object which hold info about catalog, dbSchema and table from a foreign table.

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

getTableTypes

public FlightInfo getTableTypes(CallOption... options)

Request a list of table types.

Parameters:

options - RPC-layer hints for this call.

Returns:

a FlightInfo object representing the stream(s) to fetch.

prepare

public FlightSqlClient.PreparedStatement prepare(String query,
                                                 CallOption... options)

Create a prepared statement on the server.

Parameters:

query - The query to prepare.

options - RPC-layer hints for this call.

Returns:

The representation of the prepared statement which exists on the server.

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Throws:

SQLException