charybdis 1.1.0

High-Performance ORM for ScyllaDB
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
use std::sync::Arc;

use crate::errors::CharybdisError;
use crate::model::Model;
use crate::options::{Consistency, ExecutionProfileHandle, RetryPolicy, SerialConsistency};
use crate::query::{CharybdisQuery, QueryExecutor, QueryValue};
use scylla::_macro_internal::{RowSerializationContext, RowWriter, SerializationError};
use scylla::client::caching_session::CachingSession;
use scylla::observability::history::HistoryListener;
use scylla::response::query_result::QueryResult;
use scylla::serialize::row::SerializeRow;
use scylla::statement::batch::{Batch, BatchType};

pub struct CharybdisModelBatch<'a, Val: SerializeRow, M: Model> {
    inner: Batch,
    values: Vec<QueryValue<'a, Val, M>>,
}

impl<'a, Val: SerializeRow, M: Model> CharybdisModelBatch<'a, Val, M> {
    pub fn new() -> Self {
        Self {
            inner: Batch::default(),
            values: Vec::new(),
        }
    }

    pub fn unlogged() -> Self {
        Self {
            inner: Batch::new(BatchType::Unlogged),
            values: Vec::new(),
        }
    }

    pub(crate) fn from_batch(batch: &Batch) -> Self {
        Self {
            inner: batch.clone(),
            values: Vec::new(),
        }
    }

    fn append_query_to_batch(&mut self, statement: &str) {
        self.inner.append_statement(statement);
    }

    pub fn consistency(mut self, consistency: Consistency) -> Self {
        self.inner.set_consistency(consistency);
        self
    }

    pub fn serial_consistency(mut self, consistency: Option<SerialConsistency>) -> Self {
        self.inner.set_serial_consistency(consistency);
        self
    }

    pub fn idempotent(mut self, is_idempotent: bool) -> Self {
        self.inner.set_is_idempotent(is_idempotent);
        self
    }

    pub fn trace(mut self, is_tracing: bool) -> Self {
        self.inner.set_tracing(is_tracing);
        self
    }

    pub fn timestamp(mut self, timestamp: Option<i64>) -> Self {
        self.inner.set_timestamp(timestamp);
        self
    }

    pub fn retry_policy(mut self, retry_policy: Option<Arc<dyn RetryPolicy>>) -> Self {
        self.inner.set_retry_policy(retry_policy);
        self
    }

    pub fn history_listener(mut self, history_listener: Arc<dyn HistoryListener>) -> Self {
        self.inner.set_history_listener(history_listener);
        self
    }

    pub fn remove_history_listener(mut self) -> Self {
        self.inner.remove_history_listener();
        self
    }

    pub fn profile_handle(mut self, profile_handle: Option<ExecutionProfileHandle>) -> Self {
        self.inner.set_execution_profile_handle(profile_handle);
        self
    }

    pub async fn chunked_insert(
        self,
        db_session: &CachingSession,
        iter: &[M],
        chunk_size: usize,
    ) -> Result<(), CharybdisError> {
        let chunks = iter.chunks(chunk_size);

        for chunk in chunks {
            let mut batch: CharybdisModelBatch<M, M> = CharybdisModelBatch::from_batch(&self.inner);

            batch.append_inserts(chunk);

            batch.execute(db_session).await?;
        }

        Ok(())
    }

    pub async fn chunked_insert_if_not_exist(
        self,
        db_session: &CachingSession,
        iter: &[M],
        chunk_size: usize,
    ) -> Result<(), CharybdisError> {
        let chunks = iter.chunks(chunk_size);

        for chunk in chunks {
            let mut batch: CharybdisModelBatch<M, M> = CharybdisModelBatch::from_batch(&self.inner);

            batch.append_inserts_if_not_exist(chunk);

            batch.execute(db_session).await?;
        }

        Ok(())
    }

    pub async fn chunked_update(
        self,
        db_session: &CachingSession,
        iter: &[M],
        chunk_size: usize,
    ) -> Result<(), CharybdisError> {
        let chunks = iter.chunks(chunk_size);

        for chunk in chunks {
            let mut batch: CharybdisModelBatch<M, M> = CharybdisModelBatch::from_batch(&self.inner);

            batch.append_updates(chunk);

            batch.execute(db_session).await?;
        }

        Ok(())
    }

