Class: Couchbase::Scope

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/scope.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/scope.rb

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, observability) ⇒ 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



32
33
34
35
36
37
 
# File 'lib/couchbase/scope.rb', line 32

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

Instance Attribute Details

#bucket_name ⇒ Object (readonly)

Returns the value of attribute bucket_name.



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

def bucket_name
  @bucket_name
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



25
26
27
 
# File 'lib/couchbase/scope.rb', line 25

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) 


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

def analytics_query(statement, options = Options::Analytics::DEFAULT)
  @observability.record_operation(Observability::OP_ANALYTICS_QUERY, options.parent_span, self, :analytics) do |obs_handler|
    obs_handler.add_query_statement(statement, options)

    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
end

#collection(collection_name) ⇒ Collection

Opens the default collection for this scope

Parameters:

  • collection_name (String) —

    name of the collection

Returns:



44
45
46
 
# File 'lib/couchbase/scope.rb', line 44

def collection(collection_name)
  Collection.new(@backend, @bucket_name, @name, collection_name, @observability)
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:



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

def query(statement, options = Options::Query::DEFAULT)
  @observability.record_operation(Observability::OP_QUERY, options.parent_span, self, :query) do |obs_handler|
    obs_handler.add_query_statement(statement, options)

    resp = @backend.document_query(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name), obs_handler)

    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
end

#search(index_name, search_request, options = Options::Search::DEFAULT) ⇒ SearchResult

Performs a request against the Full Text Search (FTS) service.

Parameters:

  • index_name (String) —

    the name of the search index

  • search_request (SearchRequest) —

    the request

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

    the custom options for this search request

Returns:



170
171
172
173
174
175
176
177
 
# File 'lib/couchbase/scope.rb', line 170

def search(index_name, search_request, options = Options::Search::DEFAULT)
  @observability.record_operation(Observability::OP_SEARCH_QUERY, options.parent_span, self, :search) do |obs_handler|
    encoded_query, encoded_req = search_request.to_backend
    resp = @backend.document_search(@bucket_name, @name, index_name, encoded_query, encoded_req,
                                    options.to_backend(show_request: false), obs_handler)
    convert_search_result(resp, options)
  end
end

#search_indexes ⇒ Management::ScopeSearchIndexManager

Returns:



180
181
182
 
# File 'lib/couchbase/scope.rb', line 180

def search_indexes
  Management::ScopeSearchIndexManager.new(@backend, @bucket_name, @name, @observability)
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:



156
157
158
159
160
161
 
# File 'lib/couchbase/scope.rb', line 156

def search_query(index_name, query, options = Options::Search::DEFAULT)
  @observability.record_operation(Observability::OP_SEARCH_QUERY, options.parent_span, self, :search) do |obs_handler|
    resp = @backend.document_search(@bucket_name, @name, index_name, JSON.generate(query), {}, options.to_backend, obs_handler)
    convert_search_result(resp, options)
  end
end