Skip to main content

Sql

Struct Sql 

Source
pub struct Sql<DB: Database>(/* private fields */);
Expand description

SQL database executor for event sourcing operations.

A generic wrapper around a SQLx connection pool that implements the Executor trait for storing and querying events.

§Type Parameters

  • DB - The SQLx database type (e.g., sqlx::Sqlite, sqlx::MySql, sqlx::Postgres)

§Example

use evento_sql::Sql;
use sqlx::sqlite::SqlitePoolOptions;

// Create a connection pool
let pool = SqlitePoolOptions::new()
    .connect(":memory:")
    .await?;

// Convert to Sql executor
let executor: Sql<sqlx::Sqlite> = pool.into();

// Or use the type alias
let executor: evento_sql::Sqlite = pool.into();

§Executor Implementation

The Sql type implements Executor with the following operations:

  • read - Query events with filtering and cursor-based pagination
  • write - Persist events with optimistic concurrency control
  • get_subscriber_cursor - Get the current cursor position for a subscriber
  • is_subscriber_running - Check if a subscriber is active with a specific worker
  • upsert_subscriber - Create or update a subscriber record
  • acknowledge - Update subscriber cursor after processing events

Trait Implementations§

Source§

impl<D: Database> Clone for Sql<D>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<DB> Executor for Sql<DB>
where DB: Database, for<'c> &'c mut DB::Connection: Executor<'c, Database = DB>, SqlxValues: for<'q> IntoArguments<'q, DB>, String: for<'r> Decode<'r, DB> + Type<DB>, bool: for<'r> Decode<'r, DB> + Type<DB>, Vec<u8>: for<'r> Decode<'r, DB> + Type<DB>, usize: ColumnIndex<DB::Row>, SqlEvent: for<'r> FromRow<'r, DB::Row>,

Source§

fn read<'life0, 'async_trait>( &'life0 self, aggregators: Option<Vec<ReadAggregator>>, routing_key: Option<RoutingKey>, args: Args, ) -> Pin<Box<dyn Future<Output = Result<ReadResult<Event>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Queries events with filtering and pagination.
Source§

fn get_subscriber_cursor<'life0, 'async_trait>( &'life0 self, key: String, ) -> Pin<Box<dyn Future<Output = Result<Option<Value>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Gets the current cursor position for a subscription.
Source§

fn is_subscriber_running<'life0, 'async_trait>( &'life0 self, key: String, worker_id: Ulid, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Checks if a subscription is running with the given worker ID.
Source§

fn upsert_subscriber<'life0, 'async_trait>( &'life0 self, key: String, worker_id: Ulid, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Creates or updates a subscription record.
Source§

fn write<'life0, 'async_trait>( &'life0 self, events: Vec<Event>, ) -> Pin<Box<dyn Future<Output = Result<(), WriteError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Persists events atomically. Read more
Source§

fn acknowledge<'life0, 'async_trait>( &'life0 self, key: String, cursor: Value, lag: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Updates subscription cursor after processing events.
Source§

fn get_snapshot<'life0, 'async_trait>( &'life0 self, aggregator_type: String, aggregator_revision: String, id: String, ) -> Pin<Box<dyn Future<Output = Result<Option<(Vec<u8>, Value)>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Retrieves a stored snapshot for an aggregate. Read more
Source§

fn save_snapshot<'life0, 'async_trait>( &'life0 self, aggregator_type: String, aggregator_revision: String, id: String, data: Vec<u8>, cursor: Value, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stores a snapshot for an aggregate. Read more
Source§

impl From<&Sql<MySql>> for Evento

Available on crate feature mysql only.
Source§

fn from(value: &MySql) -> Self

Converts to this type from the input type.
Source§

impl From<&Sql<Postgres>> for Evento

Available on crate feature postgres only.
Source§

fn from(value: &Postgres) -> Self

Converts to this type from the input type.
Source§

impl From<&Sql<Sqlite>> for Evento

Available on crate feature sqlite only.
Source§

fn from(value: &Sqlite) -> Self

Converts to this type from the input type.
Source§

impl<D: Database> From<Pool<D>> for Sql<D>

Source§

fn from(value: Pool<D>) -> Self

Converts to this type from the input type.
Source§

impl From<Sql<MySql>> for Evento

Available on crate feature mysql only.
Source§

fn from(value: MySql) -> Self

Converts to this type from the input type.
Source§

impl From<Sql<Postgres>> for Evento

Available on crate feature postgres only.
Source§

fn from(value: Postgres) -> Self

Converts to this type from the input type.
Source§

impl From<Sql<Sqlite>> for Evento

Available on crate feature sqlite only.
Source§

fn from(value: Sqlite) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<DB> Freeze for Sql<DB>

§

impl<DB> !RefUnwindSafe for Sql<DB>

§

impl<DB> Send for Sql<DB>

§

impl<DB> Sync for Sql<DB>

§

impl<DB> Unpin for Sql<DB>

§

impl<DB> !UnwindSafe for Sql<DB>

Blanket Implementations§

Source§

impl<E> AggregatorExecutor<E> for E
where E: Executor,

Source§

fn has_event<A>( &self, id: impl Into<String>, ) -> impl Future<Output = Result<bool, Error>> + Send
where A: AggregatorEvent,

Source§

fn original_version<A>( &self, id: impl Into<String>, ) -> impl Future<Output = Result<Option<u16>, Error>> + Send
where A: AggregatorEvent,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more