fsqlite-pager 0.2.0

Page cache and journal management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

#![cfg_attr(target_arch = "x86_64", allow(internal_features))]
#![cfg_attr(target_arch = "x86_64", feature(core_intrinsics))]
// bd-h9o9r: this crate's engine futures are deliberately not `Send` — pager
// state is driven on a current-thread runtime and several futures hold
// std::sync mutex guards across awaits (each such site carries its own
// `#[allow(clippy::await_holding_lock)]` audit tag). Requiring `Send`
// futures contradicts that design, so the lint is noise here; every other
// workspace crate keeps it enabled.
#![allow(clippy::future_not_send)]
// bd-h9o9r: the `fn f<'a>(..) -> impl Future + 'a { async move { .. } }`
// trait-impl shape predates async-fn-in-trait and appears at 36 sites with
// large bodies. Converting them is pure whitespace churn in files under
// active Phase-C reconstruction; new code should still prefer `async fn`.
#![allow(clippy::manual_async_fn)]

pub mod arc_cache;
#[cfg(feature = "encryption")]
pub mod encrypt;
#[cfg(feature = "evalue-eviction")]
pub mod evalue_eviction;
#[cfg(any(test, feature = "fault-injection"))]
pub mod fault_hooks;
pub mod journal;
pub mod page_buf;
pub mod page_cache;
pub mod pager;
pub mod s3_fifo;
pub mod submodular_prefetch;
pub mod thompson_partitioner;
pub mod traits;

pub use arc_cache::{ArcCache, ArcCacheInner, ArcEvictionModel, CacheKey, CacheLookup, CachedPage};
#[cfg(feature = "encryption")]
pub use encrypt::{
    Argon2Params, DATABASE_ID_SIZE, DatabaseId, ENCRYPTION_RESERVED_BYTES, EncryptError, KEY_SIZE,
    KeyManager, NONCE_SIZE, PageEncryptor, TAG_SIZE, validate_reserved_bytes,
};
#[cfg(feature = "evalue-eviction")]
pub use evalue_eviction::{
    DEFAULT_INITIAL_E, DEFAULT_R_HIT, DEFAULT_R_TICK, DEFAULT_TICK_INTERVAL, E_VALUE_CEIL,
    E_VALUE_FLOOR, EValueEvictor,
};
pub use journal::{
    CHECKSUM_STRIDE, JOURNAL_HEADER_SIZE, JOURNAL_MAGIC, JournalError, JournalHeader,
    JournalPageRecord, PENDING_BYTE_OFFSET, checksum_sample_count, journal_checksum,
    lock_byte_page,
};
pub use page_buf::{
    PageBuf, PageBufPool, PageBufPoolMetricsSnapshot, page_buffer_pool_metrics_snapshot,
    reset_page_buffer_pool_metrics,
};
pub use page_cache::{
    ArcEvictionConfig, DEFAULT_PAGE_BUFFER_MAX, PageCache, PageCacheEvictionPolicy,
    PageCacheLightweightSnapshot, PageCacheMetricsSnapshot, PageCachePageSnapshot,
    PageCacheQueueKind, ShardedPageCache, resolve_page_buffer_max,
};
pub use pager::{
    ConnectionPagerOpenMode, PAGER_METADATA_PUBLICATION_CONTRACTS, PagerCommitProfileSnapshot,
    PagerMetadataPublicationClass, PagerMetadataPublicationContract, PagerPublishedSnapshot,
    ParallelWalPublicationIntent, SimplePager, SimplePagerCheckpointWriter, SimpleTransaction,
    WalCommitSyncPolicy, pager_commit_profile_enabled, pager_commit_profile_snapshot,
    remove_group_commit_queue, reset_pager_commit_profile,
    reset_staged_page_overwrite_steals_total, set_pager_commit_profile_enabled,
    staged_page_overwrite_steals_total,
};
pub use s3_fifo::{
    QueueKind, QueueLocation, RolloutDecision, RolloutMetrics, RolloutPolicy, S3Fifo, S3FifoConfig,
    S3FifoEvent, S3FifoRolloutGate,
};
pub use submodular_prefetch::{Candidate as PrefetchCandidate, expected_gain, greedy_select};
pub use thompson_partitioner::{BetaArm, RESAMPLE_INTERVAL, ThompsonPartitioner};
pub use traits::{
    CheckpointMode, CheckpointPageWriter, CheckpointResult, JournalMode, MemoryMockMvccPager,
    MemoryMockTransaction, MockCheckpointPageWriter, MockMvccPager, MockTransaction, MvccPager,
    PagerCommitState, ParallelWalCommitReconciliation, TransactionHandle, TransactionKind,
    TransactionMode, WalBackend, WalPublicationSnapshot,
};