couchbase 3.0.0.alpha.2 → 3.0.0

data/examples/managing_buckets.rb

@@ -1,10 +1,24 @@
-require 'couchbase'
-include Couchbase
+#    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.
+
+require "couchbase"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 def measure(msg)
   start = Time.now
   yield
-  printf "%s in %.2f seconds\n", msg, Time.now - start
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
 options = Cluster::ClusterOptions.new

data/examples/managing_collections.rb

@@ -1,10 +1,24 @@
-require 'couchbase'
-include Couchbase
+#    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.
+
+require "couchbase"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 def measure(msg)
   start = Time.now
   yield
-  printf "%s in %.2f seconds\n", msg, Time.now - start
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
 bucket_name = "travel-sample"
@@ -15,7 +29,6 @@ options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 bucket = cluster.bucket(bucket_name)
 
-
 scopes = bucket.collections.get_all_scopes
 puts "There are #{scopes.size} on the bucket \"#{bucket_name}\""
 
@@ -26,7 +39,7 @@ scopes.each do |scope|
   end
 end
 
-if scopes.any? {|scope| scope.name == scope_name }
+if scopes.any? { |scope| scope.name == scope_name }
   measure("Scope \"#{scope_name}\" has been removed") { bucket.collections.drop_scope(scope_name) }
 end
 measure("Scope \"#{scope_name}\" has been created") { bucket.collections.create_scope(scope_name) }
@@ -43,8 +56,8 @@ end
 
 scope = bucket.collections.get_scope(scope_name)
 puts "Scope \"#{scope_name}\" has #{scope.collections.size} collections"
-scope.collections.each do |collection|
-  puts "  * \"#{collection.name}\""
+scope.collections.each do |c|
+  puts "  * \"#{c.name}\""
 end
 
 measure("Collection \"#{collection.name}\" on scope \"#{collection.scope_name}\" has been dropped") do
@@ -53,6 +66,6 @@ end
 
 scope = bucket.collections.get_scope(scope_name)
 puts "Scope \"#{scope_name}\" has #{scope.collections.size} collections"
-scope.collections.each do |collection|
-  puts "  * \"#{collection.name}\""
+scope.collections.each do |c|
+  puts "  * \"#{c.name}\""
 end

data/examples/managing_query_indexes.rb

@@ -1,25 +1,33 @@
-require 'couchbase'
-include Couchbase
+#    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.
+
+require "couchbase"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 def measure(msg)
   start = Time.now
   yield
-  printf "%s in %.2f seconds\n", msg, Time.now - start
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
 def display_indexes(indexes, bucket_name)
   puts "There are #{indexes.size} query indexes in the bucket \"#{bucket_name}\":"
   indexes.each do |index|
     print "  * [#{index.state}] #{index.name}"
-    if index.primary?
-      print " (primary)"
-    end
-    unless index.index_key.empty?
-      print " on [#{index.index_key.join(", ")}]"
-    end
-    if index.condition
-      print " where #{index.condition}"
-    end
+    print " (primary)" if index.primary?
+    print " on [#{index.index_key.join(', ')}]" unless index.index_key.empty?
+    print " where #{index.condition}" if index.condition
     puts
   end
 end
@@ -28,36 +36,48 @@ bucket_name = "beer-sample"
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")
-cluster = Cluster.connect("couchbase://192.168.42.101", options)
+cluster = Cluster.connect("couchbase://localhost", options)
 
 display_indexes(cluster.query_indexes.get_all_indexes(bucket_name), bucket_name)
 
 index_name = "demo_index"
 options = Management::QueryIndexManager::DropIndexOptions.new
 options.ignore_if_does_not_exist = true
-measure("Index \"#{index_name}\" has been dropped") { cluster.query_indexes.drop_index(bucket_name, index_name, options) }
+measure("Index \"#{index_name}\" has been dropped") do
+  cluster.query_indexes.drop_index(bucket_name, index_name, options)
+end
 
 options = Management::QueryIndexManager::CreateIndexOptions.new
 options.ignore_if_exists = true
 options.condition = "abv > 2"
-measure("Index \"#{index_name}\" has been created") { cluster.query_indexes.create_index(bucket_name, index_name, %w[`type` `name`], options) }
+measure("Index \"#{index_name}\" has been created") do
+  cluster.query_indexes.create_index(bucket_name, index_name, %w[`type` `name`], options)
+end
 
 options = Management::QueryIndexManager::DropPrimaryIndexOptions.new
 options.ignore_if_does_not_exist = true
