ADBC
Arrow Database Connectivity
Loading...
Searching...
No Matches
adbc::driver::BaseStatement< Derived > Class Template Reference
Inheritance diagram for adbc::driver::BaseStatement< Derived >:
adbc::driver::ObjectBase adbc::driver::Statement< Derived >

Public Types

using Base = BaseStatement<Derived>
 

Public Member Functions

AdbcStatusCode Init (void *parent, AdbcError *error) override
 Initialize the object.
 
Status InitImpl (void *parent)
 Initialize the statement.
 
AdbcStatusCode Release (AdbcError *error) override
 Finalize the object.
 
Status ReleaseImpl ()
 
AdbcStatusCode SetOption (std::string_view key, Option value, AdbcError *error) override
 Set an option value.
 
virtual Status SetOptionImpl (std::string_view key, Option value)
 Set an option. May be called prior to InitImpl.
 
AdbcStatusCode ExecuteQuery (ArrowArrayStream *stream, int64_t *rows_affected, AdbcError *error)
 
Result< int64_t > ExecuteQueryImpl (ArrowArrayStream *stream)
 
AdbcStatusCode ExecuteSchema (ArrowSchema *schema, AdbcError *error)
 
Status ExecuteSchemaImpl (ArrowSchema *schema)
 
AdbcStatusCode Prepare (AdbcError *error)
 
Status PrepareImpl ()
 
AdbcStatusCode SetSqlQuery (const char *query, AdbcError *error)
 
Status SetSqlQueryImpl (std::string_view query)
 
AdbcStatusCode SetSubstraitPlan (const uint8_t *plan, size_t length, AdbcError *error)
 
Status SetSubstraitPlanImpl (std::string_view plan)
 
AdbcStatusCode Bind (ArrowArray *values, ArrowSchema *schema, AdbcError *error)
 
Status BindImpl (ArrowArray *values, ArrowSchema *schema)
 
AdbcStatusCode BindStream (ArrowArrayStream *stream, AdbcError *error)
 
Status BindStreamImpl (ArrowArrayStream *stream)
 
AdbcStatusCode GetParameterSchema (ArrowSchema *schema, AdbcError *error)
 
Status GetParameterSchemaImpl (struct ArrowSchema *schema)
 
AdbcStatusCode ExecutePartitions (ArrowSchema *schema, AdbcPartitions *partitions, int64_t *rows_affected, AdbcError *error)
 
AdbcStatusCode Cancel (AdbcError *error)
 
Status Cancel ()
 
- Public Member Functions inherited from adbc::driver::ObjectBase
virtual Result< OptionGetOption (std::string_view key)
 Get an option value.
 

Private Member Functions

Derived & impl ()
 

Additional Inherited Members

- Protected Attributes inherited from adbc::driver::ObjectBase
LifecycleState lifecycle_state_
 

Member Function Documentation

◆ Init()

template<typename Derived >
AdbcStatusCode adbc::driver::BaseStatement< Derived >::Init ( void * parent,
AdbcError * error )
inlineoverridevirtual

Initialize the object.

Called after 0 or more SetOption calls. Generally, you won't need to override this directly. Instead, use the typed InitImpl provided by Database/Connection/Statement.

Parameters
[in]parentA pointer to the AdbcDatabase or AdbcConnection implementation as appropriate, or nullptr.

Reimplemented from adbc::driver::ObjectBase.

Reimplemented in adbc::driver::Statement< Derived >.

◆ InitImpl()

template<typename Derived >
Status adbc::driver::BaseStatement< Derived >::InitImpl ( void * parent)
inline

Initialize the statement.

◆ Release()

template<typename Derived >
AdbcStatusCode adbc::driver::BaseStatement< Derived >::Release ( AdbcError * error)
inlineoverridevirtual

Finalize the object.

This can be used to return an error if the object is not in a valid state (e.g. prevent closing a connection with open statements) or to clean up resources when resource cleanup could fail. Infallible resource cleanup (e.g. releasing memory) should generally be handled in the destructor.

Generally, you won't need to override this directly. Instead, use the typed ReleaseImpl provided by Database/Connection/Statement.

Reimplemented from adbc::driver::ObjectBase.

Reimplemented in adbc::driver::Statement< Derived >.

◆ SetOption()

template<typename Derived >
AdbcStatusCode adbc::driver::BaseStatement< Derived >::SetOption ( std::string_view key,
Option value,
AdbcError * error )
inlineoverridevirtual

Set an option value.

Reimplemented from adbc::driver::ObjectBase.

Reimplemented in adbc::driver::Statement< Derived >.

◆ SetOptionImpl()

template<typename Derived >
virtual Status adbc::driver::BaseStatement< Derived >::SetOptionImpl ( std::string_view key,
Option value )
inlinevirtual

Set an option. May be called prior to InitImpl.

Reimplemented in adbc::driver::Statement< Derived >.


The documentation for this class was generated from the following file: