Struct StoredWatermark

pub struct StoredWatermark {
    pub pipeline: String,
    pub epoch_hi_inclusive: i64,
    pub checkpoint_hi_inclusive: i64,
    pub tx_hi: i64,
    pub epoch_lo: i64,
    pub reader_lo: i64,
    pub timestamp_ms: i64,
    pub pruner_hi: i64,
}

Represents a row in the watermarks table.

Fields

pipeline: String

The table governed by this watermark, i.e epochs, checkpoints, transactions.

epoch_hi_inclusive: i64

Inclusive upper epoch bound for this entity’s data. Committer updates this field. Pruner uses this to determine if pruning is necessary based on the retention policy.

checkpoint_hi_inclusive: i64

Inclusive upper checkpoint bound for this entity’s data. Committer updates this field. All data of this entity in the checkpoint must be persisted before advancing this watermark. The committer refers to this on disaster recovery to resume writing.

tx_hi: i64

Exclusive upper transaction sequence number bound for this entity’s data. Committer updates this field.

epoch_lo: i64

Inclusive lower epoch bound for this entity’s data. Pruner updates this field when the epoch range exceeds the retention policy.

reader_lo: i64

Inclusive low watermark that the pruner advances. Corresponds to the epoch id, checkpoint sequence number, or tx sequence number depending on the entity. Data before this watermark is considered pruned by a reader. The underlying data may still exist in the db instance.

timestamp_ms: i64

Updated using the database’s current timestamp when the pruner sees that some data needs to be dropped. The pruner uses this column to determine whether to prune or wait long enough that all in-flight reads complete or timeout before it acts on an updated watermark.

pruner_hi: i64

Column used by the pruner to track its true progress. Data below this watermark can be immediately pruned.

Implementations

impl StoredWatermark

pub fn from_upper_bound_update( entity: &str, watermark: CommitterWatermark, ) -> Self

pub fn from_lower_bound_update( entity: &str, epoch_lo: u64, reader_lo: u64, ) -> Self

pub fn entity(&self) -> Option<PrunableTable>

pub fn new_epoch_lo(&self, retention: u64) -> Option<u64>

Determine whether to set a new epoch lower bound based on the retention policy.

Trait Implementations

impl Clone for StoredWatermark

fn clone(&self) -> StoredWatermark

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for StoredWatermark

fn default() -> StoredWatermark

Returns the “default value” for a type.

impl<'insert> Insertable<table> for &'insert StoredWatermark

type Values = <(Option<Grouped<Eq<pipeline, <&'insert String as AsExpression<<pipeline as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<epoch_hi_inclusive, <&'insert i64 as AsExpression<<epoch_hi_inclusive as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<checkpoint_hi_inclusive, <&'insert i64 as AsExpression<<checkpoint_hi_inclusive as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<tx_hi, <&'insert i64 as AsExpression<<tx_hi as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<epoch_lo, <&'insert i64 as AsExpression<<epoch_lo as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<reader_lo, <&'insert i64 as AsExpression<<reader_lo as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<timestamp_ms, <&'insert i64 as AsExpression<<timestamp_ms as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<pruner_hi, <&'insert i64 as AsExpression<<pruner_hi as Expression>::SqlType>>::Expression>>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values( self, ) -> <(Option<Eq<pipeline, &'insert String>>, Option<Eq<epoch_hi_inclusive, &'insert i64>>, Option<Eq<checkpoint_hi_inclusive, &'insert i64>>, Option<Eq<tx_hi, &'insert i64>>, Option<Eq<epoch_lo, &'insert i64>>, Option<Eq<reader_lo, &'insert i64>>, Option<Eq<timestamp_ms, &'insert i64>>, Option<Eq<pruner_hi, &'insert i64>>) as Insertable<table>>::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl Insertable<table> for StoredWatermark

type Values = <(Option<Grouped<Eq<pipeline, <String as AsExpression<<pipeline as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<epoch_hi_inclusive, <i64 as AsExpression<<epoch_hi_inclusive as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<checkpoint_hi_inclusive, <i64 as AsExpression<<checkpoint_hi_inclusive as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<tx_hi, <i64 as AsExpression<<tx_hi as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<epoch_lo, <i64 as AsExpression<<epoch_lo as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<reader_lo, <i64 as AsExpression<<reader_lo as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<timestamp_ms, <i64 as AsExpression<<timestamp_ms as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<pruner_hi, <i64 as AsExpression<<pruner_hi as Expression>::SqlType>>::Expression>>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values( self, ) -> <(Option<Eq<pipeline, String>>, Option<Eq<epoch_hi_inclusive, i64>>, Option<Eq<checkpoint_hi_inclusive, i64>>, Option<Eq<tx_hi, i64>>, Option<Eq<epoch_lo, i64>>, Option<Eq<reader_lo, i64>>, Option<Eq<timestamp_ms, i64>>, Option<Eq<pruner_hi, i64>>) as Insertable<table>>::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6, __ST7> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6, __ST7), __DB> for StoredWatermark

where (String, i64, i64, i64, i64, i64, i64, i64): FromStaticSqlRow<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6, __ST7), __DB>,

type Row = (String, i64, i64, i64, i64, i64, i64, i64)

The Rust type you’d like to map from.

fn build(row: Self::Row) -> Result<Self>

Construct an instance of this type

impl<__DB: Backend> QueryableByName<__DB> for StoredWatermark

where String: FromSql<SqlTypeOf<pipeline>, __DB>, i64: FromSql<SqlTypeOf<epoch_hi_inclusive>, __DB> + FromSql<SqlTypeOf<checkpoint_hi_inclusive>, __DB> + FromSql<SqlTypeOf<tx_hi>, __DB> + FromSql<SqlTypeOf<epoch_lo>, __DB> + FromSql<SqlTypeOf<reader_lo>, __DB> + FromSql<SqlTypeOf<timestamp_ms>, __DB> + FromSql<SqlTypeOf<pruner_hi>, __DB>,

fn build<'__a>(row: &impl NamedRow<'__a, __DB>) -> Result<Self>

Construct an instance of Self from the database row

impl UndecoratedInsertRecord<table> for StoredWatermark