Package org.apache.arrow.adbc.core

Interface AdbcOptions

All Known Subinterfaces:
AdbcConnection, AdbcDatabase, AdbcStatement
All Known Implementing Classes:
FlightSqlConnection, FlightSqlDatabase, FlightSqlStatement, JdbcConnection, JdbcDataSourceDatabase, JdbcStatement
public interface AdbcOptions
An ADBC object that supports getting/setting generic options.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T
    getOption(TypedKey<T> key)
    Get a generic option.
    default <T> void
    setOption(TypedKey<T> key, T value)
    Set a generic option.

  • Method Details

    • getOption

      default <T> T getOption(TypedKey<T> key) throws AdbcException
      Get a generic option.
      Type Parameters:
      T - The option value type.
      Parameters:
      key - The option to retrieve.
      Returns:
      The option value.
      Throws:
      AdbcException
      Since:
      ADBC API revision 1.1.0

    • setOption

      default <T> void setOption(TypedKey<T> key, T value) throws AdbcException
      Set a generic option.
      Type Parameters:
      T - The option value type.
      Parameters:
      key - The option to set.
      value - The option value.
      Throws:
      AdbcException
      Since:
      ADBC API revision 1.1.0