Expand description
Public API facade for FrankenSQLite.
This crate will grow a stable, ergonomic API surface over time. In early phases it also re-exports selected internal crates for integration tests.
Re-exports§
pub use fsqlite_vfs;
Modules§
- compat
- rusqlite-compatible adapter layer for FrankenSQLite.
- migrate
- Lightweight schema migration framework for FrankenSQLite.
Macros§
- params
- Construct a parameter slice from heterogeneous values, analogous to
rusqlite::params!.
Structs§
- Bounded
Database Structural Stats - Whole-database-image capture, bounded structural proof, and publication.
- Bounded
Structural Snapshot - A pinned, structurally-proven snapshot of an external database image.
- Connection
- Connection
Env - Connection-scoped environment for selecting the runtime context and tuning resource limits.
- Database
Builder Reservation - An atomically claimed, identity-bound pathname for building a replacement database image.
- Database
Image Receipt - Database
Namespace Generation Transition - Exclusive namespace lease spanning caller-owned generation replacement.
- File
Identity - Opaque identity of an already-open filesystem object.
- Page
Cache Peak Snapshot - Whole-database-image capture, bounded structural proof, and publication.
- Pending
Database Image Publication - A whole-image publication held open at the last point before commit.
- Prepared
Statement - Row
- A database row produced by a query.
- Runtime
Config - Configuration for the process-global runtime context.
- Runtime
Context - Process-global runtime handle shared by all database regions.
- Trace
Mask - Compatibility mask for sqlite3_trace_v2-style callbacks.
- Write
SetStats - Whole-database-image capture, bounded structural proof, and publication.
Enums§
- Database
Image Publication - Outcome of a whole-database-image publication that crossed its commit point.
- Database
Image Publication Error Class - Durable outcome class for a failed whole-database-image publication.
- Franken
Error - Primary error type for FrankenSQLite operations.
- IoPoll
Strategy - I/O polling strategy for the shared runtime context.
- Namespace
Generation Transition Outcome - Durable result of an exact namespace-generation transition.
- Sqlite
Value - A dynamically-typed SQLite value.
- Trace
Event - sqlite3_trace_v2-style callback event payload.
Functions§
- begin_
database_ namespace_ generation_ transition - Begin an exact namespace-generation transition before mutating the path.
- init_
global_ runtime - Install or replace the process-global runtime context used by
Connection::open.