    pub async fn chunked_delete(
        self,
        db_session: &CachingSession,
        iter: &[M],
        chunk_size: usize,
    ) -> Result<(), CharybdisError> {
        let chunks = iter.chunks(chunk_size);

        for chunk in chunks {
            let mut batch: CharybdisModelBatch<M, M> = CharybdisModelBatch::from_batch(&self.inner);

            for model in chunk {
                batch.append_delete(model);
            }

            batch.execute(db_session).await?;
        }

        Ok(())
    }

    pub async fn chunked_delete_by_partition_key(
        self,
        db_session: &CachingSession,
        iter: &[M],
        chunk_size: usize,
    ) -> Result<(), CharybdisError> {
        let chunks = iter.chunks(chunk_size);

        for chunk in chunks {
            let mut batch: CharybdisModelBatch<M, M> = CharybdisModelBatch::from_batch(&self.inner);

            batch.append_deletes_by_partition_key(chunk);

            batch.execute(db_session).await?;
        }

        Ok(())
    }

    pub async fn chunked_statements(
        self,
        db_session: &CachingSession,
        statement: &str,
        mut values: Vec<Val>,
        chunk_size: usize,
    ) -> Result<(), CharybdisError> {
        while !values.is_empty() {
            let chunk: Vec<Val> = values.drain(..std::cmp::min(chunk_size, values.len())).collect();
            let mut batch: CharybdisModelBatch<Val, M> = CharybdisModelBatch::from_batch(&self.inner);

            batch.append_statements(statement, chunk)?;

            batch.execute(db_session).await?;
        }

        Ok(())
    }

    pub fn append_statements(&mut self, statement: &str, values: Vec<Val>) -> Result<(), CharybdisError> {
        for val in values {
            self.append_statement(statement, val);
        }

        Ok(())
    }

    pub fn append_insert(&mut self, model: &'a M) -> &mut Self {
        self.append_query_to_batch(M::INSERT_QUERY);
        self.values.push(QueryValue::Model(model));
        self
    }

    pub fn append_insert_owned(&mut self, model: M) -> &mut Self {
        self.append_query_to_batch(M::INSERT_QUERY);
        self.values.push(QueryValue::ModelOwned(model));
        self
    }

    pub fn append_inserts(&mut self, iter: &'a [M]) -> &mut Self {
        for model in iter {
            self.append_insert(model);
        }
        self
    }

    pub fn append_insert_if_not_exist(&mut self, model: &'a M) -> &mut Self {
        self.append_query_to_batch(M::INSERT_IF_NOT_EXIST_QUERY);
        self.values.push(QueryValue::Model(model));
        self
    }

    pub fn append_inserts_if_not_exist(&mut self, iter: &'a [M]) -> &mut Self {
        for model in iter {
            self.append_insert_if_not_exist(model);
        }
        self
    }

    pub fn append_update(&mut self, model: &'a M) -> &mut Self {
        self.append_query_to_batch(M::UPDATE_QUERY);
        self.values.push(QueryValue::Model(model));
        self
    }

    pub fn append_update_owned(&mut self, model: M) -> &mut Self {
        self.append_query_to_batch(M::UPDATE_QUERY);
        self.values.push(QueryValue::ModelOwned(model));
        self
    }

    pub fn append_updates(&mut self, iter: &'a [M]) -> &mut Self {
        for model in iter {
            self.append_update(model);
        }
        self
    }

    pub fn append_delete(&mut self, model: &M) -> &mut Self {
        self.append_query_to_batch(M::DELETE_QUERY);
        self.values.push(QueryValue::PrimaryKey(model.primary_key_values()));
        self
    }

    pub fn append_delete_owned(&mut self, model: M) -> &mut Self {
        self.append_query_to_batch(M::DELETE_QUERY);
        self.values.push(QueryValue::PrimaryKey(model.primary_key_values()));
        self
    }

    pub fn append_deletes(&mut self, iter: &[M]) -> &mut Self {
        for model in iter {
            self.append_delete(model);
        }
        self
    }

    pub fn append_delete_by_partition_key(&mut self, model: &'a M) -> &mut Self {
        self.append_query_to_batch(M::DELETE_BY_PARTITION_KEY_QUERY);
        self.values.push(QueryValue::PartitionKey(model.partition_key_values()));
        self
    }

    pub fn append_deletes_by_partition_key(&mut self, iter: &'a [M]) -> &mut Self {
        for model in iter {
            self.append_delete_by_partition_key(model);
        }
        self
    }

