Struct EventDB 

pub(crate) struct EventDB {}

The Catalyst Event SQL Database

Implementations

impl EventDB

pub(crate) async fn schema_version_check() -> Result<i32>

Check the schema version. return the current schema version if its current. Otherwise return an error.

impl EventDB

async fn get_pool_connection() -> Result<Object<Manager>, EventDBConnectionError>

Get a connection from the pool.

pub(crate) fn is_deep_query_enabled() -> bool

Determine if deep query inspection is enabled.

pub(crate) fn modify_deep_query(enable: bool)

Modify the deep query inspection setting.

Arguments

• enable - Set the DeepQueryInspection setting to this value.

pub(crate) async fn query( stmt: &str, params: &[&(dyn ToSql + Sync)], ) -> Result<Vec<Row>>

Query the database.

If deep query inspection is enabled, this will log the query plan inside a rolled-back transaction, before running the query.

Arguments

• stmt - &str SQL statement.
• params - &[&(dyn ToSql + Sync)] SQL parameters.

Returns

anyhow::Result<Vec<Row>>

pub(crate) async fn query_stream( stmt: &str, params: &[&(dyn ToSql + Sync)], ) -> Result<impl Stream<Item = Result<Row>>>

Query the database and return a async stream of rows.

If deep query inspection is enabled, this will log the query plan inside a rolled-back transaction, before running the query.

Arguments

• stmt - &str SQL statement.
• params - &[&(dyn ToSql + Sync)] SQL parameters.

Returns

anyhow::Result<impl Stream<Item = anyhow::Result<Row>>>

pub(crate) async fn query_one( stmt: &str, params: &[&(dyn ToSql + Sync)], ) -> Result<Row>

Query the database for a single row.

Arguments

• stmt - &str SQL statement.
• params - &[&(dyn ToSql + Sync)] SQL parameters.

Returns

Result<Row, anyhow::Error>

pub(crate) async fn modify( stmt: &str, params: &[&(dyn ToSql + Sync)], ) -> Result<()>

Modify the database.

Use this for UPDATE, DELETE, and other DB statements that don’t return data.

Arguments

• stmt - &str SQL statement.
• params - &[&(dyn ToSql + Sync)] SQL parameters.

Returns

anyhow::Result<()>

pub(crate) async fn connection_is_ok() -> bool

Checks that connection to EventDB is available.

async fn explain_analyze_rollback( stmt: &str, params: &[&(dyn ToSql + Sync)], ) -> Result<()>

Prepend EXPLAIN ANALYZE to the query, and rollback the transaction.

async fn explain_analyze_commit( stmt: &str, params: &[&(dyn ToSql + Sync)], ) -> Result<()>

Prepend EXPLAIN ANALYZE to the query, and commit the transaction.

async fn explain_analyze( stmt: &str, params: &[&(dyn ToSql + Sync)], rollback: bool, ) -> Result<()>

Prepend EXPLAIN ANALYZE to the query.

Log the query plan inside a transaction that may be committed or rolled back.

Arguments

• stmt - &str SQL statement.
• params - &[&(dyn ToSql + Sync)] SQL parameters.
• rollback - bool whether to roll back the transaction or not.

pub(crate) async fn wait_until_ready(interval: Duration)

Wait for the Event DB to be ready before continuing

pub(crate) fn spawn_ready_probe()

Spawns a background task checking for the Event DB to be ready. Could spawn only one background task at a time