couchbase 3.0.0.alpha.3 → 3.0.0.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14fb151cf764b9a7d9550d43dc17749b354d08407e0b47facd30b662893e8fd7
-  data.tar.gz: e38fe6aa52f37a4a1914d73291696de7b22146635e7c138525216618428f4642
+  metadata.gz: 9cadf484dec9dc3efe2877d1efc7b7597d36f789656bb01ac7317a1b126d8a8e
+  data.tar.gz: 30e291dad18dde88211c561d62d47a462224f42d0656d3c0a145ea082b24662f
 SHA512:
-  metadata.gz: 4008f666a840187479ddf68a4fd61ae53c30be3cdd3a69b73ff5acf5e97493b596f9ddfe943d0a1bdcf5495afdedb21c9504796ef07ce3fff8244aa6928cd1dd
-  data.tar.gz: 8d09ec6c24df6a1080e845f9056330edc0d13081bbed689f6357b1b9fb2fd093bb81e5bcd29c047187e714b21d7ffdbf8eb78588c308f6be059f221cb5872950
+  metadata.gz: ec1e0ec9fd56afcb6cbc678d89a11a1274c19d8fcf759949fd25ae71aacc44b4c35dbf2bd5138f049eb77db61333eb9a7b884556b2263b3af4c1f437d38b0f9b
+  data.tar.gz: 35ad568be39129ae9d957d5c9a0c7032e51bb25561740b2693c969322280bcfde2ac673e0a72030d6dab1c1e87016baa7f783e8b74c07f73a39888937c8291f3

data/.github/workflows/tests-6.0.3.yml

@@ -15,7 +15,7 @@ jobs:
       couchbase:
         image: couchbase:enterprise-6.0.3
         ports:
-          - 8091-8094:8091-8094
+          - 8091-8095:8091-8095
           - 11210:11210
 
     steps:
@@ -43,6 +43,9 @@ jobs:
       - name: Display library version
         run: bundle exec ruby -I lib -r couchbase -e 'pp Couchbase::VERSION'
 
+      - name: Check couchbase
+        run: ./bin/check-cluster
+
       - name: Run tests
         run: bundle exec rake test
         env:

data/.github/workflows/tests-dev-preview.yml

@@ -15,7 +15,7 @@ jobs:
       couchbase:
         image: couchbase:enterprise-6.5.1
         ports:
-          - 8091-8094:8091-8094
+          - 8091-8095:8091-8095
           - 11210:11210
 
     steps:
@@ -45,6 +45,9 @@ jobs:
       - name: Display library version
         run: bundle exec ruby -I lib -r couchbase -e 'pp Couchbase::VERSION'
 
+      - name: Check couchbase
+        run: ./bin/check-cluster
+
       - name: Run tests
         run: bundle exec rake test
         env:

data/.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
       couchbase:
         image: couchbase
         ports:
-          - 8091-8094:8091-8094
+          - 8091-8095:8091-8095
           - 11210:11210
 
     steps:
@@ -43,5 +43,8 @@ jobs:
       - name: Display library version
         run: bundle exec ruby -I lib -r couchbase -e 'pp Couchbase::VERSION'
 
+      - name: Check couchbase
+        run: ./bin/check-cluster
+
       - name: Run tests
         run: bundle exec rake test

data/README.md