    pub fn append_statement(&mut self, statement: &str, val: Val) -> &mut Self {
        self.append_query_to_batch(statement);
        self.values.push(QueryValue::Owned(val));
        self
    }

    pub async fn execute(&self, db_session: &CachingSession) -> Result<QueryResult, CharybdisError> {
        let result = db_session
            .batch(&self.inner, &self.values)
            .await
            .map_err(|e| CharybdisError::BatchError(M::DB_MODEL_NAME, e))?;

        Ok(result)
    }
}

impl<Val: SerializeRow, M: Model> Default for CharybdisModelBatch<'_, Val, M> {
    fn default() -> Self {
        Self::new()
    }
}

pub trait ModelBatch<'a>: Model {
    fn batch() -> CharybdisModelBatch<'a, Self, Self> {
        CharybdisModelBatch::new()
    }

    fn unlogged_batch() -> CharybdisModelBatch<'a, Self, Self> {
        CharybdisModelBatch::unlogged()
    }

    fn primary_key_batch() -> CharybdisModelBatch<'a, Self::PrimaryKey, Self> {
        CharybdisModelBatch::new()
    }

    fn unlogged_primary_key_batch() -> CharybdisModelBatch<'a, Self::PrimaryKey, Self> {
        CharybdisModelBatch::unlogged()
    }

    fn delete_batch() -> CharybdisModelBatch<'a, Self::PrimaryKey, Self> {
        CharybdisModelBatch::new()
    }

    fn unlogged_delete_batch() -> CharybdisModelBatch<'a, Self::PrimaryKey, Self> {
        CharybdisModelBatch::unlogged()
    }

    fn partition_key_batch() -> CharybdisModelBatch<'a, Self::PartitionKey, Self> {
        CharybdisModelBatch::new()
    }

    fn unlogged_partition_key_batch() -> CharybdisModelBatch<'a, Self::PartitionKey, Self> {
        CharybdisModelBatch::unlogged()
    }

    fn statement_batch<Val: SerializeRow>() -> CharybdisModelBatch<'a, Val, Self> {
        CharybdisModelBatch::new()
    }

    fn unlogged_statement_batch<Val: SerializeRow>() -> CharybdisModelBatch<'a, Val, Self> {
        CharybdisModelBatch::unlogged()
    }
}

impl<M: Model> ModelBatch<'_> for M {}

struct SerializeRowBox<'a> {
    inner: Box<dyn SerializeRow + Sync + Send + 'a>,
}

impl<'a> SerializeRowBox<'a> {
    pub fn new(val: impl SerializeRow + 'a + Sync + Send) -> Self {
        Self { inner: Box::new(val) }
    }
}

impl SerializeRow for SerializeRowBox<'_> {
    fn serialize(&self, ctx: &RowSerializationContext<'_>, writer: &mut RowWriter) -> Result<(), SerializationError> {
        self.inner.as_ref().serialize(ctx, writer)
    }

    fn is_empty(&self) -> bool {
        self.inner.as_ref().is_empty()
    }
}

pub struct CharybdisBatch<'a> {
    inner: Batch,
    values: Vec<SerializeRowBox<'a>>,
}

impl<'a> CharybdisBatch<'a> {
    pub fn new() -> Self {
        Self {
            inner: Batch::default(),
            values: Vec::new(),
        }
    }

    pub fn unlogged() -> Self {
        Self {
            inner: Batch::new(BatchType::Unlogged),
            values: Vec::new(),
        }
    }

    pub fn append<Val, M, RtQe>(&mut self, query: CharybdisQuery<'a, Val, M, RtQe>) -> &mut Self
    where
        Val: SerializeRow + Sync + Send,
        M: Model + Sync + Send,
        RtQe: QueryExecutor<M>,
    {
        self.inner.append_statement(query.query_string);

        self.values.push(SerializeRowBox::new(query.values));

        self
    }

    pub async fn execute(&self, db_session: &CachingSession) -> Result<QueryResult, CharybdisError> {
        let result = db_session
            .batch(&self.inner, &self.values)
            .await
            .map_err(|e| CharybdisError::BatchError("QueryBatchError", e))?;

        Ok(result)
    }
}

impl Default for CharybdisBatch<'_> {
    fn default() -> Self {
        Self::new()
    }
}