Package org.apache.arrow.adbc.core

Enum AdbcInfoCode

java.lang.Object

java.lang.Enum<AdbcInfoCode>

org.apache.arrow.adbc.core.AdbcInfoCode

All Implemented Interfaces:

Serializable, Comparable<AdbcInfoCode>

public enum AdbcInfoCode
extends Enum<AdbcInfoCode>

Integer IDs used for requesting information about the database/driver.

Since ADBC 1.1.0: the range [500, 1_000) is reserved for "XDBC" information, which is the same metadata provided by the same info code range in the Arrow Flight SQL GetSqlInfo RPC.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DRIVER_ADBC_VERSION	The ADBC API version (type: int64).
DRIVER_ARROW_VERSION	The driver Arrow library version (type: utf8).
DRIVER_NAME	The driver name (type: utf8).
DRIVER_VERSION	The driver version (type: utf8).
VENDOR_ARROW_VERSION	The database vendor/product Arrow library version (type: utf8).
VENDOR_NAME	The database vendor/product name (e.g.
VENDOR_VERSION	The database vendor/product version (type: utf8).

Method Summary

Modifier and Type	Method	Description
int	getValue()
static AdbcInfoCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AdbcInfoCode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VENDOR_NAME

public static final AdbcInfoCode VENDOR_NAME

The database vendor/product name (e.g. the server name) (type: utf8).

VENDOR_VERSION

public static final AdbcInfoCode VENDOR_VERSION

The database vendor/product version (type: utf8).

VENDOR_ARROW_VERSION

public static final AdbcInfoCode VENDOR_ARROW_VERSION

The database vendor/product Arrow library version (type: utf8).

DRIVER_NAME

public static final AdbcInfoCode DRIVER_NAME

The driver name (type: utf8).

DRIVER_VERSION

public static final AdbcInfoCode DRIVER_VERSION

The driver version (type: utf8).

DRIVER_ARROW_VERSION

public static final AdbcInfoCode DRIVER_ARROW_VERSION

The driver Arrow library version (type: utf8).

DRIVER_ADBC_VERSION

public static final AdbcInfoCode DRIVER_ADBC_VERSION

The ADBC API version (type: int64).

The value should be one of the ADBC_VERSION constants.

Since:

ADBC API revision 1.1.0

See Also:

• AdbcDriver.ADBC_VERSION_1_0_0
• AdbcDriver.ADBC_VERSION_1_1_0

Method Details

values

public static AdbcInfoCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AdbcInfoCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()