Package org.apache.arrow.adbc.driver.jni

Class JniDriver

java.lang.Object

org.apache.arrow.adbc.driver.jni.JniDriver

All Implemented Interfaces:

AdbcDriver

public class JniDriver
extends Object
implements AdbcDriver

An ADBC driver wrapping Arrow Flight SQL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	JniDriver.Builder	Fluent builder-style interface for loading a driver and establishing a connection.

Field Summary

Fields

Modifier and Type	Field	Description
static final TypedKey<String>	PARAM_DRIVER	The driver to load.
static final TypedKey<String>	PARAM_MANIFEST_SEARCH_PATH	Additional paths to search for driver manifests.
static final TypedKey<String>	PARAM_PROFILE	The profile to load.
static final TypedKey<String>	PARAM_PROFILE_SEARCH_PATH	Additional paths to search for connection profiles.

Fields inherited from interface org.apache.arrow.adbc.core.AdbcDriver

ADBC_VERSION_1_0_0, ADBC_VERSION_1_1_0, PARAM_PASSWORD, PARAM_SQL_QUIRKS, PARAM_URI, PARAM_URL, PARAM_USERNAME

Constructor Summary

Constructors

Constructor	Description
JniDriver(BufferAllocator allocator)

Method Summary

Modifier and Type	Method	Description
JniDriver.Builder	load()	Fluent builder-style interface for loading a driver and establishing a connection.
AdbcDatabase	open(Map<String,Object> parameters)	Open a database via this driver.

Methods inherited from class java.lang.Object

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

Field Details

PARAM_DRIVER

public static final TypedKey<String> PARAM_DRIVER

The driver to load.

Can be a path to a driver, a name (which will be found via dlopen or equivalent), or a manifest name (which will be loaded from platform-specific paths).

PARAM_PROFILE

public static final TypedKey<String> PARAM_PROFILE

The profile to load.

PARAM_MANIFEST_SEARCH_PATH

public static final TypedKey<String> PARAM_MANIFEST_SEARCH_PATH

Additional paths to search for driver manifests.

PARAM_PROFILE_SEARCH_PATH

public static final TypedKey<String> PARAM_PROFILE_SEARCH_PATH

Additional paths to search for connection profiles.

Constructor Details

JniDriver

public JniDriver(BufferAllocator allocator)

Method Details

open

public AdbcDatabase open(Map<String,Object> parameters)
                  throws AdbcException

Description copied from interface: AdbcDriver

Open a database via this driver.

Specified by:

open in interface AdbcDriver

Parameters:

parameters - Driver-specific parameters.

Throws:

AdbcException

load

public JniDriver.Builder load()

Fluent builder-style interface for loading a driver and establishing a connection.