couchbase 3.0.0.beta.1 → 3.0.0

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
@@ -35,29 +43,41 @@ 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

@@ -1,10 +1,24 @@
+#    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
+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
@@ -42,20 +56,21 @@ 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 |index|
-  num_docs = cluster.search_indexes.get_indexed_documents_count(index.name)
+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."
+  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}:"

data/examples/managing_view_indexes.rb

@@ -1,10 +1,24 @@
+#    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
+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(manager, namespace)
@@ -14,8 +28,8 @@ def display_indexes(manager, namespace)
     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?
+      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

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

data/examples/search.rb

@@ -1,6 +1,20 @@
-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
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")
@@ -18,91 +32,91 @@ rescue Error::IndexNotFound
   index.source_type = "couchbase"
   index.source_name = "beer-sample"
   index.params = {
-      mapping: {
-          default_datetime_parser: "dateTimeOptional",
-          types: {
-              "beer" => {
-                  properties: {
-                      "abv" => {
-                          fields: [
-                              {
-                                  name: "abv",
-                                  type: "number",
-                                  include_in_all: true,
-                                  index: true,
-                                  store: true,
-                                  docvalues: true,
-                              }
-                          ]
-                      },
-                      "category" => {
-                          fields: [
-                              {
-                                  name: "category",
-                                  type: "text",
-                                  include_in_all: true,
-                                  include_term_vectors: true,
-                                  index: true,
-                                  store: true,
-                                  docvalues: true,
-                              }
-                          ]
-                      },
-                      "description" => {
-                          fields: [
-                              {
-                                  name: "description",
-                                  type: "text",
-                                  include_in_all: true,
-                                  include_term_vectors: true,
-                                  index: true,
-                                  store: true,
-                                  docvalues: true,
-                              }
-                          ]
-                      },
-                      "name" => {
-                          fields: [
-                              {
-                                  name: "name",
-                                  type: "text",
-                                  include_in_all: true,
-                                  include_term_vectors: true,
-                                  index: true,
-                                  store: true,
-                                  docvalues: true,
-                              }
-                          ]
-                      },
-                      "style" => {
-                          fields: [
-                              {
-                                  name: "style",
-                                  type: "text",
-                                  include_in_all: true,
-                                  include_term_vectors: true,
-                                  index: true,
-                                  store: true,
-                                  docvalues: true,
-                              }
-                          ]
-                      },
-                      "updated" => {
-                          fields: [
-                              {
-                                  name: "updated",
-                                  type: "datetime",
-                                  include_in_all: true,
-                                  index: true,
-                                  store: true,
-                                  docvalues: true,
-                              }
-                          ]
-                      },
-                  }
-              }
-          }
-      }
+    mapping: {
+      default_datetime_parser: "dateTimeOptional",
+      types: {
+        "beer" => {
+          properties: {
+            "abv" => {
+              fields: [
+                {
+                  name: "abv",
+                  type: "number",
+                  include_in_all: true,
+                  index: true,
+                  store: true,
+                  docvalues: true,
+                },
+              ],
+            },
+            "category" => {
+              fields: [
+                {
+                  name: "category",
+                  type: "text",
+                  include_in_all: true,
+                  include_term_vectors: true,
+                  index: true,
+                  store: true,
+                  docvalues: true,
+                },
+              ],
+            },
+            "description" => {
+              fields: [
+                {
+                  name: "description",
+                  type: "text",
+                  include_in_all: true,
+                  include_term_vectors: true,
+                  index: true,
+                  store: true,
+                  docvalues: true,
+                },
+              ],
+            },
+            "name" => {
+              fields: [
+                {
+                  name: "name",
+                  type: "text",
+                  include_in_all: true,
+                  include_term_vectors: true,
+                  index: true,
+                  store: true,
+                  docvalues: true,
+                },
+              ],
+            },
+            "style" => {
+              fields: [
+                {
+                  name: "style",
+                  type: "text",
+                  include_in_all: true,
+                  include_term_vectors: true,
+                  index: true,
+                  store: true,
+                  docvalues: true,
+                },
+              ],
+            },
+            "updated" => {
+              fields: [
+                {
+                  name: "updated",
+                  type: "datetime",
+                  include_in_all: true,
+                  index: true,
+                  store: true,
+                  docvalues: true,
+                },
+              ],
+            },
+          },
+        },
+      },
+    },
   }
 
   cluster.search_indexes.upsert_index(index)
@@ -112,6 +126,7 @@ rescue Error::IndexNotFound
     sleep(1)
     num = cluster.search_indexes.get_indexed_documents_count(search_index_name)
     break if num_indexed == num
+
     num_indexed = num
     puts "indexing #{search_index_name.inspect}: #{num_indexed} documents"
   end
@@ -125,24 +140,24 @@ options.fields = %w[name]
 options.highlight_style = :html
 options.highlight_fields = %w[name description]
 options.sort = [
-    Cluster::SearchSort.field("abv") do |spec|
-      spec.type = :number
-    end,
-    Cluster::SearchSort.score do |spec|
-      spec.desc = true
-    end,
-    "category",
-    Cluster::SearchSort.id,
+  Cluster::SearchSort.field("abv") do |spec|
+    spec.type = :number
+  end,
+  Cluster::SearchSort.score do |spec|
+    spec.desc = true
+  end,
+  "category",
+  Cluster::SearchSort.id,
 ]
 
 res = cluster.search_query(search_index_name, query, options)
 res.rows.each_with_index do |row, idx|
   document = row.fields
-  puts "\n#{idx}. #{document["name"]} (id: #{row.id.inspect})"
+  puts "\n#{idx}. #{document['name']} (id: #{row.id.inspect})"
   row.fragments.each do |field, fragments|
     puts "  * #{field}"
     fragments.each do |fragment|
-      puts "      - #{fragment.gsub(/\n/, ' ')}"
+      puts "      - #{fragment.tr("\n", ' ')}"
     end
   end
 end
@@ -171,17 +186,17 @@ options.facets["by_strength"] = numeric_facet
 
 res = cluster.search_query(search_index_name, query, options)
 
-puts "\n==== Top 3 beer names (out of #{res.facets["by_name"].total}):"
+puts "\n==== Top 3 beer names (out of #{res.facets['by_name'].total}):"
 res.facets["by_name"].terms.each_with_index do |term, idx|
   puts "#{idx}. #{term.term} (#{term.count} records)"
 end
 
-puts "\n==== Beer by strength (out of #{res.facets["by_strength"].total}):"
+puts "\n==== Beer by strength (out of #{res.facets['by_strength'].total}):"
 res.facets["by_strength"].numeric_ranges.each_with_index do |range, idx|
   puts "#{idx}. #{range.name}, ABV: [#{range.min}..#{range.max}] (#{range.count} records)"
 end
 
-puts "\n==== The most recently updated (out of #{res.facets["by_time"].total}):"
+puts "\n==== The most recently updated (out of #{res.facets['by_time'].total}):"
 res.facets["by_time"].date_ranges.each_with_index do |range, idx|
   puts "#{idx}. #{range.name} [#{range.start_time}..#{range.end_time}] (#{range.count} records)"
 end