-measure("Primary index \"#{bucket_name}\" has been dropped") { cluster.query_indexes.drop_primary_index(bucket_name, options) }
+measure("Primary index \"#{bucket_name}\" has been dropped") do
+  cluster.query_indexes.drop_primary_index(bucket_name, options)
+end
 
 options = Management::QueryIndexManager::CreatePrimaryIndexOptions.new
 options.deferred = true
-measure("Primary index \"#{bucket_name}\" has been created") { cluster.query_indexes.create_primary_index(bucket_name, options) }
+measure("Primary index \"#{bucket_name}\" has been created") do
+  cluster.query_indexes.create_primary_index(bucket_name, options)
+end
 
 display_indexes(cluster.query_indexes.get_all_indexes(bucket_name), bucket_name)
 
-measure("Build of the indexes for \"#{bucket_name}\" has been triggered") { cluster.query_indexes.build_deferred_indexes(bucket_name) }
+measure("Build of the indexes for \"#{bucket_name}\" has been triggered") do
+  cluster.query_indexes.build_deferred_indexes(bucket_name)
+end
 
 display_indexes(cluster.query_indexes.get_all_indexes(bucket_name), bucket_name)
 
 options = Management::QueryIndexManager::WatchIndexesOptions.new
 options.watch_primary = true
-measure("Watching for primary index build completion for \"#{bucket_name}\" has been finished") { cluster.query_indexes.watch_indexes(bucket_name, [], 10_000_000, options) }
+measure("Watching for primary index build completion for \"#{bucket_name}\" has been finished") do
+  cluster.query_indexes.watch_indexes(bucket_name, [], 10_000_000, options)
+end
 
 display_indexes(cluster.query_indexes.get_all_indexes(bucket_name), bucket_name)

data/examples/managing_search_indexes.rb

@@ -0,0 +1,77 @@
+#    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.
+
+require "couchbase"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
+
+def measure(msg)
+  start = Time.now
+  yield
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
+end
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+search_indexes = cluster.search_indexes.get_all_indexes
+puts "There are #{search_indexes.size} search indexes on the cluster"
+search_indexes.each do |index|
+  num_docs = cluster.search_indexes.get_indexed_documents_count(index.name)
+  puts "* #{index.name.inspect} contains #{num_docs} documents"
+end
+
+search_index_name = "my_index"
+begin
+  index = cluster.search_indexes.get_index(search_index_name)
+  measure("index #{index.name.inspect} has been dropped") do
+    cluster.search_indexes.drop_index(index.name)
+  end
+rescue Error::IndexNotFound
+  # Ignored
+end
+
+index = Management::SearchIndex.new
+index.type = "fulltext-index"
+index.name = search_index_name
+index.source_type = "couchbase"
+index.source_name = "beer-sample"
+
+measure("index #{search_index_name.inspect} has been created") do
+  cluster.search_indexes.upsert_index(index)
+end
+num_indexed = 0
+loop do
+  sleep(1)
+  num = cluster.search_indexes.get_indexed_documents_count(search_index_name)
+  break if num_indexed == num
+
+  num_indexed = num
+  puts "#{index.name.inspect} indexed #{num_indexed}"
+end
+
+search_indexes = cluster.search_indexes.get_all_indexes
+puts "There are #{search_indexes.size} search indexes on the cluster"
+search_indexes.each do |idx|
+  num_docs = cluster.search_indexes.get_indexed_documents_count(idx.name)
+  puts "* #{index.name.inspect} contains #{num_docs} documents"
+end
+
+document = {
+  title: "Hello world",
+  content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+}
+analysis = cluster.search_indexes.analyze_document(search_index_name, document)
+puts "Analysis of document using definition of the index #{search_index_name}:"
+pp analysis

data/examples/managing_view_indexes.rb

@@ -0,0 +1,68 @@
+#    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.
+
+require "couchbase"
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
+
+def measure(msg)
+  start = Time.now
+  yield
+  printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
+end
+
+def display_indexes(manager, namespace)
+  indexes = manager.get_all_design_documents(namespace)
+  puts "\"#{namespace}\" namespace of the bucket \"#{manager.bucket_name}\" contains #{indexes.size} design documents:"
+  indexes.each do |index|
+    puts "  * #{index.name} (#{index.views.size} views)"
+    index.views.each do |name, view|
+      puts "    - #{name}"
+      puts "      map:\n#{view.map.strip.gsub(/^/, '      | ')}" if view.has_map?
+      puts "      reduce:\n#{view.reduce.strip.gsub(/^/, '      | ')}" if view.has_reduce?
+    end
+  end
+end
+
+bucket_name = "beer-sample"
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+bucket = cluster.bucket(bucket_name)
+manager = bucket.view_indexes
+
+display_indexes(manager, :production)
+
+design_document_name = "test"
+begin
+  manager.drop_design_document(design_document_name, :development)
+rescue Error::DesignDocumentNotFound
+  # ignore
+end
+
+view = Management::View.new
+view.map_function = "function (doc, meta) { emit(meta.id, null) }"
+
+design_document = Management::DesignDocument.new
+design_document.name = design_document_name
+design_document.views["get_all"] = view
+
+manager.upsert_design_document(design_document, :development)
+
+display_indexes(manager, :development)
+
+# copy design document from development namespace to production
+manager.publish_design_document(design_document_name)
+display_indexes(manager, :production)

