[#wallet-SQLiteBatch]
= xref:wallet.adoc[wallet]::SQLiteBatch
:relfileprefix: ../
:mrdocs:

RAII class that provides access to a WalletDatabase

== Synopsis

Declared in `<wallet/sqlite.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class SQLiteBatch
    : public xref:wallet/DatabaseBatch.adoc[DatabaseBatch]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:wallet/DatabaseBatch.adoc[DatabaseBatch]`
| RAII class that provides access to a WalletDatabase
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:wallet/SQLiteBatch/2constructor.adoc[`SQLiteBatch`]         [.small]#[constructor]#
| Construct a batch connected to the given database.
| xref:wallet/SQLiteBatch/2destructor.adoc[`~SQLiteBatch`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy the batch, closing it first.
| xref:wallet/DatabaseBatch/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| Batches are non‐copyable.
| xref:wallet/SQLiteBatch/Close.adoc[`Close`]  [.small]#[virtual]#
| Close the batch and finalize its prepared statements.
| xref:wallet/DatabaseBatch/Erase.adoc[`Erase`] 
| Erases the record stored under a key.
| xref:wallet/DatabaseBatch/ErasePrefix.adoc[`ErasePrefix`]  [.small]#[virtual]#
| Erases all records whose key begins with the given prefix.
| xref:wallet/DatabaseBatch/Exists.adoc[`Exists`] 
| Returns whether a record exists for a key.
| xref:wallet/SQLiteBatch/GetNewCursor.adoc[`GetNewCursor`]  [.small]#[virtual]#
| Get a cursor iterating over all records in the database.
| xref:wallet/SQLiteBatch/GetNewPrefixCursor.adoc[`GetNewPrefixCursor`]  [.small]#[virtual]#
| Get a cursor iterating over records whose key starts with a prefix.
| xref:wallet/SQLiteBatch/HasActiveTxn.adoc[`HasActiveTxn`]  [.small]#[virtual]#
| Report whether this batch has started a transaction.
| xref:wallet/DatabaseBatch/Read.adoc[`Read`] 
| Reads the value stored under a key.
| xref:wallet/SQLiteBatch/SetExecHandler.adoc[`SetExecHandler`] 
| Replace the handler used to execute SQL statements for this batch.
| xref:wallet/SQLiteBatch/TxnAbort.adoc[`TxnAbort`]  [.small]#[virtual]#
| Abort the current database transaction.
| xref:wallet/SQLiteBatch/TxnBegin.adoc[`TxnBegin`]  [.small]#[virtual]#
| Begin a database transaction.
| xref:wallet/SQLiteBatch/TxnCommit.adoc[`TxnCommit`]  [.small]#[virtual]#
| Commit the current database transaction.
| xref:wallet/DatabaseBatch/Write.adoc[`Write`] 
| Writes a value under a key.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:wallet/SQLiteBatch/EraseKey.adoc[`EraseKey`]  [.small]#[virtual]#
| Erase the record stored under a key.
| xref:wallet/SQLiteBatch/ErasePrefix.adoc[`ErasePrefix`]  [.small]#[virtual]#
| Erase all records whose key starts with a prefix.
| xref:wallet/SQLiteBatch/HasKey.adoc[`HasKey`]  [.small]#[virtual]#
| Report whether a key exists in the database.
| xref:wallet/SQLiteBatch/ReadKey.adoc[`ReadKey`]  [.small]#[virtual]#
| Read the value stored under a key.
| xref:wallet/SQLiteBatch/WriteKey.adoc[`WriteKey`]  [.small]#[virtual]#
| Write a value under a key.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#