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

Class JniStatement

java.lang.Object

org.apache.arrow.adbc.driver.jni.JniStatement

All Implemented Interfaces:

AutoCloseable, AdbcOptions, AdbcStatement, HasChildReferences

public class JniStatement
extends Object
implements AdbcStatement, HasChildReferences

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	JniStatement.PartitionPollIterator

Nested classes/interfaces inherited from interface org.apache.arrow.adbc.core.AdbcStatement

AdbcStatement.PartitionResult, AdbcStatement.QueryResult, AdbcStatement.UpdateResult

Constructor Summary

Constructors

Constructor	Description
JniStatement(BufferAllocator allocator, HasChildReferences parent, NativeStatementHandle handle)

Method Summary

Modifier and Type	Method	Description
void	bind(ArrowReader reader)	Bind an ArrowReader to provide parameter values/bulk data ingestion.
void	bind(VectorSchemaRoot root)	Bind a VectorSchemaRoot to provide parameter values/bulk data ingestion.
void	cancel()	Cancel execution of a query.
void	close()
AdbcStatement.PartitionResult	executePartitioned()	Execute a result set-generating query and get a list of partitions of the result set.
AdbcStatement.QueryResult	executeQuery()	Execute a result set-generating query and get the result.
Schema	executeSchema()	Get the schema of the result set without executing the query.
AdbcStatement.UpdateResult	executeUpdate()	Execute a query.
ChildReferences	getChildReferences()
double	getMaxProgress()	Get the upper bound of the progress.
<T> T	getOption(TypedKey<T> key)	Get a generic option.
Schema	getParameterSchema()	Get the schema for bound parameters.
double	getProgress()	Get the progress of executing a query.
Iterator<AdbcStatement.PartitionResult>	pollPartitioned()	Execute a result set-generating query and get a list of partitions of the result set.
void	prepare()	Turn this statement into a prepared statement.
<T> void	setOption(TypedKey<T> key, T value)	Set a generic option.
void	setSqlQuery(String query)	Set a SQL query to be executed on this statement.
void	setSubstraitPlan(ByteBuffer plan)	Set a Substrait plan to be executed on this statement.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.arrow.adbc.core.AdbcStatement

setOption

Constructor Details

JniStatement

public JniStatement(BufferAllocator allocator,
 HasChildReferences parent,
 NativeStatementHandle handle)

Method Details

getChildReferences

public ChildReferences getChildReferences()

Specified by:

getChildReferences in interface HasChildReferences

cancel

public void cancel()
            throws AdbcException

Description copied from interface: AdbcStatement

Cancel execution of a query.

This can be used to interrupt execution of a method like AdbcStatement.executeQuery().

This method must be thread-safe (other method are not necessarily thread-safe).

Specified by:

cancel in interface AdbcStatement

Throws:

AdbcException

setSqlQuery

public void setSqlQuery(String query)
                 throws AdbcException

Description copied from interface: AdbcStatement

Set a SQL query to be executed on this statement.

Specified by:

setSqlQuery in interface AdbcStatement

Parameters:

query - The SQL query.

Throws:

AdbcException

setSubstraitPlan

public void setSubstraitPlan(ByteBuffer plan)
                      throws AdbcException

Description copied from interface: AdbcStatement

Set a Substrait plan to be executed on this statement.

Specified by:

setSubstraitPlan in interface AdbcStatement

Parameters:

plan - The serialized Substrait plan.

Throws:

AdbcException

bind

public void bind(VectorSchemaRoot root)
          throws AdbcException

Description copied from interface: AdbcStatement

Bind a VectorSchemaRoot to provide parameter values/bulk data ingestion.

The statement will NOT close the root after use/on close/when other data is bound.

Specified by:

bind in interface AdbcStatement

Throws:

AdbcException

bind

public void bind(ArrowReader reader)
          throws AdbcException

Description copied from interface: AdbcStatement

Bind an ArrowReader to provide parameter values/bulk data ingestion.

The statement will close the reader after use/on close/when other data is bound.

Specified by:

