crdb-core 0.0.1-alpha.0

Concurrently Replicated DataBase
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::{
    BinPtr, ClientStorageInfo, CrdbSyncFn, Db, EventId, Importance, LoginInfo, Object, ObjectId,
    Query, QueryId, TypeId, Updatedness, Upload, UploadId,
};
use std::{
    collections::{HashMap, HashSet},
    sync::Arc,
};

pub struct SavedObjectMeta {
    pub type_id: TypeId,
    pub have_all_until: Option<Updatedness>,
    pub importance: Importance,
}

#[derive(Clone)]
pub struct SavedQuery {
    pub query: Arc<Query>,
    pub type_id: TypeId,
    pub have_all_until: Option<Updatedness>,
    pub importance: Importance,
}

impl SavedQuery {
    pub fn now_have_all_until(&mut self, until: Updatedness) {
        self.have_all_until = std::cmp::max(self.have_all_until, Some(until));
    }
}

pub trait ClientSideDb: 'static + waaaa::Send + waaaa::Sync + Db {
    fn storage_info(&self) -> impl waaaa::Future<Output = crate::Result<ClientStorageInfo>>;

    fn save_login(&self, _info: LoginInfo) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn get_saved_login(&self) -> impl waaaa::Future<Output = crate::Result<Option<LoginInfo>>>;

    fn get_json(
        &self,
        object_id: ObjectId,
        importance: Importance,
    ) -> impl waaaa::Future<Output = crate::Result<serde_json::Value>>;

    fn remove_everything(&self) -> impl waaaa::Future<Output = crate::Result<()>>;

    /// Either create an object if it did not exist yet, or recreate it
    ///
    /// Returns the new latest snapshot if it actually changed.
    ///
    /// `updatedness` is the up-to-date-ness of this recreation, or `None` if it is not known yet
    /// (eg. it was initiated client-side and has not round-tripped to server yet)
    fn recreate<T: Object>(
        &self,
        object_id: ObjectId,
        new_created_at: EventId,
        creation_value: Arc<T>,
        updatedness: Option<Updatedness>,
        additional_importance: Importance,
    ) -> impl waaaa::Future<Output = crate::Result<Option<Arc<T>>>>;

    fn client_query(
        &self,
        type_id: TypeId,
        query: Arc<Query>,
    ) -> impl waaaa::Future<Output = crate::Result<Vec<ObjectId>>>;

    fn remove(&self, object_id: ObjectId) -> impl waaaa::Future<Output = crate::Result<()>>;

    // TODO(test-high): introduce in db fuzzers
    fn remove_event<T: Object>(
        &self,
        object_id: ObjectId,
        event_id: EventId,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn set_object_importance(
        &self,
        object_id: ObjectId,
        new_importance: Importance,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn set_importance_from_queries(
        &self,
        object_id: ObjectId,
        new_importance_from_queries: Importance,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn client_vacuum(
        &self,
        notify_removals: impl 'static + CrdbSyncFn<ObjectId>,
        notify_query_removals: impl 'static + CrdbSyncFn<QueryId>,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn list_uploads(&self) -> impl waaaa::Future<Output = crate::Result<Vec<UploadId>>>;

    fn get_upload(
        &self,
        upload_id: UploadId,
    ) -> impl waaaa::Future<Output = crate::Result<Option<Upload>>>;

    fn enqueue_upload(
        &self,
        upload: Upload,
        required_binaries: Vec<BinPtr>,
    ) -> impl waaaa::Future<Output = crate::Result<UploadId>>;

    fn upload_finished(
        &self,
        upload_id: UploadId,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn get_saved_objects(
        &self,
    ) -> impl waaaa::Future<Output = crate::Result<HashMap<ObjectId, SavedObjectMeta>>>;

    fn get_saved_queries(
        &self,
    ) -> impl waaaa::Future<Output = crate::Result<HashMap<QueryId, SavedQuery>>>;

    fn record_query(
        &self,
        query_id: QueryId,
        query: Arc<Query>,
        type_id: TypeId,
        importance: Importance,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn set_query_importance(
        &self,
        query_id: QueryId,
        importance: Importance,
        objects_matching_query: Vec<ObjectId>,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn forget_query(
        &self,
        query_id: QueryId,
        objects_matching_query: Vec<ObjectId>,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;

    fn update_queries(
        &self,
        queries: &HashSet<QueryId>,
        now_have_all_until: Updatedness,
    ) -> impl waaaa::Future<Output = crate::Result<()>>;
}