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
use crate::bucket::{Bucket, SharedBucket};

use crate::error::CouchbaseError;
use crate::options::{AnalyticsOptions, QueryOptions};
use crate::result::{AnalyticsResult, QueryResult};
use futures::Future;
use std::collections::HashMap;
use std::rc::Rc;
use std::sync::Arc;

/// The `Cluster` is the main entry point when working with the client.
pub struct Cluster {
    connection_string: String,
    username: String,
    password: String,
    buckets: HashMap<String, Rc<Bucket>>,
}

impl Cluster {
    /// Creates a new connection reference to the Couchbase cluster.
    ///
    /// Keep in mind that only Role-Based access control (RBAC) is supported, so you need to configure
    /// a username and password on the cluster. This implies that only Couchbase Server versions
    /// 5.0 and later are supported.
    ///
    /// # Arguments
    ///
    /// * `connection_string` - Holds the bootstrap hostnames and optionally config settings.
    /// * `username` - The name of the user configured on the cluster.
    /// * `password` - The password of the user configured on the cluster.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use couchbase::Cluster;
    ///
    /// let mut cluster = Cluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    ///   .expect("Could not create cluster reference");
    /// ```
    ///
    pub fn connect<S>(
        connection_string: S,
        username: S,
        password: S,
    ) -> Result<Self, CouchbaseError>
    where
        S: Into<String>,
    {
        Ok(Self {
            connection_string: connection_string.into(),
            username: username.into(),
            password: password.into(),
            buckets: HashMap::new(),
        })
    }

    /// Opens a Couchbase bucket.
    ///
    /// If you wonder why this returns an `Rc`, the reason is that we also need to keep track
    /// of the `Bucket` internally so if you call `disconnect` on the `Cluster` all opened
    /// buckets are closed. Also, we make sure that if this method is called more than once on
    /// the same bucket, it is only opened once since buckets are expensive resources with state
    /// attached (for those familiar with libcouchbase: the bucket internally holds the lcb
    /// instance).
    ///
    /// We recommend only ever opening a bucket once and then reusing it across the lifetime of
    /// your application for maximum performance and resource efficiency.
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the bucket.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// # use couchbase::Cluster;
    /// #
    /// # let mut cluster = Cluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #     .expect("Could not create cluster reference");
    /// let bucket = cluster.bucket("travel-sample")
    ///     .expect("Could not open bucket");
    /// ```
    ///
    pub fn bucket<S>(&mut self, name: S) -> Result<Rc<Bucket>, CouchbaseError>
    where
        S: Into<String>,
    {
        let name = name.into();
        let bucket = Rc::new(Bucket::new(
            &format!("{}/{}", self.connection_string, name.clone()),
            &self.username,
            &self.password,
        )?);

        self.buckets.insert(name.clone(), bucket.clone());
        Ok(bucket.clone())
    }

    /// Performs a query against the N1QL query service.
    ///
    /// For now, please make sure to open one bucket (doesn't matter which one) before performing
    /// a cluster-level query. This limiation will be lifted in the future, but for now the client
    /// needs an open bucket so it knows where internally to route the query.
    ///
    /// # Arguments
    ///
    /// * `statement` - The query string itself.
    /// * `options` - Options to customize the default behavior.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use couchbase::{CouchbaseError, Cluster};
    /// use futures::{Stream, Future};
    /// use serde_json::Value;
    /// # let mut cluster = Cluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #    .expect("Could not create cluster reference");
    /// # let _ = cluster.bucket("travel-sample");
    /// #
    /// let mut result = cluster.query("select name, type from `travel-sample` limit 5", None)
    ///     .wait()
    ///     .expect("Could not perform query");
    ///
    /// println!("Rows:\n{:?}", result.rows_as().wait().collect::<Vec<Result<Value, CouchbaseError>>>());
    /// println!("Meta:\n{:?}", result.meta().wait().expect("Could not get query meta"));
    /// ```
    ///
    pub fn query<S>(
        &self,
        statement: S,
        options: Option<QueryOptions>,
    ) -> impl Future<Item = QueryResult, Error = CouchbaseError>
    where
        S: Into<String>,
    {
        let bucket = match self.buckets.values().nth(0) {
            Some(b) => b,
            None => panic!("At least one bucket needs to be open to perform a query for now!"),
        };

        bucket.query(statement, options)
    }

