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
use types::*;
use types::value::*;
use error::{Error as CError, Result as CResult};
use consistency::Consistency;
use frame::frame_query::{ParamsReqQuery, QueryFlags};
use frame::frame_batch::{BatchQuery, BatchQuerySubj, BatchType, BodyReqBatch};

/// Structure that represents CQL query and parameters which will be applied during
/// its execution
#[derive(Debug, Default)]
pub struct Query {
    pub query: String,
    // query parameters
    pub consistency: Consistency,
    pub values: Option<Vec<Value>>,
    pub with_names: Option<bool>,
    pub page_size: Option<i32>,
    pub paging_state: Option<CBytes>,
    pub serial_consistency: Option<Consistency>,
    pub timestamp: Option<i64>,
}

/// `QueryBuilder` is a helper sturcture that helps to construct `Query`. `Query` itself
/// consists of CQL query string and list of parameters.
/// Parameters are the same as ones described in [Cassandra v4 protocol]
/// (https://github.com/apache/cassandra/blob/trunk/doc/native_protocol_v4.spec#L304)
#[derive(Debug, Default)]
pub struct QueryBuilder {
    query: String,
    consistency: Consistency,
    values: Option<Vec<Value>>,
    with_names: Option<bool>,
    page_size: Option<i32>,
    paging_state: Option<CBytes>,
    serial_consistency: Option<Consistency>,
    timestamp: Option<i64>,
}

impl QueryBuilder {
    /// Factory function that takes CQL as an argument and returns new `QueryBuilder`.
    /// Default consistency level is `One`
    pub fn new<T: Into<String>>(query: T) -> QueryBuilder {
        QueryBuilder { query: query.into(),
                       ..Default::default() }
    }

    /// Sets new query consistency
    pub fn consistency(mut self, consistency: Consistency) -> Self {
        self.consistency = consistency;

        self
    }

    /// Sets new query values
    builder_opt_field!(values, Vec<Value>);

    /// Sets new query with_names
    builder_opt_field!(with_names, bool);

    /// Sets new query pagesize
    builder_opt_field!(page_size, i32);

    /// Sets new query pagin state
    builder_opt_field!(paging_state, CBytes);

    /// Sets new query serial_consistency
    builder_opt_field!(serial_consistency, Consistency);

    /// Sets new quey timestamp
    builder_opt_field!(timestamp, i64);

    pub fn apply_query_params(mut self, params: QueryParams) -> Self {
        self.consistency = params.consistency;
        self.values = params.values;
        self.page_size = params.page_size;
        self.paging_state = params.paging_state;
        self.serial_consistency = params.serial_consistency;
        self.timestamp = params.timestamp;

        self
    }

    /// Finalizes query building process and returns query itself
    pub fn finalize(self) -> Query {
        Query { query: self.query,
                consistency: self.consistency,
                values: self.values,
                with_names: self.with_names,
                page_size: self.page_size,
                paging_state: self.paging_state,
                serial_consistency: self.serial_consistency,
                timestamp: self.timestamp, }
    }
}

pub type QueryParams = ParamsReqQuery;

/// Query parameters builder
#[derive(Debug)]
pub struct QueryParamsBuilder {
    consistency: Consistency,
    values: Option<Vec<Value>>,
    with_names: bool,
    page_size: Option<i32>,
    paging_state: Option<CBytes>,
    serial_consistency: Option<Consistency>,
    timestamp: Option<i64>,
}

impl QueryParamsBuilder {
    pub fn new(consistency: Consistency) -> QueryParamsBuilder {
        QueryParamsBuilder { consistency: consistency,
                             values: None,
                             with_names: false,
                             page_size: None,
                             paging_state: None,
                             serial_consistency: None,
                             timestamp: None, }
    }

    pub fn values(mut self, v: Vec<Value>) -> Self {
        self.values = Some(v);

        self
    }

    pub fn with_names(mut self, with_names: bool) -> Self {
        self.with_names = with_names;

        self
    }

    pub fn page_size(mut self, page_size: i32) -> Self {
        self.page_size = Some(page_size);

        self
    }

    pub fn paging_state(mut self, paging_state: CBytes) -> Self {
        self.paging_state = Some(paging_state);

        self
    }

    pub fn serial_consistency(mut self, serial_consistency: Consistency) -> Self {
        self.serial_consistency = Some(serial_consistency);

        self
    }

    pub fn timestamp(mut self, timestamp: i64) -> Self {
        self.timestamp = Some(timestamp);

        self
    }

    pub fn finalize(self) -> QueryParams {
        // query flags
        let mut flags: Vec<QueryFlags> = vec![];

        if self.values.is_some() {
            flags.push(QueryFlags::Value);
        }

        if self.with_names {
            flags.push(QueryFlags::WithNamesForValues);
        }

        if self.page_size.is_some() {
            flags.push(QueryFlags::PageSize);
        }

        if self.serial_consistency.is_some() {
            flags.push(QueryFlags::WithSerialConsistency);
        }

        if self.timestamp.is_some() {
            flags.push(QueryFlags::WithDefaultTimestamp);
        }

        QueryParams { consistency: self.consistency,
                      flags: flags,
                      values: self.values,
                      page_size: self.page_size,
                      paging_state: self.paging_state,
                      serial_consistency: self.serial_consistency,
                      timestamp: self.timestamp, }
    }
}

