coven_database/
lib.rs

1//! The store's SQLite database, protected internal tables and app migrations.
2//!
3//! [`DatabaseBuilder`] opens a store with one locked writer and read-only
4//! connections, or with read-only connections alone. App SQL runs inside the
5//! borrowed [`MigrationContext`] or [`SqlContext`]; no raw connection leaves its
6//! owner. A local write commits its app rows, unsigned record and merge metadata
7//! together on the writer connection.
8
9mod author_judgement;
10mod authorization;
11mod authorship;
12mod change_capture;
13mod coven_functions;
14mod sql_functions;
15mod sql_versions;
16pub use sql_functions::{Determinism, FunctionArguments, SqlFunctions};
17mod database;
18mod declaration;
19mod derived;
20mod device_reset;
21mod dismissal;
22mod download;
23mod download_checks;
24mod download_stage;
25mod download_stream;
26mod error;
27mod execution_capture;
28mod file_hashes;
29mod file_location;
30mod file_moves;
31mod file_pins;
32mod file_queue;
33mod file_ref;
34mod file_removals;
35mod file_table;
36mod file_write;
37mod from_item;
38mod insert_rows;
39mod internal_schema;
40mod interpretation;
41mod joined_invitee;
42mod judge;
43mod judge_view;
44mod live_query;
45#[cfg(any(test, feature = "test-utils"))]
46mod live_query_runs;
47mod load_step;
48mod loss_record;
49mod lost;
50mod members;
51mod merge_store;
52mod migration;
53mod migration_change;
54mod migration_files;
55mod migration_hidden;
56mod migration_names;
57mod migration_receive;
58mod migration_references;
59mod migration_run;
60mod migration_snapshot;
61mod migration_state;
62mod observation;
63pub use load_step::LoadStep;
64mod open_step;
65mod ownership;
66pub use open_step::OpenStep;
67mod object_removals;
68mod pending;
69mod provider_access;
70mod raise_capture;
71mod row_cache;
72mod row_scope;
73mod scope_lookup;
74mod scope_plan;
75mod scope_term;
76mod select_syntax;
77pub use object_removals::ObjectRemoval;
78pub use provider_access::{
79    ProviderAccess, ProviderAccessChange, ProviderAccessRequest, REQUEST_FIXED_STEP,
80};
81pub use raise_capture::RaiseCapture;
82mod cache_progress;
83mod read;
84mod read_capture;
85pub use cache_progress::PinProgress;
86mod removal;
87mod removal_schema;
88mod removal_sql;
89mod removal_view;
90mod reserved_names;
91mod retry;
92mod stored_millis;
93pub use internal_schema::retry_effect::{RetryState, RetrySync};
94pub use internal_schema::sync_status::{RecordedLocation, SyncStatusRow};
95pub use retry::{RetrySubject, RetryWait};
96pub use stored_millis::stored_time;
97mod row_key;
98mod row_queries;
99mod schema;
100mod schema_error;
101mod schema_local_children;
102mod schema_source;
103mod snapshot_conflicts;
104mod snapshot_coverage;
105mod snapshot_error;
106mod snapshot_files;
107mod snapshot_install;
108mod snapshot_layout;
109mod snapshot_load;
110mod snapshot_materialize;
111mod snapshot_metadata;
112mod snapshot_preparation;
113mod snapshot_reload;
114mod snapshot_state;
115mod snapshot_write;
116mod snapshot_writes;
117mod sql;
118mod sql_read;
119mod sql_value;
120mod sqlite;
121mod sqlite_path;
122mod sqlite_settings;
123mod sqlite_temporary;
124mod sync_facts;
125pub use sqlite_settings::{
126    AnalysisLimit, AutoVacuum, CacheSize, CacheSpill, CheckpointMode, IncrementalVacuum,
127    JournalSizeLimit, PageSize, SecureDelete, SqliteSettings, SqliteSettingsInEffect, TempStore,
128    WalAutocheckpoint, WalCheckpoint,
129};
130pub use sqlite_temporary::{set_temporary_directory, TemporaryDirectoryError};
131pub use sync_facts::{SyncFacts, UploadFacts};
132mod written_values;
133pub use file_hashes::{FileHasher, FileHashes};
134pub use file_moves::MoveId;
135pub use file_pins::PinRequest;
136pub use file_write::{DeviceOnlyCopy, Journal, MoveFile};
137pub use pending::{FileWork, PendingValue};
138mod file_protection;
139mod network_facts;
140mod planner_statistics;
141mod source_names;
142mod transfer_watch;
143mod transfers_in_flight;
144mod upkeep;
145mod upload;
146mod wal_checkpoints;
147pub use transfer_watch::{TransferChange, TransferEnd, TransferWatch};
148pub use transfers_in_flight::{InFlight, TransferMeter, TransferProgress, Transferring};
149mod user_file;
150mod write;
151mod write_apply;
152mod write_batch;
153mod write_boundary;
154mod write_capture;
155mod write_commit;
156mod write_commit_store;
157mod write_encoding;
158mod write_failure;
159mod write_headers;
160mod write_record;
161mod write_rows;
162mod write_schema;
163mod write_sources;
164
165pub use authorship::{Authorship, HeaderEvidence};
166pub use coven_merge::Slot;
167pub use coven_merge::WriteId;
168pub use database::file_database::{
169    CacheReservation, CopyReservation, FileDatabase, FolderCopy, LocalEvidence, PreparedDeviceOnly,
170    PreparedPin,
171};
172pub use database::file_retention::FileCandidate;
173#[cfg(any(test, feature = "test-utils"))]
174pub use database::input_database::StagedDamage;
175pub use database::input_database::{
176    FileEvidence, InputBudget, RetainedBytes, RetainedInput, RetainedRange, SnapshotStaging,
177    StagedDigest, UnprovenFiles,
178};
179pub use database::local_bytes::{CacheBytes, LocalBytes, LocalBytesWatch, NamespaceBytes};
180pub use database::{
181    closed_sync_facts, discarded_operations, discarded_store_name, read_store_name, Database,
182    DatabaseBuilder, Mode, ReadOnly, StagedFiles, Writer,
183};
184pub use declaration::{
185    Binding, FileColumn, Namespace, Provenance, RowIdentity, SyncedTable, BOUND_FILE_LIMIT,
186};
187pub use download::{ApplyOutcome, WriteWait};
188#[cfg(test)]
189use download::{DownloadedPart, DownloadedWrite};
190pub use download_stream::{DownloadedPartStream, DownloadedWriteStream, WriteAuthorship};
191pub use error::{sqlite_error_is_disk, CovenMigrationError, DbError, MigrationError, OpenError};
192pub use file_location::{FileLocation, FileLocationKey};
193pub use file_queue::{FileUpload, UnsentWork, UploadCompletion, UploadProgress, UploadQueueState};
194pub use file_ref::{FilePlace, FileRef, LocalFileError, LocalFileStream};
195pub use live_query::{
196    LiveQuery, LiveQueryCause, LiveQueryClosed, LiveQueryRequests, LiveQueryRevision,
197    ReconfigurableLiveQuery, ReconfigurableLiveQueryEvent,
198};
199#[cfg(any(test, feature = "test-utils"))]
200pub use live_query_runs::LiveQueryRuns;
201pub use lost::{
202    ChangeSource, Lost, LostCell, LostValue, RemovalRule, Replacement, RowAuthorizationFailure,
203};
204pub use members::{Circle, CircleMemberInfo, DeviceInfo, MemberInfo};
205pub use migration::{Migration, MigrationChange, MigrationContext, MigrationOutcome, OldWrites};
206pub use migration_change::{ChangeOp, ColumnChange, RowChange};
207pub use read::{Read, SqlReadContext};
208pub use row_key::RowKey;
209pub use schema_error::SchemaError;
210pub use snapshot_error::SnapshotError;
211pub use snapshot_reload::{LoadedSnapshot, SnapshotReload, SnapshotSource};
212pub use snapshot_write::SnapshotWriteError;
213pub use sql_read::SqlRead;
214#[cfg(any(test, feature = "test-utils"))]
215pub use upload::UploadReadError;
216pub use upload::{PreparedUploads, UploadBytes, UploadParts, UploadPlaintext, WaitingUpload};
217pub use user_file::{prepare_user_file, unix_seconds_and_nanos, PreparedUserFile, UserFile};
218pub use write::{BulkSqlContext, SqlContext};
219pub use write_batch::{FileSource, Place, WriteBatch};
220pub use write_boundary::{Boundary, BoundaryCoverage};
221pub use write_failure::WriteFailure;
222
223// SQL values, parameters and callback results are public. Connections remain private.
224pub use rusqlite::{
225    named_params, params, types, Error as SqliteError, Params, Result as SqliteResult, Row, ToSql,
226};
227
228#[cfg(any(test, feature = "test-utils"))]
229pub mod test_utils;
230
231#[cfg(test)]
232#[path = "lib_tests.rs"]
233pub(crate) mod tests;
234
235mod operation;
236pub use operation::{NewOperation, OperationId, OperationRecord, OperationUpdate};
237pub mod operation_kind;
238mod operation_outcome;
239pub use operation_outcome::{
240    slot_json, DeviceStop, EntryTarget, OperationOutcome, OperationRejection, UndoCause,
241};
242
243mod commit_scope;
244pub use commit_scope::CommitScope;
245mod prerequisite_rows;
246pub use observation::AttemptCommits;
247pub use prerequisite_rows::PrerequisiteRows;
248mod database_changes;
249pub use database_changes::DatabaseChanges;
250
251mod captured_changes;
252mod claim;
253mod forget_entries;
254mod forget_records;
255mod published;
256mod published_migration;
257mod queued_writes;
258mod reload_gate;
259mod sequence;
260mod sequence_apply;
261mod snapshot_view;
262mod store_state;
263mod store_state_tables;
264mod write_metadata;
265pub use claim::{
266    Claim, ClaimAttempt, ClaimBytes, ClaimRead, ClaimSettlement, ClaimUpload, ClaimWork,
267};
268pub use forget_records::Writers;
269pub use sequence::WriteCutoff;
270pub use sequence_apply::{AdminEffect, IncomingSlot, SlotContent};
271pub use store_state::{
272    DeviceState, StoreCircle, StoreDevice, StoreIdentity, StoreMember, StoreState, StoreVersion,
273};
274
275mod claim_preparation;
276mod input_preparation;
coven_database/lib.rs

coven_database/
lib.rs
