pub struct SqliteStore { /* private fields */ }Expand description
An EffectStore in a SQLite database.
Cheap to clone; clones share the connection pool and take turns to write (see the crate docs).
Implementations§
Source§impl SqliteStore
impl SqliteStore
Sourcepub async fn open(path: impl AsRef<Path>) -> Result<Self, StoreError>
pub async fn open(path: impl AsRef<Path>) -> Result<Self, StoreError>
Opens (creating if needed) the database at path, configures it for
durability (see the crate docs) and applies migrations.
§Errors
StoreError::Backend if the file cannot be opened or migrated.
Sourcepub async fn from_pool(pool: SqlitePool) -> Result<Self, StoreError>
pub async fn from_pool(pool: SqlitePool) -> Result<Self, StoreError>
Uses an existing pool and applies migrations. The pool’s connection
options are the caller’s responsibility; see the
crate docs for what Self::open sets and why.
§Errors
StoreError::Backend if migrating fails.
Sourcepub async fn attach(pool: SqlitePool) -> Result<Self, StoreError>
pub async fn attach(pool: SqlitePool) -> Result<Self, StoreError>
Uses an existing pool without migrating, after checking that every
migration is applied. For tools that must never change the schema,
such as an operator CLI, or a pool opened read-only
(?mode=ro), where reads work and every write fails.
§Errors
StoreError::Backend if the database has no migration history, or
lacks or differs from one of this crate’s migrations.
Sourcepub fn pool(&self) -> &SqlitePool
pub fn pool(&self) -> &SqlitePool
The underlying pool.
Trait Implementations§
Source§impl Clone for SqliteStore
impl Clone for SqliteStore
Source§impl Debug for SqliteStore
impl Debug for SqliteStore
Source§impl EffectStore for SqliteStore
impl EffectStore for SqliteStore
Source§async fn append_late_observation(
&self,
observation: LateObservation,
) -> Result<(), StoreError>
async fn append_late_observation( &self, observation: LateObservation, ) -> Result<(), StoreError>
Source§async fn late_observations(
&self,
id: EffectId,
after: Option<EffectId>,
limit: usize,
) -> Result<Vec<LateObservation>, StoreError>
async fn late_observations( &self, id: EffectId, after: Option<EffectId>, limit: usize, ) -> Result<Vec<LateObservation>, StoreError>
Source§async fn insert_or_get(
&self,
new: NewEffect,
) -> Result<InsertOutcome, StoreError>
async fn insert_or_get( &self, new: NewEffect, ) -> Result<InsertOutcome, StoreError>
Source§async fn get(&self, id: EffectId) -> Result<Option<EffectRecord>, StoreError>
async fn get(&self, id: EffectId) -> Result<Option<EffectRecord>, StoreError>
Source§async fn get_by_key(
&self,
key: &EffectKey,
) -> Result<Option<EffectRecord>, StoreError>
async fn get_by_key( &self, key: &EffectKey, ) -> Result<Option<EffectRecord>, StoreError>
Source§async fn acquire_lease(
&self,
id: EffectId,
owner: &WorkerId,
now: SystemTime,
ttl: Duration,
) -> Result<Lease, StoreError>
async fn acquire_lease( &self, id: EffectId, owner: &WorkerId, now: SystemTime, ttl: Duration, ) -> Result<Lease, StoreError>
EffectRecord::acquire_lease.Source§async fn renew_lease(
&self,
lease: &Lease,
now: SystemTime,
ttl: Duration,
) -> Result<Lease, StoreError>
async fn renew_lease( &self, lease: &Lease, now: SystemTime, ttl: Duration, ) -> Result<Lease, StoreError>
EffectRecord::renew_lease.Source§async fn release_lease(&self, lease: &Lease) -> Result<(), StoreError>
async fn release_lease(&self, lease: &Lease) -> Result<(), StoreError>
EffectRecord::release_lease. Releasing a
lease that was already lost is not an error.Source§async fn transition(
&self,
request: TransitionRequest,
) -> Result<EffectRecord, StoreError>
async fn transition( &self, request: TransitionRequest, ) -> Result<EffectRecord, StoreError>
EffectRecord::apply, and appends
its audit event in the same atomic unit. Returns the updated record.Source§async fn list(&self, query: ListQuery) -> Result<Vec<EffectRecord>, StoreError>
async fn list(&self, query: ListQuery) -> Result<Vec<EffectRecord>, StoreError>
query, ordered by id (creation time).Source§async fn events(&self, id: EffectId) -> Result<Vec<EffectEvent>, StoreError>
async fn events(&self, id: EffectId) -> Result<Vec<EffectEvent>, StoreError>
Source§async fn prune(&self, query: PruneQuery) -> Result<u64, StoreError>
async fn prune(&self, query: PruneQuery) -> Result<u64, StoreError>
query.limit records matching query, lowest id
first, together with their audit events, and returns how many it
deleted. Each record is checked and deleted atomically, so a record
that a worker leases or changes concurrently is either deleted before
that change or not at all. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for SqliteStore
impl !UnwindSafe for SqliteStore
impl Forget for SqliteStore
impl Freeze for SqliteStore
impl Move for SqliteStore
impl Send for SqliteStore
impl Sync for SqliteStore
impl Unpin for SqliteStore
impl UnsafeUnpin for SqliteStore
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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