pub type QueryBatch = BodyReqBatch;

#[derive(Debug)]
pub struct BatchQueryBuilder {
    batch_type: BatchType,
    queries: Vec<BatchQuery>,
    consistency: Consistency,
    serial_consistency: Option<Consistency>,
    timestamp: Option<i64>,
}

impl BatchQueryBuilder {
    pub fn new() -> BatchQueryBuilder {
        BatchQueryBuilder { batch_type: BatchType::Logged,
                            queries: vec![],
                            consistency: Consistency::One,
                            serial_consistency: None,
                            timestamp: None, }
    }

    pub fn batch_type(mut self, batch_type: BatchType) -> Self {
        self.batch_type = batch_type;
        self
    }

    /// Add a query (non-prepared one)
    pub fn add_query<T: Into<String>>(mut self, query: T, values: Vec<BatchValue>) -> Self {
        self.queries.push(BatchQuery { is_prepared: false,
                               subject:
                                   BatchQuerySubj::QueryString(CStringLong::new(query.into())),
                               values: values, });
        self
    }

    /// Add a query (prepared one)
    pub fn add_query_prepared(mut self, query_id: CBytesShort, values: Vec<BatchValue>) -> Self {
        self.queries.push(BatchQuery { is_prepared: true,
                                       subject: BatchQuerySubj::PreparedId(query_id),
                                       values: values, });
        self
    }

    pub fn clear_queries(mut self) -> Self {
        self.queries = vec![];
        self
    }

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

    pub fn serial_consistency(mut self, serial_consistency: Option<Consistency>) -> Self {
        self.serial_consistency = serial_consistency;
        self
    }

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

    pub fn finalize(self) -> CResult<BodyReqBatch> {
        let mut flags = vec![];

        if self.serial_consistency.is_some() {
            flags.push(QueryFlags::WithSerialConsistency);
        }

        if self.timestamp.is_some() {
            flags.push(QueryFlags::WithDefaultTimestamp);
        }

        let with_names_for_values = self.queries.iter()
                                        .all(|q| q.values.iter().all(|v| v.0.is_some()));

        if !with_names_for_values {
            let some_names_for_values = self.queries.iter()
                                            .any(|q| q.values.iter().any(|v| v.0.is_some()));

            if some_names_for_values {
                return Err(CError::General(String::from("Inconsistent query values - mixed \
                                                         with and without names values")));
            }
        }

        if with_names_for_values {
            flags.push(QueryFlags::WithNamesForValues);
        }

        Ok(BodyReqBatch { batch_type: self.batch_type,
                          queries: self.queries,
                          query_flags: flags,
                          consistency: self.consistency,
                          serial_consistency: self.serial_consistency,
                          timestamp: self.timestamp, })
    }
}

pub type BatchValue = (Option<CString>, Value);

#[cfg(test)]
mod query_builder {
    use super::*;

    #[test]
    fn new() {
        let _ = QueryBuilder::new("USE keyspace").finalize();
    }

    #[test]
    fn with_parameters() {
        let _ = QueryBuilder::new("USE keyspace").consistency(Consistency::Two)
                                                 .values(vec![Value::new_null()])
                                                 .with_names(true)
                                                 .page_size(11)
                                                 .paging_state(CBytes::new(vec![1, 2, 3, 4, 5]))
                                                 .serial_consistency(Consistency::One)
                                                 .timestamp(1245678)
                                                 .finalize();
    }
}

#[cfg(test)]
mod query_params_builder {
    use super::*;

    #[test]
    fn new() {
        let _ = QueryParamsBuilder::new(Consistency::Two).finalize();
    }

    #[test]
    fn with_parameters() {
        let _ = QueryParamsBuilder::new(Consistency::Two).values(vec![Value::new_null()])
                                                         .with_names(true)
                                                         .page_size(11)
                                                         .paging_state(CBytes::new(vec![1, 2, 3,
                                                                                        4, 5]))
                                                         .serial_consistency(Consistency::One)
                                                         .timestamp(1245678)
                                                         .finalize();
    }
}

#[cfg(test)]
mod batch_query_builder {
    use super::*;

    #[test]
    fn new() {
        assert!(BatchQueryBuilder::new().finalize().is_ok());
    }

    #[test]
    fn newwith_defaults() {
        let newwith_defaults = BatchQueryBuilder::new().finalize();
        match newwith_defaults {
            Ok(n) => {
                assert!(n.batch_type == BatchType::Logged);
                assert!(n.consistency == Consistency::One);
                assert!(n.serial_consistency == None);
                assert!(n.timestamp == None);
                assert!(n.queries.is_empty());
            }
            Err(_) => assert!(false, "Error should not happen"),
        }
    }

    #[test]
    fn with_parameters() {
        let q = BatchQueryBuilder::new().batch_type(BatchType::Logged)
                                        .add_query("some query".to_string(), vec![])
                                        .add_query_prepared(CBytesShort::new(vec![1, 2, 3]), vec![])
                                        .consistency(Consistency::One)
                                        .serial_consistency(Some(Consistency::Two))
                                        .timestamp(Some(1234))
                                        .finalize();
        assert!(q.is_ok())
    }

    #[test]
    fn clear_queries() {
        let q = BatchQueryBuilder::new().add_query("some query".to_string(), vec![])
                                        .clear_queries()
                                        .finalize();
        assert!(q.is_ok())
    }
}