Package org.apache.arrow.adbc.driver.flightsql

Class FlightSqlConnection

java.lang.Object
org.apache.arrow.adbc.driver.flightsql.FlightSqlConnection
All Implemented Interfaces:
AutoCloseable, AdbcConnection, AdbcOptions
public class FlightSqlConnection extends Object implements AdbcConnection

  • Method Details

    • commit

      public void commit() throws AdbcException
      Description copied from interface: AdbcConnection
      Commit the pending transaction.
      Specified by:
      commit in interface AdbcConnection
      Throws:
      AdbcException

    • createStatement

      public AdbcStatement createStatement() throws AdbcException
      Description copied from interface: AdbcConnection
      Create a new statement that can be executed.
      Specified by:
      createStatement in interface AdbcConnection
      Throws:
      AdbcException

    • readPartition

      public ArrowReader readPartition(ByteBuffer descriptor) throws AdbcException
      Description copied from interface: AdbcConnection
      Create a result set from a serialized PartitionDescriptor.
      Specified by:
      readPartition in interface AdbcConnection
      Parameters:
      descriptor - The descriptor to load (PartitionDescriptor.getDescriptor().
      Returns:
      A statement that can be immediately executed.
      Throws:
      AdbcException
      See Also:

    • bulkIngest

      public AdbcStatement bulkIngest(String targetTableName, BulkIngestMode mode) throws AdbcException
      Description copied from interface: AdbcConnection
      Create a new statement to bulk insert a VectorSchemaRoot into a table.

      Bind data to the statement, then call AdbcStatement.executeUpdate(). See BulkIngestMode for description of behavior around creating tables.

      Specified by:
      bulkIngest in interface AdbcConnection
      Throws:
      AdbcException

    • getObjects

      public ArrowReader getObjects(AdbcConnection.GetObjectsDepth depth, String catalogPattern, String dbSchemaPattern, String tableNamePattern, String[] tableTypes, String columnNamePattern) throws AdbcException
      Description copied from interface: AdbcConnection
      Get a hierarchical view of all catalogs, database schemas, tables, and columns.

      The result is an Arrow dataset with the following schema:

      Field Name Field Type
      catalog_name utf8
      catalog_db_schemas list[DB_SCHEMA_SCHEMA]
      The definition of the GetObjects result schema.

      DB_SCHEMA_SCHEMA is a Struct with fields:

      Field Name Field Type
      db_schema_name utf8
      db_schema_tables list[TABLE_SCHEMA]
      The definition of DB_SCHEMA_SCHEMA.

      TABLE_SCHEMA is a Struct with fields:

      Field Name Field Type
      table_name utf8 not null
      table_type utf8 not null
      table_columns list[COLUMN_SCHEMA]
      table_constraints list[CONSTRAINT_SCHEMA]
      The definition of TABLE_SCHEMA.

      COLUMN_SCHEMA is a Struct with fields:

      Field Name Field Type Comments
      column_name utf8 not null
      ordinal_position int32 (1)
      remarks utf8 (2)
      xdbc_data_type int16 (3)
      xdbc_type_name utf8 (3)
      xdbc_column_size int32 (3)
      xdbc_decimal_digits int16 (3)
      xdbc_num_prec_radix int16 (3)
      xdbc_nullable int16 (3)
      xdbc_column_def utf8 (3)
      xdbc_sql_data_type int16 (3)
      xdbc_datetime_sub int16 (3)
      xdbc_char_octet_length int32 (3)
      xdbc_is_nullable utf8 (3)
      xdbc_scope_catalog utf8 (3)
      xdbc_scope_schema utf8 (3)
      xdbc_scope_table utf8 (3)
      xdbc_is_autoincrement bool (3)
      xdbc_is_generatedcolumn bool (3)
      The definition of COLUMN_SCHEMA.

      Notes:

      1. The column's ordinal position in the table (starting from 1).
      2. Database-specific description of the column.
      3. Optional value. Should be null if not supported by the driver. xdbc_ values are meant to provide JDBC/ODBC-compatible metadata in an agnostic manner.

      CONSTRAINT_SCHEMA is a Struct with fields:

      Field Name Field Type Comments
      constraint_name utf8 not null
      constraint_type utf8 not null (1)
      constraint_column_names list[utf8] not null (2)
      constraint_column_usage list[USAGE_SCHEMA] (3)
      The definition of CONSTRAINT_SCHEMA.
      1. One of 'CHECK', 'FOREIGN KEY', 'PRIMARY KEY', or 'UNIQUE'.
      2. The columns on the current table that are constrained, in order.
      3. For FOREIGN KEY only, the referenced table and columns.

      USAGE_SCHEMA is a Struct with fields:

      Field Name Field Type
      fk_catalog utf8
      fk_db_schema utf8
      fk_table utf8 not null
      fk_column_name utf8 not null
      The definition of USAGE_SCHEMA.
      Specified by:
      getObjects in interface AdbcConnection
      Parameters:
      depth - The level of nesting to display. If ALL, display all levels (up through columns). If CATALOGS, display only catalogs (i.e. catalog_schemas will be null), and so on. May be a search pattern (see class documentation).
      catalogPattern - Only show tables in the given catalog. If null, do not filter by catalog. If an empty string, only show tables without a catalog. May be a search pattern (see class documentation).
      dbSchemaPattern - Only show tables in the given database schema. If null, do not filter by database schema. If an empty string, only show tables without a database schema. May be a search pattern (see class documentation).
      tableNamePattern - Only show tables with the given name. If an empty string, only show tables without a catalog. May be a search pattern (see class documentation).
      tableTypes - Only show tables matching one of the given table types. If null, show tables of any type. Valid table types can be fetched from AdbcConnection.getTableTypes().
      columnNamePattern - Only show columns with the given name. If null, do not filter by name. May be a search pattern (see class documentation).
      Throws:
      AdbcException

    • getInfo

      public ArrowReader getInfo(int @Nullable [] infoCodes) throws AdbcException
      Description copied from interface: AdbcConnection
      Get metadata about the driver/database.
      Specified by:
      getInfo in interface AdbcConnection
      Parameters:
      infoCodes - The metadata items to fetch.
      Throws:
      AdbcException

    • rollback

      public void rollback() throws AdbcException
      Description copied from interface: AdbcConnection
      Rollback the pending transaction.
      Specified by:
      rollback in interface AdbcConnection
      Throws:
      AdbcException - if a database error occurs

    • getAutoCommit

      public boolean getAutoCommit() throws AdbcException
      Description copied from interface: AdbcConnection
      Get the autocommit state.

      Connections start in autocommit mode by default.

      Specified by:
      getAutoCommit in interface AdbcConnection
      Throws:
      AdbcException

    • setAutoCommit

      public void setAutoCommit(boolean enableAutoCommit) throws AdbcException
      Description copied from interface: AdbcConnection
      Toggle whether autocommit is enabled.
      Specified by:
      setAutoCommit in interface AdbcConnection
      Throws:
      AdbcException

    • close

      public void close() throws Exception
      Specified by:
      close in interface AutoCloseable
      Throws:
      Exception

    • toString

      public String toString()
      Overrides:
      toString in class Object