Struct mz_stash::Stash

pub struct Stash {
    pub metrics: Arc<Metrics>,
    /* private fields */
}

A Stash whose data is stored in a Postgres-compatible database. The format of the tables are not specified and should not be relied upon. The only promise is stability. Any changes to the table schemas will be accompanied by a clear migration path.

Fields

metrics: Arc<Metrics>

Implementations

impl Stash

pub async fn clear(url: &str, tls: MakeTlsConnector) -> Result<(), StashError>

Drops all tables associated with the stash if they exist. Only used in tests and benchmarks.

pub async fn with_debug_stash<F, T, Fut>(f: F) -> Result<T, StashError>

where F: FnOnce(Stash) -> Fut, Fut: Future<Output = T>,

Creates a debug stash from the current COCKROACH_URL with a random schema, and DROPs it after f has returned.

pub async fn set_connect_timeout(&mut self, connect_timeout: Duration)

impl Stash

pub async fn collections(&mut self) -> Result<BTreeMap<i64, String>, StashError>

Returns a mapping from stash collection Id to stash collection name.

pub async fn confirm_leadership(&mut self) -> Result<(), StashError>

Returns Ok if the stash is the current leader and an error otherwise.

Note: This can be optimized to not increment the version, which is done automatically via with_commit. It will probably be more efficient to retry an in-determinate read-only transaction than relying on incrementing the version.

pub fn is_writeable(&self) -> bool

pub fn is_readonly(&self) -> bool

pub fn is_savepoint(&self) -> bool

pub fn epoch(&self) -> Option<NonZeroI64>

impl Stash

pub async fn with_transaction<F, T>(&mut self, f: F) -> Result<T, StashError>

where F: FnOnce(Transaction<'_>) -> BoxFuture<'_, Result<T, StashError>> + Clone + Sync + Send + 'static,

Transactionally executes closure f.

Trait Implementations

impl Debug for Stash

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.