bind in interface AdbcStatement

Throws:

AdbcException

executePartitioned

public AdbcStatement.PartitionResult executePartitioned()
                                                 throws AdbcException

Description copied from interface: AdbcStatement

Execute a result set-generating query and get a list of partitions of the result set.

These can be serialized and deserialized for parallel and/or distributed fetching.

This may invalidate any prior result sets.

Specified by:

executePartitioned in interface AdbcStatement

Throws:

AdbcException

executeQuery

public AdbcStatement.QueryResult executeQuery()
                                       throws AdbcException

Description copied from interface: AdbcStatement

Execute a result set-generating query and get the result.

This may invalidate any prior result sets.

Specified by:

executeQuery in interface AdbcStatement

Throws:

AdbcException

executeUpdate

public AdbcStatement.UpdateResult executeUpdate()
                                         throws AdbcException

Description copied from interface: AdbcStatement

Execute a query.

This may invalidate any prior result sets.

Specified by:

executeUpdate in interface AdbcStatement

Throws:

AdbcException

executeSchema

public Schema executeSchema()
                     throws AdbcException

Description copied from interface: AdbcStatement

Get the schema of the result set without executing the query.

Specified by:

executeSchema in interface AdbcStatement

Throws:

AdbcException

getParameterSchema

public Schema getParameterSchema()
                          throws AdbcException

Description copied from interface: AdbcStatement

Get the schema for bound parameters.

This retrieves an Arrow schema describing the number, names, and types of the parameters in a parameterized statement. The fields of the schema should be in order of the ordinal position of the parameters; named parameters should appear only once.

If the parameter does not have a name, or the name cannot be determined, the name of the corresponding field in the schema will be an empty string. If the type cannot be determined, the type of the corresponding field will be NA (NullType).

This should be called after AdbcStatementPrepare.

Specified by:

getParameterSchema in interface AdbcStatement

Throws:

AdbcException - with AdbcStatusCode.NOT_IMPLEMENTED if the parameters cannot be determined at all.

prepare

public void prepare()
             throws AdbcException

Description copied from interface: AdbcStatement

Turn this statement into a prepared statement.

Call AdbcStatement.executeQuery(), AdbcStatement.executeUpdate(), or AdbcStatement.executePartitioned() to execute the query.

Specified by:

prepare in interface AdbcStatement

Throws:

AdbcException

getProgress

public double getProgress()
                   throws AdbcException

Description copied from interface: AdbcStatement

Get the progress of executing a query.

Specified by:

getProgress in interface AdbcStatement

Throws:

AdbcException

getMaxProgress

public double getMaxProgress()
                      throws AdbcException

Description copied from interface: AdbcStatement

Get the upper bound of the progress.

Specified by:

getMaxProgress in interface AdbcStatement

Throws:

AdbcException

pollPartitioned

public Iterator<AdbcStatement.PartitionResult> pollPartitioned()
                                                        throws AdbcException

Description copied from interface: AdbcStatement

Execute a result set-generating query and get a list of partitions of the result set.

These can be serialized and deserialized for parallel and/or distributed fetching.

This may invalidate any prior result sets.

Specified by:

pollPartitioned in interface AdbcStatement

Throws:

AdbcException

close

public void close()
           throws AdbcException

Specified by:

close in interface AdbcStatement

Specified by:

close in interface AutoCloseable

Throws:

AdbcException

getOption

public <T> T getOption(TypedKey<T> key)
                throws AdbcException

Description copied from interface: AdbcOptions

Get a generic option.

Specified by:

getOption in interface AdbcOptions

Type Parameters:

T - The option value type.

Parameters:

key - The option to retrieve.

Returns:

The option value.

Throws:

AdbcException

setOption

public <T> void setOption(TypedKey<T> key,
 T value)
                   throws AdbcException

Description copied from interface: AdbcOptions

Set a generic option.

Specified by:

setOption in interface AdbcOptions

Type Parameters:

T - The option value type.

Parameters:

key - The option to set.

value - The option value.

Throws:

AdbcException