Class: Couchbase::Scope

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/scope.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/scope.rb more...

Overview

The scope identifies a group of collections and allows high application density as a result.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(backend, bucket_name, scope_name) ⇒ Scope

Returns a new instance of Scope.

Parameters:

  • backend (Couchbase::Backend)
  • bucket_name (String) —

    name of the bucket

  • scope_name (String) —

    name of the scope

[View source]

30
31
32
33
34
 
# File 'lib/couchbase/scope.rb', line 30

def initialize(backend, bucket_name, scope_name)
  @backend = backend
  @bucket_name = bucket_name
  @name = scope_name
end

Instance Attribute Details

#bucket_name ⇒ Object (readonly)

Returns the value of attribute bucket_name.


22
23
24
 
# File 'lib/couchbase/scope.rb', line 22

def bucket_name
  @bucket_name
end

#name ⇒ Object (readonly)

Returns the value of attribute name.


23
24
25
 
# File 'lib/couchbase/scope.rb', line 23

def name
  @name
end

Instance Method Details

#analytics_query(statement, options = Options::Analytics::DEFAULT) ⇒ AnalyticsResult

Performs an analytics query

The query will be implicitly scoped using current bucket and scope names.

Examples:

Select name of the given user

scope.analytics_query("SELECT u.name AS uname FROM GleambookUsers u WHERE u.id = $user_id ",
                       Options::Analytics(named_parameters: {user_id: 2}))

Parameters:

  • statement (String) —

    the N1QL query statement

  • options (Options::Analytics) (defaults to: Options::Analytics::DEFAULT) —

    the custom options for this query

Returns:

  • (AnalyticsResult)
[View source]

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
 
# File 'lib/couchbase/scope.rb', line 100

