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

use std::cell::RefCell;
use std::fmt::Debug;
use std::rc::Rc;

use serde::de::DeserializeOwned;
use serde::ser::Serialize;
use tokio_core::reactor::Core;

use rincon_client::document::types::{DocumentHeader, DocumentKey, DocumentId,
    UpdatedDocumentHeader};
use rincon_client::graph::methods::*;
use rincon_client::graph::types::{Edge, EdgeCollection, Graph, NewEdge};
use rincon_core::api::connector::{Connector, Execute};
use rincon_core::api::method::{Method, Prepare};

use super::Result;

/// A session for operating with a specific edge collection.
#[derive(Debug)]
pub struct EdgeCollectionSession<C> {
    entity: EdgeCollection,
    graph_name: String,
    database_name: String,
    connector: Rc<C>,
    core: Rc<RefCell<Core>>,
}

impl<C> EdgeCollectionSession<C>
    where C: 'static + Connector
{
    /// Instantiates a new `EdgeCollectionSession` for the given edge
    /// collection entity.
    pub(crate) fn new(
        entity: EdgeCollection,
        graph_name: String,
        database_name: String,
        connector: Rc<C>,
        core: Rc<RefCell<Core>>,
    ) -> Self {
        EdgeCollectionSession {
            entity,
            graph_name,
            database_name,
            connector,
            core,
        }
    }

    /// Executes an API method applied to the database of this session.
    fn execute<M>(&self, method: M) -> Result<<M as Method>::Result>
        where M: 'static + Method + Prepare
    {
        self.core.borrow_mut().run(
            self.connector.connection(&self.database_name)
                .execute(method)
        )
    }

    /// Returns the name of the database this edge collection is located in.
    pub fn database_name(&self) -> &str {
        &self.database_name
    }

    /// Returns the name of the graph this edge collection is part of.
    pub fn graph_name(&self) -> &str {
        &self.graph_name
    }

    /// Returns the name of the edge collection this `EdgeCollectionSession`
    /// operates with.
    pub fn name(&self) -> &str {
        self.entity.collection()
    }

    /// Returns the `EdgeCollection` entity this `EdgeCollectionSession`
    /// operates with.
    pub fn entity(&self) -> &EdgeCollection {
        &self.entity
    }

    /// Unwraps the edge collection entity out of this session.
    pub fn unwrap(self) -> EdgeCollection {
        self.entity
    }

    /// Removes the edge definition represented by this session from the graph
    ///
    /// This will only remove the edge collection, the edge collections remain
    /// untouched.
    ///
    /// After calling this function the associated `EdgeCollectionSession` is
    /// no longer valid.
    pub fn drop(self) -> Result<Graph> {
        self.execute(RemoveEdgeDefinition::new(self.graph_name(), self.name()))
    }

    /// Creates a new edge in this collection.
    pub fn insert_edge<E, T>(&self, edge: E) -> Result<DocumentHeader>
        where
            E: Into<NewEdge<T>>,
            T: 'static + Serialize + Debug,
    {
        self.execute(InsertEdge::new(self.graph_name(), self.name(), edge.into()))
    }

    /// Creates a new edge in this collection and waits until the changes are
    /// written to disk.
    pub fn insert_edge_synced<E, T>(&self, edge: E) -> Result<DocumentHeader>
        where
            E: Into<NewEdge<T>>,
            T: 'static + Serialize + Debug,
    {
        self.execute(InsertEdge::new(self.graph_name(), self.name(), edge.into())
            .with_force_wait_for_sync(true))
    }

    /// Fetches the edge with the given key from this collection.
    pub fn get_edge<T>(&self, key: DocumentKey) -> Result<Edge<T>>
        where T: 'static + DeserializeOwned
    {
        self.execute(GetEdge::new(self.graph_name(), self.name(), key))
    }

    /// Fetches the edge with the given key from this collection if the
    /// revision matches the given predicate.
    pub fn get_edge_if_match<IfMatch, T>(&self, key: DocumentKey, if_match: IfMatch) -> Result<Edge<T>>
        where
            IfMatch: Into<String>,
            T: 'static + DeserializeOwned,
    {
        self.execute(GetEdge::new(self.graph_name(), self.name(), key)
            .with_if_match(if_match))
    }

    /// Fetches the edge with the given key from this collection if the
    /// revision does not match the given predicate.
    pub fn get_edge_if_non_match<IfNonMatch, T>(&self, key: DocumentKey, if_non_match: IfNonMatch) -> Result<Edge<T>>
        where
            IfNonMatch: Into<String>,
            T: 'static + DeserializeOwned,
    {
        self.execute(GetEdge::new(self.graph_name(), self.name(), key)
            .with_if_non_match(if_non_match))
    }

    /// Replaces an existing edge with a new edge.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be replaced
    /// * `new_edge` : The new edge
    pub fn replace_edge<New, E>(
        &self,
        key: DocumentKey,
        new_edge: E,
    ) -> Result<UpdatedDocumentHeader>
        where
            New: 'static + Serialize + Debug,
            E: Into<NewEdge<New>>,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        self.execute(ReplaceEdge::new(self.graph_name(), edge_id, new_edge.into()))
    }

    /// Replaces an existing edge with a new edge if the match condition
    /// is met.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be replaced
    /// * `new_edge` : The new edge
    /// * `if_match` : The match condition that must be met to replace a edge
    pub fn replace_edge_if_match<IfMatch, New, E>(
        &self,
        key: DocumentKey,
        new_edge: E,
        if_match: IfMatch,
    ) -> Result<UpdatedDocumentHeader>
        where
            IfMatch: Into<String>,
            New: 'static + Serialize + Debug,
            E: Into<NewEdge<New>>,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        self.execute(ReplaceEdge::new(self.graph_name(), edge_id, new_edge.into())
            .with_if_match(if_match)
        )
    }

    /// Replaces an existing edge with a new edge if the match condition
    /// is met and waits until the changes are written to disk.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be replaced
    /// * `new_edge` : The new edge
    /// * `if_match` : The match condition that must be met to replace a edge
    pub fn replace_edge_if_match_synced<IfMatch, New, E>(
        &self,
        key: DocumentKey,
        new_edge: E,
        if_match: IfMatch,
    ) -> Result<UpdatedDocumentHeader>
        where
            IfMatch: Into<String>,
            New: 'static + Serialize + Debug,
            E: Into<NewEdge<New>>,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        self.execute(ReplaceEdge::new(self.graph_name(), edge_id, new_edge.into())
            .with_if_match(if_match)
            .with_force_wait_for_sync(true)
        )
    }

    /// Replaces an existing edge with a new edge and waits until the
    /// changes are written to disk.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be replaced
    /// * `new_edge` : The new edge
    pub fn replace_edge_synced<New, E>(
        &self,
        key: DocumentKey,
        new_edge: E,
    ) -> Result<UpdatedDocumentHeader>
        where
            New: 'static + Serialize + Debug,
            E: Into<NewEdge<New>>,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        self.execute(ReplaceEdge::new(self.graph_name(), edge_id, new_edge.into())
            .with_force_wait_for_sync(true)
        )
    }

    /// Partially modifies an existing edge.
    ///
    /// The update argument must contain a document with the attributes
    /// to patch (the patch document). All attributes from the patch document
    /// will be added to the existing edge if they do not exist yet or
    /// overwritten in the existing edge if they already exist there.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be modified
    /// * `update` : A document with the content to be modified (patch document)
    /// * `keep_none` : Whether values set to `None` shall be stored. By default
    ///   the attribute is not removed from the document.
    pub fn modify_edge<Upd>(
        &self,
        key: DocumentKey,
        update: Upd,
        keep_none: Option<bool>,
    ) -> Result<UpdatedDocumentHeader>
        where
            Upd: 'static + Serialize + Debug,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        let modify_edge = if let Some(keep_none) = keep_none {
            ModifyEdge::new(self.graph_name(), edge_id, update)
                .with_keep_none(keep_none)
        } else {
            ModifyEdge::new(self.graph_name(), edge_id, update)
        };
        self.execute(modify_edge)
    }

    /// Partially modifies an existing edge if the match condition is met.
    ///
    /// The update argument must contain a document with the attributes
    /// to patch (the patch document). All attributes from the patch document
    /// will be added to the existing edge if they do not exist yet or
    /// overwritten in the existing edge if they already exist there.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be modified
    /// * `update` : A document with the content to be modified (patch document)
    /// * `if_match` : The match condition that must be met to modify a edge
    /// * `keep_none` : Whether values set to `None` shall be stored. By default
    ///   the attribute is not removed from the document.
    pub fn modify_edge_if_match<IfMatch, Upd>(
        &self,
        key: DocumentKey,
        update: Upd,
        if_match: IfMatch,
        keep_none: Option<bool>,
    ) -> Result<UpdatedDocumentHeader>
        where
            IfMatch: Into<String>,
            Upd: 'static + Serialize + Debug,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        let modify_edge = if let Some(keep_none) = keep_none {
            ModifyEdge::new(self.graph_name(), edge_id, update)
                .with_keep_none(keep_none)
        } else {
            ModifyEdge::new(self.graph_name(), edge_id, update)
        };
        self.execute(modify_edge.with_if_match(if_match))
    }

    /// Partially modifies an existing edge if the match condition is met and
    /// waits until the changes are written to disk.
    ///
    /// The update argument must contain a document with the attributes
    /// to patch (the patch document). All attributes from the patch document
    /// will be added to the existing edge if they do not exist yet or
    /// overwritten in the existing edge if they already exist there.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be modified
    /// * `update` : A document with the content to be modified (patch document)
    /// * `if_match` : The match condition that must be met to modify a edge
    /// * `keep_none` : Whether values set to `None` shall be stored. By default
    ///   the attribute is not removed from the document.
    pub fn modify_edge_if_match_synced<IfMatch, Upd>(
        &self,
        key: DocumentKey,
        update: Upd,
        if_match: IfMatch,
        keep_none: Option<bool>,
    ) -> Result<UpdatedDocumentHeader>
        where
            IfMatch: Into<String>,
            Upd: 'static + Serialize + Debug,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        let modify_edge = if let Some(keep_none) = keep_none {
            ModifyEdge::new(self.graph_name(), edge_id, update)
                .with_keep_none(keep_none)
        } else {
            ModifyEdge::new(self.graph_name(), edge_id, update)
        };
        self.execute(modify_edge
            .with_if_match(if_match)
            .with_force_wait_for_sync(true)
        )
    }

    /// Partially modifies an existing edge and waits until the changes are
    /// written to disk.
    ///
    /// The update argument must contain a document with the attributes
    /// to patch (the patch document). All attributes from the patch document
    /// will be added to the existing edge if they do not exist yet or
    /// overwritten in the existing edge if they already exist there.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the edge to be modified
    /// * `update` : A document with the content to be modified (patch document)
    /// * `keep_none` : Whether values set to `None` shall be stored. By default
    ///   the attribute is not removed from the document.
    pub fn modify_edge_synced<Upd>(
        &self,
        key: DocumentKey,
        update: Upd,
        keep_none: Option<bool>,
    ) -> Result<UpdatedDocumentHeader>
        where
            Upd: 'static + Serialize + Debug,
    {
        let edge_id = DocumentId::new(self.name(), key.unwrap());
        let modify_edge = if let Some(keep_none) = keep_none {
            ModifyEdge::new(self.graph_name(), edge_id, update)
                .with_keep_none(keep_none)
        } else {
            ModifyEdge::new(self.graph_name(), edge_id, update)
        };
        self.execute(modify_edge.with_force_wait_for_sync(true))
    }

    /// Removes the edge with the given key from this collection.
    pub fn remove_edge(&self, key: DocumentKey) -> Result<bool> {
        self.execute(RemoveEdge::new(self.graph_name(), self.name(), key))
    }

    /// Removes the edge with the given key from this collection if the match
    /// condition is met.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the document to be deleted
    /// * `if_match` : The match condition that must be met to remove the
    ///   edge
    pub fn remove_edge_if_match<IfMatch>(&self, key: DocumentKey, if_match: IfMatch) -> Result<bool>
        where IfMatch: Into<String>
    {
        self.execute(RemoveEdge::new(self.graph_name(), self.name(), key)
            .with_if_match(if_match))
    }

    /// Removes the edge with the given key from this collection if the match
    /// condition is met and waits until the changes are written to disk.
    ///
    /// # Arguments
    ///
    /// * `key` : The key of the document to be deleted
    /// * `if_match` : The match condition that must be met to remove the
    ///   edge
    pub fn remove_edge_if_match_synced<IfMatch>(&self, key: DocumentKey, if_match: IfMatch) -> Result<bool>
        where IfMatch: Into<String>
    {
        self.execute(RemoveEdge::new(self.graph_name(), self.name(), key)
            .with_if_match(if_match)
            .with_force_wait_for_sync(true))
    }

    /// Removes the edge with the given key from this collection and waits
    /// until the changes are written to disk.
    pub fn remove_edge_synced(&self, key: DocumentKey) -> Result<bool> {
        self.execute(RemoveEdge::new(self.graph_name(), self.name(), key)
            .with_force_wait_for_sync(true))
    }
}