data/examples/query.rb

@@ -1,6 +1,20 @@
-require 'couchbase'
+#    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.
 
-include Couchbase
+require "couchbase"
+
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")
@@ -13,6 +27,6 @@ options.named_parameters({type: "hotel"})
 options.metrics = true
 res = cluster.query("SELECT * FROM `travel-sample` WHERE type = $type LIMIT 10", options)
 res.rows.each do |row|
-  puts "#{row["travel-sample"]["country"]}. #{row["travel-sample"]["name"]}"
+  puts "#{row['travel-sample']['country']}. #{row['travel-sample']['name']}"
 end
 puts "Status: #{res.meta_data.status}. Execution time: #{res.meta_data.metrics.execution_time}"

data/examples/query_with_consistency.rb

@@ -1,6 +1,20 @@
-require 'couchbase'
+#    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.
 
-include Couchbase
+require "couchbase"
+
+include Couchbase # rubocop:disable Style/MixinUsage for brevity
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")
@@ -21,9 +35,9 @@ puts "METHOD 1: using :request_plus"
 
 random_number = rand(0..1_000_000_000)
 collection.upsert("user:#{random_number}", {
-    "name" => ["Brass", "Doorknob"],
-    "email" => "brass.doorknob@example.com",
-    "data" => random_number,
+  "name" => %w[Brass Doorknob],
+  "email" => "brass.doorknob@example.com",
+  "data" => random_number,
 })
 
 options = Cluster::QueryOptions.new
@@ -32,12 +46,10 @@ options.positional_parameters(["Brass"])
 options.scan_consistency = :request_plus
 res = cluster.query("SELECT name, email, data, META(`default`).id FROM `default` WHERE $1 IN name", options)
 res.rows.each do |row|
-  puts "Name: #{row["name"].join(" ")}, e-mail: #{row["email"]}, data: #{row["data"]}"
-  if row["data"] == random_number
-    puts "--- Found our newly created document!"
-  end
-  if ENV['REMOVE_DOOR_KNOBS']
-    puts "Removing #{row["id"]} (requested via env)"
+  puts "Name: #{row['name'].join(' ')}, e-mail: #{row['email']}, data: #{row['data']}"
+  puts "--- Found our newly created document!" if row["data"] == random_number
+  if ENV["REMOVE_DOOR_KNOBS"]
+    puts "Removing #{row['id']} (requested via env)"
     collection.remove(row["id"])
   end
 end
@@ -51,9 +63,9 @@ puts "METHOD 2: using MutationState"
 
 random_number = rand(0..1_000_000_000)
 res = collection.upsert("user:#{random_number}", {
-    "name" => ["Brass", "Doorknob"],
-    "email" => "brass.doorknob@example.com",
-    "data" => random_number,
+  "name" => %w[Brass Doorknob],
+  "email" => "brass.doorknob@example.com",
+  "data" => random_number,
 })
 
 state = MutationState.new(res.mutation_token)
@@ -65,12 +77,10 @@ options.positional_parameters(["Brass"])
 options.consistent_with(state)
 res = cluster.query("SELECT name, email, data, META(`default`).id FROM `default` WHERE $1 IN name", options)
 res.rows.each do |row|
-  puts "Name: #{row["name"].join(" ")}, e-mail: #{row["email"]}, data: #{row["data"]}"
-  if row["data"] == random_number
-    puts "--- Found our newly created document!"
-  end
-  if ENV['REMOVE_DOOR_KNOBS']
-    puts "Removing #{row["id"]} (requested via env)"
+  puts "Name: #{row['name'].join(' ')}, e-mail: #{row['email']}, data: #{row['data']}"
+  puts "--- Found our newly created document!" if row["data"] == random_number
+  if ENV["REMOVE_DOOR_KNOBS"]
+    puts "Removing #{row['id']} (requested via env)"
     collection.remove(row["id"])
   end
 end