Skip to main content

TransactionManager

Struct TransactionManager 

Source
pub struct TransactionManager { /* private fields */ }
Expand description

Manages all transactions in the database

Implementations§

Source§

impl TransactionManager

Source

pub fn new() -> Self

Create a new transaction manager

For new databases, use this constructor. For restoring from a persisted database, use TransactionManager::with_start_txn_id() instead.

Source

pub fn with_start_txn_id(start_txn_id: u64) -> Self

Create a new transaction manager with a specific starting transaction ID.

Used when restoring from a persisted database to maintain MVCC visibility. The start_txn_id should be the value persisted from the previous session, ensuring transaction IDs remain monotonically increasing across restarts.

For new databases, use TransactionManager::new() instead.

Source

pub fn next_txn_id(&self) -> u64

Get the current next transaction ID (for persistence)

This value should be persisted to ensure transaction IDs remain monotonically increasing across database restarts.

Source

pub fn begin(&self, mode: TransactionMode) -> Transaction<'_>

Begin a new transaction with default configuration

Source

pub fn begin_with_config( &self, mode: TransactionMode, config: TransactionConfig, ) -> Transaction<'_>

Begin a new transaction with specific configuration

Source

pub fn begin_read_only(&self) -> Transaction<'_>

Begin a read-only transaction

Source

pub fn begin_read_write(&self) -> Transaction<'_>

Begin a read-write transaction

Source

pub fn commit_txn(&self, txn_id: TransactionId) -> Result<()>

Commit a transaction (public API without WAL)

Source

pub fn abort_txn(&self, txn_id: TransactionId) -> Result<()>

Abort a transaction (public API without WAL)

Source

pub fn add_snapshot_ancestor( &self, txn_id: TransactionId, ancestor: TransactionId, )

Record a write operation for conflict detection (first-committer-wins).

Called by the DML executor for each row modified by INSERT, UPDATE, or DELETE. The (table_name, pk_bytes) pair is added to the transaction’s write set, which is checked against committed write sets at commit time. Add an ancestor to a transaction’s snapshot (for savepoint support).

When a savepoint creates a sub-transaction, the sub-transaction needs to recognize the parent transaction as an ancestor so that write-write conflict detection doesn’t flag writes from the same logical transaction.

Source

pub fn record_write( &self, txn_id: TransactionId, table: String, pk_bytes: Vec<u8>, ) -> Result<()>

Record a write and check for conflicts (first-committer-wins).

Returns Err(WriteConflict) if another transaction has already written to the same (table, pk) — either committed after our snapshot or still active.

Source

pub fn acquire_write_lock(&self) -> impl Drop + '_

Acquire write lock for exclusive writing

Source

pub fn oldest_active_txn(&self) -> Option<TransactionId>

Get the oldest active transaction ID

Source

pub fn version_store(&self) -> &RwLock<VersionStore>

Get the version store

Source

pub fn active_count(&self) -> usize

Get number of active transactions

Source

pub fn has_aborted_transactions(&self) -> bool

Quick check whether any aborted transactions exist. When false, all is_aborted calls are guaranteed to return false.

Source

pub fn is_aborted(&self, txn_id: TransactionId) -> bool

Check if a transaction was aborted

Source

pub fn is_row_visible( &self, snapshot: &Snapshot, created_by: TransactionId, deleted_by: Option<TransactionId>, ) -> bool

Check if a row is visible to a snapshot, accounting for aborted transactions.

A row is visible if:

  1. The creating transaction was NOT aborted
  2. The snapshot can see the creating transaction (per standard MVCC rules)
  3. Either the row is not deleted, the deleting transaction was aborted, or the snapshot cannot see the deletion
Source

pub fn aborted_count(&self) -> usize

Get the number of aborted transactions being tracked

Source

pub fn cleanup_aborted_txns(&self, older_than: TransactionId)

Clean up old aborted transaction IDs that are no longer needed.

Aborted transaction IDs can be removed once all their written data has been garbage collected. This is typically safe to do when the aborted transaction ID is older than any active transaction’s snapshot, since all such data would have been cleaned up by GC.

Source

pub fn register_dirty_page(&self, txn_id: TransactionId, page_id: PageId)

Register a page as dirtied by a transaction

This is called when a transaction modifies a page. The page ID is tracked so that on commit, only this transaction’s pages are flushed, and on abort, they can be discarded.

Source

pub fn get_dirty_pages(&self, txn_id: TransactionId) -> HashSet<PageId>

Get all pages dirtied by a transaction

Source

pub fn clear_dirty_pages(&self, txn_id: TransactionId)

Clear dirty page tracking for a transaction (called on commit/abort)

Source

pub fn dirty_page_count(&self, txn_id: TransactionId) -> usize

Get the number of dirty pages for a transaction

Source

pub fn run_gc(&self) -> GcStats

Run garbage collection on old versions.

Removes old versions that no active transaction can see. Returns statistics about what was collected.

Source

pub fn version_count(&self) -> usize

Get the number of old versions in the version store

Source

pub fn long_running_transactions( &self, threshold: Duration, ) -> Vec<TransactionInfo>

Get information about long-running transactions

Returns a list of transactions that have been running longer than the specified threshold, sorted by age (oldest first).

Source

pub fn gc_status(&self) -> GcStatus

Get current GC status

Returns information about whether garbage collection is blocked by active transactions.

Source

pub fn metrics(&self) -> TransactionMetricsSnapshot

Get transaction metrics snapshot

Returns a snapshot of transaction metrics including active count, commits, rollbacks, and average transaction duration.

Trait Implementations§

Source§

impl Default for TransactionManager

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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