    /// Performs a query against the analytics service.
    ///
    /// For now, please make sure to open one bucket (doesn't matter which one) before performing
    /// a cluster-level analytics query. This limiation will be lifted in the future, but for now
    /// the client needs an open bucket so it knows where internally to route the query.
    ///
    /// # Arguments
    ///
    /// * `statement` - The analytics query string itself.
    /// * `options` - Options to customize the default behavior.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use couchbase::{CouchbaseError, Cluster};
    /// use futures::{Stream, Future};
    /// use serde_json::Value;
    /// #
    /// # let mut cluster = Cluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #     .expect("Could not create cluster reference!");
    /// # let _ = cluster.bucket("travel-sample");
    /// #
    /// let mut result = cluster
    ///     .analytics_query("SELECT DataverseName FROM Metadata.`Dataverse`", None)
    ///     .wait()
    ///     .expect("Could not perform analytics query");
    ///
    /// println!("---> rows {:?}", result.rows_as().wait().collect::<Vec<Result<Value, CouchbaseError>>>());
    /// println!("---> meta {:?}", result.meta().wait().expect("Could not get analytics meta"));
    /// ```
    ///
    pub fn analytics_query<S>(
        &self,
        statement: S,
        options: Option<AnalyticsOptions>,
    ) -> impl Future<Item = AnalyticsResult, Error = CouchbaseError>
    where
        S: Into<String>,
    {
        let bucket = match self.buckets.values().nth(0) {
            Some(b) => b,
            None => panic!(
                "At least one bucket needs to be open to perform an analytics query for now!"
            ),
        };

        bucket.analytics_query(statement, options)
    }

    /// Disconnects this cluster and all associated open buckets.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// # use couchbase::Cluster;
    /// #
    /// # let mut cluster = Cluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #    .expect("Could not create cluster reference!");
    /// #
    /// cluster.disconnect().expect("Could not shutdown properly");
    /// ```
    ///
    pub fn disconnect(&mut self) -> Result<(), CouchbaseError> {
        for bucket in self.buckets.values() {
            bucket.close()?;
        }
        self.buckets.clear();
        Ok(())
    }
}

/// The `Cluster` is the main entry point when working with the client.
pub struct SharedCluster {
    connection_string: String,
    username: String,
    password: String,
    buckets: HashMap<String, Arc<SharedBucket>>,
}

impl SharedCluster {
    /// Creates a new connection reference to the Couchbase cluster.
    ///
    /// Keep in mind that only Role-Based access control (RBAC) is supported, so you need to configure
    /// a username and password on the cluster. This implies that only Couchbase Server versions
    /// 5.0 and later are supported.
    ///
    /// # Arguments
    ///
    /// * `connection_string` - Holds the bootstrap hostnames and optionally config settings.
    /// * `username` - The name of the user configured on the cluster.
    /// * `password` - The password of the user configured on the cluster.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use couchbase::SharedCluster;
    ///
    /// let mut cluster = SharedCluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    ///   .expect("Could not create cluster reference");
    /// ```
    ///
    pub fn connect<S>(
        connection_string: S,
        username: S,
        password: S,
    ) -> Result<Self, CouchbaseError>
    where
        S: Into<String>,
    {
        Ok(Self {
            connection_string: connection_string.into(),
            username: username.into(),
            password: password.into(),
            buckets: HashMap::new(),
        })
    }

    /// Opens a Couchbase bucket.
    ///
    /// If you wonder why this returns an `Rc`, the reason is that we also need to keep track
    /// of the `Bucket` internally so if you call `disconnect` on the `SharedCluster` all opened
    /// buckets are closed. Also, we make sure that if this method is called more than once on
    /// the same bucket, it is only opened once since buckets are expensive resources with state
    /// attached (for those familiar with libcouchbase: the bucket internally holds the lcb
    /// instance).
    ///
    /// We recommend only ever opening a bucket once and then reusing it across the lifetime of
    /// your application for maximum performance and resource efficiency.
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the bucket.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// # use couchbase::SharedCluster;
    /// #
    /// # let mut cluster = SharedCluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #     .expect("Could not create cluster reference");
    /// let bucket = cluster.bucket("travel-sample")
    ///     .expect("Could not open bucket");
    /// ```
    ///
    pub fn bucket<S>(&mut self, name: S) -> Result<Arc<SharedBucket>, CouchbaseError>
    where
        S: Into<String>,
    {
        let name = name.into();
        let bucket = Arc::new(SharedBucket::new(
            &format!("{}/{}", self.connection_string, name.clone()),
            &self.username,
            &self.password,
        )?);

        self.buckets.insert(name.clone(), bucket.clone());
        Ok(bucket.clone())
    }