@@ -16,7 +16,7 @@ Please attach version information to ticket/post. To obtain this information use
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.0.0.alpha.3"
+gem "couchbase", "3.0.0.alpha.4"
 ```
 
 And then execute:

data/bin/check-cluster

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+#    Copyright 2020 Couchbase, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+HOST=${HOST:-localhost}
+USERNAME=${USERNAME:-Administrator}
+PASSWORD=${PASSWOWRD:-password}
+
+CREDS="${USERNAME}:${PASSWORD}"
+
+sleep 1
+
+set -ex
+
+curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools
+curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools/default
+curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools/default/buckets/default
+curl -sS -w "\n" -u${CREDS} http://${HOST}:8091/pools/default/b/default
+

data/bin/init-cluster

@@ -19,6 +19,8 @@ USERNAME=${USERNAME:-Administrator}
 PASSWORD=${PASSWOWRD:-password}
 QUOTA=${QUOTA:-256}
 DEVELOPER_PREVIEW=${DEVELOPER_PREVIEW:-no}
+BEER_SAMPLE=${BEER_SAMPLE:-no}
+TRAVEL_SAMPLE=${TRAVEL_SAMPLE:-no}
 
 CREDS="${USERNAME}:${PASSWORD}"
 
@@ -34,15 +36,15 @@ curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/nodes/self/controller/settings
      -d 'path=%2Fopt%2Fcouchbase%2Fvar%2Flib%2Fcouchbase%2Fdata' \
      -d 'index_path=%2Fopt%2Fcouchbase%2Fvar%2Flib%2Fcouchbase%2Fdata'
 
-# Setup Services
-curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/node/controller/setupServices \
-     -d 'services=kv%2Cn1ql%2Cindex%2Cfts'
-
 # Setup Memory Quotas
 curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/pools/default \
   -d "memoryQuota=${QUOTA}" \
   -d 'indexMemoryQuota=256'
 
+# Setup Services
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/node/controller/setupServices \
+     -d 'services=kv%2Cn1ql%2Cindex%2Cfts%2Ccbas'
+
 # Setup Administrator username and password
 curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/settings/web \
      -d "password=${PASSWORD}" \
@@ -64,6 +66,16 @@ curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/pools/default/buckets \
      -d 'bucketType=membase' \
      -d 'name=default'
 
+if [ "x${BEER_SAMPLE}" != "xno" ]; then
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/sampleBuckets/install \
+     -d '["beer-sample"]'
+fi
+
+if [ "x${TRAVEL_SAMPLE}" != "xno" ]; then
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/sampleBuckets/install \
+     -d '["travel-sample"]'
+fi
+
 if [ "x${DEVELOPER_PREVIEW}" != "xno" ]; then
 curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/settings/developerPreview \
      -d "enabled=true"

data/examples/analytics.rb

@@ -0,0 +1,221 @@
+require 'couchbase'
+
+include Couchbase
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+
+bucket_name = "tiny_social"
+dataverse_name = "TinySocial"
+
+# Prepare dataset
+begin
+  cluster.buckets.drop_bucket(bucket_name)
+rescue Error::BucketNotFound
+  # ignore
+end
+
+settings = Management::BucketSettings.new
+settings.name = bucket_name
+settings.bucket_type = :couchbase
+settings.ram_quota_mb = 100
+cluster.buckets.create_bucket(settings)
+loop do
+  sleep 1
+  break if cluster.buckets.get_all_buckets.find { |b| b.name == bucket_name }.healthy?
+end
+
+collection = cluster.bucket(bucket_name).default_collection
+
+# Documents for GleambookUsers dataset
+[
+    {
+        "id" => 1,
+        "alias" => "Margarita",
+        "name" => "MargaritaStoddard",
+        "nickname" => "Mags",
+        "userSince" => "2012-08-20T10:10:00",
+        "friendIds" => [2, 3, 6, 10],
+        "employment" => [
+            {
+                "organizationName" => "Codetechno",
+                "start-date" => "2006-08-06"
+            },
+            {
+                "organizationName" => "geomedia",
+                "start-date" => "2010-06-17",
+                "end-date" => "2010-01-26"
+            }
+        ],
+        "gender" => "F"
+    },
+    {
+        "id" => 2,
+        "alias" => "Isbel",
+        "name" => "IsbelDull",
+        "nickname" => "Izzy",
+        "userSince" => "2011-01-22T10:10:00",
+        "friendIds" => [1, 4],
+        "employment" => [
+            {
+                "organizationName" => "Hexviafind",
+                "startDate" => "2010-04-27"
+            }
+        ]
+    },
+    {
+        "id" => 3,
+        "alias" => "Emory",
+        "name" => "EmoryUnk",
+        "userSince" => "2012-07-10T10:10:00",
+        "friendIds" => [1, 5, 8, 9],
+        "employment" => [
+            {
+                "organizationName" => "geomedia",
+                "startDate" => "2010-06-17",
+                "endDate" => "2010-01-26"
+            }
+        ]
+    }
+].each do |document|
+  collection.upsert("user:#{document["id"]}",
+                    document.merge({"type" => "user"}))
+end
+
+# Documents for GleambookMessages dataset
+[
+    {
+        "messageId" => 2,
+        "authorId" => 1,
+        "inResponseTo" => 4,
+        "senderLocation" => [41.66, 80.87],
+        "message" => " dislike x-phone its touch-screen is horrible"
+    },
+    {
+        "messageId" => 3,
+        "authorId" => 2,
+        "inResponseTo" => 4,
+        "senderLocation" => [48.09, 81.01],
+        "message" => " like product-y the plan is amazing"
+    },
+    {
+        "messageId" => 4,
+        "authorId" => 1,
+        "inResponseTo" => 2,
+        "senderLocation" => [37.73, 97.04],
+        "message" => " can't stand acast the network is horrible:("
+    },
+    {
+        "messageId" => 6,
+        "authorId" => 2,
+        "inResponseTo" => 1,
+        "senderLocation" => [31.5, 75.56],
+        "message" => " like product-z its platform is mind-blowing"
+    },
+    {
+        "messageId" => 8,
+        "authorId" => 1,
+        "inResponseTo" => 11,
+        "senderLocation" => [40.33, 80.87],
+        "message" => " like ccast the 3G is awesome:)"
+    },
+    {
+        "messageId" => 10,
+        "authorId" => 1,
+        "inResponseTo" => 12,
+        "senderLocation" => [42.5, 70.01],
+        "message" => " can't stand product-w the touch-screen is terrible"
+    },
+    {
+        "messageId" => 11,
+        "authorId" => 1,
+        "inResponseTo" => 1,
+        "senderLocation" => [38.97, 77.49],
+        "message" => " can't stand acast its plan is terrible"
+    }
+].each do |document|
+  collection.upsert("message:#{document["messageId"]}",
+                    document.merge({"type" => "message"}))
+end
+
+if cluster.analytics_indexes.get_all_datasets.any? {|ds| ds.dataverse_name == dataverse_name}
+  # there are datasets on our dataverse, drop everything and re-create
+  options = Management::AnalyticsIndexManager::DisconnectLinkOptions.new
+  options.dataverse_name = dataverse_name
+  cluster.analytics_indexes.disconnect_link(options)
+  cluster.analytics_indexes.drop_dataverse(dataverse_name)
+end
+
+cluster.analytics_indexes.create_dataverse(dataverse_name)
+
+options = Management::AnalyticsIndexManager::CreateDatasetOptions.new
+options.dataverse_name = dataverse_name
+
+options.condition = '`type` = "user"'
+cluster.analytics_indexes.create_dataset("GleambookUsers", bucket_name, options)
+
+options.condition = '`type` = "message"'
+cluster.analytics_indexes.create_dataset("GleambookMessages", bucket_name, options)
+
+options = Management::AnalyticsIndexManager::ConnectLinkOptions.new
+options.dataverse_name = dataverse_name
+cluster.analytics_indexes.connect_link(options)
+
+sleep(1)
+
+puts "---- inner join"
+res = cluster.analytics_query("SELECT * FROM #{dataverse_name}.GleambookUsers u, #{dataverse_name}.GleambookMessages m WHERE m.authorId = u.id")
+res.rows.each do |row|
+  puts "#{row["u"]["name"]}: #{row["m"]["message"].inspect}"
+end
+
+# The query language supports SQL's notion of left outer join.
+puts "---- left outer join"
+res = cluster.analytics_query("
+  USE #{dataverse_name};
+  SELECT u.name AS uname, m.message AS message
+  FROM GleambookUsers u
+  LEFT OUTER JOIN GleambookMessages m ON m.authorId = u.id
+")
+res.rows.each do |row|
+  puts "#{row["uname"]}: #{row["message"].inspect}"
+end
+
+# Named parameters
+puts "---- named parameters"
+options = Cluster::AnalyticsOptions.new
+options.named_parameters({user_id: 2})
+res = cluster.analytics_query("
+USE #{dataverse_name};
+
+SELECT u.name AS uname
+FROM GleambookUsers u
+WHERE u.id = $user_id
+
+UNION ALL
+
+SELECT VALUE m.message
+FROM GleambookMessages m
+WHERE authorId = $user_id
+", options)
+res.rows.each do |row|
+  p row
+end
+
+# Positional parameters
+puts "---- positional parameters"
+options = Cluster::AnalyticsOptions.new
+options.positional_parameters([2])
+res = cluster.analytics_query("
+USE #{dataverse_name};
+SELECT VALUE user
+FROM GleambookUsers AS user
+WHERE len(user.friendIds) > $1
+", options)
+res.rows.each do |row|
+  puts "#{row["name"]}: #{row["friendIds"].size}"
+end
+
+# More query examples at https://docs.couchbase.com/server/current/analytics/3_query.html

data/examples/managing_analytics_indexes.rb

@@ -0,0 +1,72 @@
+require 'couchbase'
+include Couchbase
+
+def measure(msg)
+  start = Time.now
+  yield
+  printf "%s in %.2f seconds\n", msg, Time.now - start
+end
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+manager = cluster.analytics_indexes
+
+options = Management::AnalyticsIndexManager::DropDatasetOptions.new
+options.ignore_if_does_not_exist = true
+options.dataverse_name = "beer-data"
+manager.drop_dataset("beers", options)
+manager.drop_dataset("breweries", options)
+
+options = Management::AnalyticsIndexManager::DropDataverseOptions.new
+options.ignore_if_does_not_exist = true
+manager.drop_dataverse("beer-data", options)
+
+# Creates a dataverse with the name beer-data to be used to manage other metadata entities.
+manager.create_dataverse("beer-data")
+
+# Creates 2 datasets beers and breweries on the beer-sample bucket and filters the content for each dataset by the value
+# of the type field of the record.
+options = Management::AnalyticsIndexManager::CreateDatasetOptions.new
+options.dataverse_name = "beer-data"
+options.condition = '`type` = "beer"'
+manager.create_dataset("beers", "beer-sample", options)
+
+options = Management::AnalyticsIndexManager::CreateDatasetOptions.new
+options.dataverse_name = "beer-data"
+options.condition = '`type` = "brewery"'
+manager.create_dataset("breweries", "beer-sample", options)
+
+# Creates indexes on the identified fields for the specified types.
+options = Management::AnalyticsIndexManager::CreateIndexOptions.new
+options.dataverse_name = "beer-data"
+manager.create_index("beers_name_idx", "beers", {"name" => "string"}, options)
+manager.create_index("breweries_name_idx", "beers", {"name" => "string"}, options)
+manager.create_index("breweries_loc_idx", "beers", {"geo.lon" => "double", "geo.lat" => "double"}, options)
+
+puts "---- Indexes currently defined on the cluster:"
+manager.get_all_indexes.each_with_index do |index, i|
+  puts "#{i}. #{index.dataverse_name}.#{index.dataset_name}.#{index.name} #{"(primary)" if index.primary?}"
+end
+
+# Drops one of the indexes
+options = Management::AnalyticsIndexManager::DropIndexOptions.new
+options.dataverse_name = "beer-data"
+manager.drop_index("breweries_name_idx", "beers", options)
+
+puts "---- Datasets currently defined on the cluster:"
+manager.get_all_datasets.each_with_index do |dataset, i|
+  puts "#{i}. #{dataset.dataverse_name}.#{dataset.name} (link: #{dataset.link_name}, bucket: #{dataset.bucket_name})"
+end
+
+# Connects all datasets to their Data Service buckets and starts shadowing
+options = Management::AnalyticsIndexManager::ConnectLinkOptions.new
+options.dataverse_name = "beer-data"
+manager.connect_link(options)
+
+puts "---- Pending mutations: #{manager.get_pending_mutations.inspect}"
+
+options = Management::AnalyticsIndexManager::DisconnectLinkOptions.new
+options.dataverse_name = "beer-data"
+manager.disconnect_link(options)