Struct ConnectionPool

pub struct ConnectionPool(/* private fields */);

Access to the node’s DB connection pool and DB-access-related methods.

The handle is safe to clone and share between threads.

Implementations

impl ConnectionPool

pub fn new(conf: &Config) -> Result<Self>

Create the connection pool from the given configuration.

pub async fn acquire(&self) -> Result<ConnectionHandle, AcquireError>

Acquire a temporary database ConnectionHandle from the inner pool.

In the case that all connections are busy, waits for the first available connection.

pub fn try_acquire(&self) -> Result<ConnectionHandle, TryAcquireError>

Attempt to synchronously acquire a temporary database ConnectionHandle from the inner pool.

Returns Err in the case that all database connections are busy or if the node has been closed.

pub fn close(&self) -> Result<(), ConnectionCloseErrors>

Close a connection pool, returning a ConnectionCloseErrors in the case of any errors.

impl ConnectionPool

Short-hand methods for async DB access.

pub async fn acquire_then<F, T, E>( &self, f: F, ) -> Result<T, AcquireThenError<E>>

where F: 'static + Send + FnOnce(&mut ConnectionHandle) -> Result<T, E>, T: 'static + Send, E: 'static + Send,

Asynchronous access to the node’s DB via the given function.

Requests and awaits a connection from the connection pool, then spawns a blocking task for the given function providing access to the connection handle.

pub async fn create_tables(&self) -> Result<(), AcquireThenRusqliteError>

Create all database tables.

pub async fn insert_block( &self, block: Arc<Block>, ) -> Result<ContentAddress, AcquireThenRusqliteError>

Insert the given block into the block table and for each of its solutions, add a row into the solution and block_solution tables.

pub async fn finalize_block( &self, block_ca: ContentAddress, ) -> Result<(), AcquireThenRusqliteError>

Finalizes the block with the given hash. This sets the block to be the only block at a particular block number.

pub async fn update_state( &self, contract_ca: ContentAddress, key: Key, value: Value, ) -> Result<(), AcquireThenRusqliteError>

Updates the state for a given contract content address and key.

pub async fn delete_state( &self, contract_ca: ContentAddress, key: Key, ) -> Result<(), AcquireThenRusqliteError>

Deletes the state for a given contract content address and key.

pub async fn get_solution( &self, ca: ContentAddress, ) -> Result<Option<Solution>, AcquireThenQueryError>

Fetches a solution by its content address.

pub async fn query_state( &self, contract_ca: ContentAddress, key: Key, ) -> Result<Option<Value>, AcquireThenQueryError>

Fetches the state value for the given contract content address and key pair.

pub async fn get_state_progress( &self, ) -> Result<Option<ContentAddress>, AcquireThenQueryError>

Get the state progress, returning the last block hash.

pub async fn get_validation_progress( &self, ) -> Result<Option<ContentAddress>, AcquireThenQueryError>

Get the validation progress, returning the last block hash.

pub async fn update_validation_progress( &self, block_ca: ContentAddress, ) -> Result<(), AcquireThenRusqliteError>

Update the validation progress to point to the block with the given CA.

pub async fn list_blocks( &self, block_range: Range<Word>, ) -> Result<Vec<Block>, AcquireThenQueryError>

Lists all blocks in the given range.

pub async fn list_blocks_by_time( &self, range: Range<Duration>, page_size: i64, page_number: i64, ) -> Result<Vec<Block>, AcquireThenQueryError>

Lists blocks and their solutions within a specific time range with pagination.

pub fn subscribe_blocks( &self, start_block: Word, await_new_block: impl AwaitNewBlock, ) -> impl Stream<Item = Result<Block, QueryError>>

Subscribe to all blocks from the given starting block number.

Trait Implementations

impl AcquireConnection for ConnectionPool

async fn acquire_connection(&self) -> Option<impl 'static + AsRef<Connection>>

Asynchronously acquire a handle to a Connection.

impl Clone for ConnectionPool

fn clone(&self) -> ConnectionPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.