Skip to main content

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 app_policy;
10mod audience_database;
11mod author_judgement;
12mod authorship;
13mod before_commit;
14mod coven_functions;
15mod sql_functions;
16mod sql_versions;
17pub use sql_functions::{Determinism, FunctionArguments, SqlFunctions};
18mod database;
19mod declaration;
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 insert_rows;
38mod internal_schema;
39mod interpretation;
40mod joining_write;
41mod judge;
42mod judge_view;
43mod live_results;
44mod load_step;
45mod local_write;
46mod loss_record;
47mod lost;
48mod members;
49mod merge_store;
50mod migration;
51mod migration_change;
52mod migration_files;
53mod migration_hidden;
54mod migration_names;
55mod migration_receive;
56mod migration_references;
57mod migration_run;
58mod migration_snapshot;
59mod migration_state;
60mod reported_engine_errors;
61pub use load_step::LoadStep;
62mod open_error;
63mod open_step;
64mod ownership;
65mod permission;
66pub use open_step::OpenStep;
67mod object_removals;
68mod pending;
69mod provider_access;
70mod raise_capture;
71mod reset_bytes;
72mod row_cache;
73pub use object_removals::ObjectRemoval;
74pub use provider_access::{
75    ProviderAccess, ProviderAccessChange, ProviderAccessRequest, REQUEST_FIXED_STEP,
76};
77pub use raise_capture::RaiseCapture;
78mod cache_progress;
79mod read;
80pub use cache_progress::PinProgress;
81mod inserted_rows;
82mod removal;
83mod removal_schema;
84mod removal_sql;
85mod removal_view;
86mod reserved_names;
87mod retry;
88mod stored_millis;
89pub use internal_schema::retry_effect::{RetryState, RetrySync};
90pub use internal_schema::sync_status::{PassMove, RecordedLocation, StoredLocation, SyncStatusRow};
91pub use retry::{RetrySubject, RetryWait};
92pub use stored_millis::stored_time;
93mod row_key;
94mod row_queries;
95mod schema;
96mod schema_error;
97mod schema_local_children;
98mod schema_preparation;
99mod schema_source;
100mod schema_sql;
101mod snapshot_conflicts;
102mod snapshot_coverage;
103mod snapshot_error;
104mod snapshot_files;
105mod snapshot_install;
106mod snapshot_layout;
107mod snapshot_load;
108mod snapshot_materialize;
109mod snapshot_metadata;
110mod snapshot_preparation;
111mod snapshot_reload;
112mod snapshot_state;
113mod snapshot_write;
114mod snapshot_writes;
115mod sql_read;
116mod sqlite;
117mod store_call;
118mod sync_facts;
119mod sync_functions;
120mod transaction_constants;
121pub use sqlive::{set_temporary_directory, TemporaryDirectoryError};
122pub use sqlive::{
123    AnalysisLimit, AutoVacuum, CacheSize, CacheSpill, CheckpointMode, IncrementalVacuum,
124    JournalSizeLimit, PageSize, SecureDelete, SqliteSettings, SqliteSettingsInEffect, TempStore,
125    WalAutocheckpoint, WalCheckpoint,
126};
127pub use sync_facts::{
128    QueueFacts, SyncFacts, TransferHolds, UploadFacts, UploadPhaseFacts, UploadRecords,
129};
130pub use sync_functions::{SyncFunctions, SyncStateRow, UploadPhaseRow};
131mod written_values;
132pub use file_hashes::{FileHasher, FileHashes};
133pub use file_moves::MoveId;
134pub use file_pins::PinRequest;
135pub use file_write::{DeviceOnlyCopy, Journal, MoveFile};
136pub use pending::{FileWork, PendingValue};
137mod file_protection;
138mod memory_facts;
139mod network_facts;
140mod source_names;
141mod transfer_watch;
142mod transfers_in_flight;
143mod upload;
144pub use transfer_watch::{TransferChange, TransferEnd, TransferWatch};
145pub use transfers_in_flight::{InFlight, TransferMeter, TransferProgress, Transferring};
146mod user_file;
147mod write;
148mod write_apply;
149mod write_batch;
150mod write_boundary;
151mod write_capture;
152mod write_commit;
153mod write_commit_store;
154mod write_encoding;
155mod write_failure;
156mod write_headers;
157mod write_record;
158mod write_rows;
159mod write_schema;
160mod write_sources;
161
162pub use authorship::{Authorship, HeaderEvidence};
163pub use coven_merge::Slot;
164pub use coven_merge::WriteId;
165pub use database::file_database::{
166    CacheReservation, CopyReservation, FileDatabase, FolderCopy, LocalEvidence, PreparedDeviceOnly,
167    PreparedPin,
168};
169pub use database::file_retention::FileCandidate;
170#[cfg(any(test, feature = "test-utils"))]
171pub use database::input_database::StagedDamage;
172pub use database::input_database::{
173    FileEvidence, InputBudget, RetainedBytes, RetainedInput, RetainedRange, SnapshotStaging,
174    StagedDigest, UnprovenFiles,
175};
176pub use database::local_bytes::{CacheBytes, LocalBytes, NamespaceBytes};
177pub use database::{
178    closed_sync_facts, discarded_operations, discarded_store_name, read_device_id_in_use,
179    read_store_name, DatabaseBuilder, ExportStopped, Mode, ReadOnly, RebuildDatabase, RebuildError,
180    StagedFiles, StoreDatabase, Writer,
181};
182pub use declaration::{
183    Binding, FileColumn, Namespace, Provenance, RowIdentity, SyncedTable, WritePermission,
184    BOUND_FILE_LIMIT,
185};
186pub use download::{ApplyOutcome, WriteWait};
187#[cfg(test)]
188use download::{DownloadedPart, DownloadedWrite};
189pub use download_stream::{DownloadedPartStream, DownloadedWriteStream, WriteAuthorship};
190pub use error::{sqlite_error_is_disk, DbError};
191pub use file_location::{FileLocation, FileLocationKey};
192pub use file_queue::{FileUpload, UnsentWork, UploadCompletion, UploadProgress, UploadQueueState};
193pub use file_ref::{FilePlace, FileRef, LocalFileError, LocalFileStream, Located};
194pub use live_results::next_result;
195pub use lost::{
196    ChangeSource, Lost, LostCell, LostValue, RemovalRule, Replacement, RowAuthorizationFailure,
197};
198pub use members::{Circle, CircleMemberInfo, DeviceInfo, MemberInfo};
199pub use migration::{
200    newest_breaking_version, Migration, MigrationChange, MigrationContext, MigrationOutcome,
201    OldWrites,
202};
203pub use migration_change::{ChangeOp, ColumnChange, RowChange};
204pub use open_error::{CovenSchemaError, MigrationError, OpenError};
205pub use read::{Read, SqlReadContext};
206pub use row_key::RowKey;
207pub use schema_error::SchemaError;
208pub use snapshot_error::SnapshotError;
209pub use snapshot_reload::{LoadedSnapshot, SnapshotReload, SnapshotSource};
210pub use snapshot_write::SnapshotWriteError;
211pub use sql_read::SqlRead;
212#[cfg(any(test, feature = "test-utils"))]
213pub use sqlive::LiveQueryRuns;
214pub use sqlive::{
215    LiveQuery, LiveQueryCause, LiveQueryClosed, LiveQueryRequests, LiveQueryRevision,
216    ReconfigurableLiveQuery, ReconfigurableLiveQueryEvent,
217};
218#[cfg(any(test, feature = "test-utils"))]
219pub use upload::UploadReadError;
220pub use upload::{PreparedUploads, UploadBytes, UploadParts, UploadPlaintext, WaitingUpload};
221pub use user_file::{prepare_user_file, unix_seconds_and_nanos, PreparedUserFile, UserFile};
222pub use write::{BulkSqlContext, SqlContext};
223pub use write_batch::{FileSource, Place, WriteBatch};
224pub use write_boundary::{Boundary, BoundaryCoverage};
225pub use write_failure::WriteFailure;
226
227// SQL values, parameters and callback results are public. Connections remain private.
228pub use sqlive::rusqlite::{
229    named_params, params, types, Error as SqliteError, Params, Result as SqliteResult, Row, ToSql,
230};
231
232#[cfg(any(test, feature = "test-utils"))]
233pub mod test_utils;
234
235#[cfg(test)]
236#[path = "lib_tests.rs"]
237pub(crate) mod tests;
238
239mod operation;
240mod own_removal;
241pub use operation::{NewOperation, OperationId, OperationRecord, OperationUpdate};
242pub mod operation_kind;
243mod operation_outcome;
244pub(crate) use operation_outcome::StopOutcome;
245pub use operation_outcome::{
246    slot_json, ChangeOutcome, DeviceStop, EntryTarget, FreshChangeOutcome, InviteOutcome,
247    ListedOutcome, OperationRejection, Removal, StorageSetupOutcome, UndoCause,
248};
249
250mod commit_task;
251pub use commit_task::in_commit_scope;
252mod prerequisite_rows;
253pub use prerequisite_rows::PrerequisiteRows;
254pub use sqlive::{AttemptCommits, CommitScope, DatabaseChanges};
255
256mod captured_changes;
257mod claim;
258mod forget_entries;
259mod forget_records;
260mod published;
261mod published_migration;
262mod queued_writes;
263mod rebuild_wait;
264mod reload_gate;
265mod sequence;
266mod sequence_apply;
267mod snapshot_view;
268mod store_failure;
269mod store_state;
270mod store_state_tables;
271mod write_metadata;
272pub use before_commit::CommitSql;
273pub use claim::{
274    Claim, ClaimAttempt, ClaimBytes, ClaimRead, ClaimSettlement, ClaimUpload, ClaimWork,
275};
276pub use forget_records::Writers;
277pub use joining_write::{Joining, JoiningWrite};
278pub use sequence::WriteCutoff;
279pub use sequence_apply::{AdminEffect, IncomingSlot, SlotContent};
280pub use store_state::{
281    DeviceState, Joined, StoreCircle, StoreDevice, StoreIdentity, StoreMember, StoreState,
282    StoreVersion,
283};
284
285mod claim_preparation;
286mod input_preparation;