def analytics_query(statement, options = Options::Analytics::DEFAULT)
  resp = @backend.document_analytics(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))

  Cluster::AnalyticsResult.new do |res|
    res.transcoder = options.transcoder
    res.meta_data = Cluster::AnalyticsMetaData.new do |meta|
      meta.status = resp[:meta][:status]
      meta.request_id = resp[:meta][:request_id]
      meta.client_context_id = resp[:meta][:client_context_id]
      meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
      meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
      meta.metrics = Cluster::AnalyticsMetrics.new do |metrics|
        if resp[:meta][:metrics]
          metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
          metrics.execution_time = resp[:meta][:metrics][:execution_time]
          metrics.result_count = resp[:meta][:metrics][:result_count]
          metrics.result_size = resp[:meta][:metrics][:result_size]
          metrics.error_count = resp[:meta][:metrics][:error_count]
          metrics.warning_count = resp[:meta][:metrics][:warning_count]
          metrics.processed_objects = resp[:meta][:metrics][:processed_objects]
        end
      end
      res[:warnings] = resp[:warnings].map { |warn| Cluster::AnalyticsWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
    end
    res.instance_variable_set(:@rows, resp[:rows])
  end
end

#collection(collection_name) ⇒ Collection

Opens the default collection for this scope

Parameters:

  • collection_name (String) —

    name of the collection

Returns:

[View source]

41
42
43
 
# File 'lib/couchbase/scope.rb', line 41

def collection(collection_name)
  Collection.new(@backend, @bucket_name, @name, collection_name)
end

#query(statement, options = Options::Query::DEFAULT) ⇒ QueryResult

Performs a query against the query (N1QL) services.

The query will be implicitly scoped using current bucket and scope names.

Examples:

Select first ten hotels from travel sample dataset

scope.query("SELECT * FROM `travel-sample` WHERE type = $type LIMIT 10",
             Options::Query(named_parameters: {type: "hotel"}, metrics: true))

Parameters:

  • statement (String) —

    the N1QL query statement

  • options (Options::Query) (defaults to: Options::Query::DEFAULT) —

    the custom options for this query

Returns:

  • (QueryResult)

See Also:

[View source]

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
 
# File 'lib/couchbase/scope.rb', line 60

def query(statement, options = Options::Query::DEFAULT)
  resp = @backend.document_query(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))

  Cluster::QueryResult.new do |res|
    res.meta_data = Cluster::QueryMetaData.new do |meta|
      meta.status = resp[:meta][:status]
      meta.request_id = resp[:meta][:request_id]
      meta.client_context_id = resp[:meta][:client_context_id]
      meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
      meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
      meta.metrics = Cluster::QueryMetrics.new do |metrics|
        if resp[:meta][:metrics]
          metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
          metrics.execution_time = resp[:meta][:metrics][:execution_time]
          metrics.sort_count = resp[:meta][:metrics][:sort_count]
          metrics.result_count = resp[:meta][:metrics][:result_count]
          metrics.result_size = resp[:meta][:metrics][:result_size]
          metrics.mutation_count = resp[:meta][:metrics][:mutation_count]
          metrics.error_count = resp[:meta][:metrics][:error_count]
          metrics.warning_count = resp[:meta][:metrics][:warning_count]
        end
      end
      meta.warnings = resp[:warnings].map { |warn| Cluster::QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
    end
    res.instance_variable_set(:@rows, resp[:rows])
  end
end

#search_query(index_name, query, options = Options::Search::DEFAULT) ⇒ SearchResult

Performs a Full Text Search (FTS) query

Examples:

Return first 10 results of “hop beer” query and request highlighting

cluster.search_query("travel_index", Cluster::SearchQuery.match_phrase("green"),
                     Options::Search(
                       limit: 10,
                       collections: ["landmark", "hotel"]
                       fields: %w[name],
                       highlight_style: :html,
                       highlight_fields: %w[name description]
                     ))

Parameters:

  • index_name (String) —

    the name of the search index

  • query (SearchQuery) —

    the query tree

  • options (Options::Search) (defaults to: Options::Search::DEFAULT) —

    the query tree

Returns:

  • (SearchResult)
[View source]

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
 
# File 'lib/couchbase/scope.rb', line 145

def search_query(index_name, query, options = Options::Search::DEFAULT)
  resp = @backend.document_search(index_name, JSON.generate(query), options.to_backend(scope_name: @name))

  SearchResult.new do |res|
    res.meta_data = SearchMetaData.new do |meta|
      meta.metrics.max_score = resp[:meta_data][:metrics][:max_score]
      meta.metrics.error_partition_count = resp[:meta_data][:metrics][:error_partition_count]
      meta.metrics.success_partition_count = resp[:meta_data][:metrics][:success_partition_count]
      meta.metrics.took = resp[:meta_data][:metrics][:took]
      meta.metrics.total_rows = resp[:meta_data][:metrics][:total_rows]
      meta.errors = resp[:meta_data][:errors]
    end
    res.rows = resp[:rows].map do |r|
      SearchRow.new do |row|
        row.transcoder = options.transcoder
        row.index = r[:index]
        row.id = r[:id]
        row.score = r[:score]
        row.fragments = r[:fragments]
        unless r[:locations].empty?
          row.locations = SearchRowLocations.new(
            r[:locations].map do |loc|
              SearchRowLocation.new do |location|
                location.field = loc[:field]
                location.term = loc[:term]
                location.position = loc[:position]
                location.start_offset = loc[:start_offset]
                location.end_offset = loc[:end_offset]
                location.array_positions = loc[:array_positions]
              end
            end
          )
        end
        row.instance_variable_set(:@fields, r[:fields])
        row.explanation = JSON.parse(r[:explanation]) if r[:explanation]
      end
    end
    if resp[:facets]
      res.facets = resp[:facets].each_with_object({}) do |(k, v), o|
        facet = case options.facets[k]
                when SearchFacet::SearchFacetTerm
                  SearchFacetResult::TermFacetResult.new do |f|
                    f.terms =
                      if v[:terms]
                        v[:terms].map do |t|
                          SearchFacetResult::TermFacetResult::TermFacet.new(t[:term], t[:count])
                        end
                      else
                        []
                      end
                  end
                when SearchFacet::SearchFacetDateRange
                  SearchFacetResult::DateRangeFacetResult.new do |f|
                    f.date_ranges =
                      if v[:date_ranges]
                        v[:date_ranges].map do |r|
                          SearchFacetResult::DateRangeFacetResult::DateRangeFacet.new(r[:name], r[:count], r[:start_time], r[:end_time])
                        end
                      else
                        []
                      end
                  end
                when SearchFacet::SearchFacetNumericRange
                  SearchFacetResult::NumericRangeFacetResult.new do |f|
                    f.numeric_ranges =
                      if v[:numeric_ranges]
                        v[:numeric_ranges].map do |r|
                          SearchFacetResult::NumericRangeFacetResult::NumericRangeFacet.new(r[:name], r[:count], r[:min], r[:max])
                        end
                      else
                        []
                      end
                  end
                else
                  next # ignore unknown facet result
                end
        facet.name = v[:name]
        facet.field = v[:field]
        facet.total = v[:total]
        facet.missing = v[:missing]
        facet.other = v[:other]
        o[k] = facet
      end
    end
  end
end