    /// Performs a query against the N1QL query service.
    ///
    /// For now, please make sure to open one bucket (doesn't matter which one) before performing
    /// a cluster-level query. This limiation will be lifted in the future, but for now the client
    /// needs an open bucket so it knows where internally to route the query.
    ///
    /// # Arguments
    ///
    /// * `statement` - The query string itself.
    /// * `options` - Options to customize the default behavior.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use couchbase::{CouchbaseError, SharedCluster};
    /// use futures::{Stream, Future};
    /// use serde_json::Value;
    /// # let mut cluster = SharedCluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #    .expect("Could not create cluster reference");
    /// # let _ = cluster.bucket("travel-sample");
    /// #
    /// let mut result = cluster.query("select name, type from `travel-sample` limit 5", None)
    ///     .wait()
    ///     .expect("Could not perform query");
    ///
    /// println!("Rows:\n{:?}", result.rows_as().wait().collect::<Vec<Result<Value, CouchbaseError>>>());
    /// println!("Meta:\n{:?}", result.meta().wait().expect("Could not get query meta"));
    /// ```
    ///
    pub fn query<S>(
        &self,
        statement: S,
        options: Option<QueryOptions>,
    ) -> impl Future<Item = QueryResult, Error = CouchbaseError>
    where
        S: Into<String>,
    {
        let bucket = match self.buckets.values().nth(0) {
            Some(b) => b,
            None => panic!("At least one bucket needs to be open to perform a query for now!"),
        };

        bucket.query(statement, options)
    }

    /// Performs a query against the analytics service.
    ///
    /// For now, please make sure to open one bucket (doesn't matter which one) before performing
    /// a cluster-level analytics query. This limiation will be lifted in the future, but for now
    /// the client needs an open bucket so it knows where internally to route the query.
    ///
    /// # Arguments
    ///
    /// * `statement` - The analytics query string itself.
    /// * `options` - Options to customize the default behavior.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// use couchbase::{CouchbaseError, SharedCluster};
    /// use futures::{Stream, Future};
    /// use serde_json::Value;
    /// #
    /// # let mut cluster = SharedCluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #     .expect("Could not create cluster reference!");
    /// # let _ = cluster.bucket("travel-sample");
    /// #
    /// let mut result = cluster
    ///     .analytics_query("SELECT DataverseName FROM Metadata.`Dataverse`", None)
    ///     .wait()
    ///     .expect("Could not perform analytics query");
    ///
    /// println!("---> rows {:?}", result.rows_as().wait().collect::<Vec<Result<Value, CouchbaseError>>>());
    /// println!("---> meta {:?}", result.meta().wait().expect("Could not get analytics meta"));
    /// ```
    ///
    pub fn analytics_query<S>(
        &self,
        statement: S,
        options: Option<AnalyticsOptions>,
    ) -> impl Future<Item = AnalyticsResult, Error = CouchbaseError>
    where
        S: Into<String>,
    {
        let bucket = match self.buckets.values().nth(0) {
            Some(b) => b,
            None => panic!(
                "At least one bucket needs to be open to perform an analytics query for now!"
            ),
        };

        bucket.analytics_query(statement, options)
    }

    /// Disconnects this cluster and all associated open buckets.
    ///
    /// # Examples
    ///
    /// ```rust,no_run
    /// # use couchbase::SharedCluster;
    /// #
    /// # let mut cluster = SharedCluster::connect("couchbase://127.0.0.1", "Administrator", "password")
    /// #    .expect("Could not create cluster reference!");
    /// #
    /// cluster.disconnect().expect("Could not shutdown properly");
    /// ```
    ///
    pub fn disconnect(&mut self) -> Result<(), CouchbaseError> {
        for bucket in self.buckets.values() {
            bucket.close()?;
        }
        self.buckets.clear();
        Ok(())
    }
}