Class: Couchbase::Cluster::QueryMetaData

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/query_options.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|self| ... } ⇒ QueryMetaData

Returns a new instance of QueryMetaData.

Yield Parameters:

[View source]

192
193
194
 
# File 'lib/couchbase/query_options.rb', line 192

def initialize
  yield self if block_given?
end

Instance Attribute Details

#client_context_id ⇒ String

Returns the client context identifier string set of the query request

Returns:

  • (String) —

    returns the client context identifier string set of the query request


174
175
176
 
# File 'lib/couchbase/query_options.rb', line 174

def client_context_id
  @client_context_id
end

#metrics ⇒ QueryMetrics

Returns metrics as returned by the query engine, if enabled.

Returns:

  • (QueryMetrics) —

    metrics as returned by the query engine, if enabled


186
187
188
 
# File 'lib/couchbase/query_options.rb', line 186

def metrics
  @metrics
end

#profile ⇒ Hash

Returns the profiling information returned by the query engine which is then decoded as JSON object

Returns:

  • (Hash) —

    returns the profiling information returned by the query engine which is then decoded as JSON object


183
184
185
 
# File 'lib/couchbase/query_options.rb', line 183

def profile
  @profile
end

#request_id ⇒ String

Returns the request identifier string of the query request

Returns:

  • (String) —

    returns the request identifier string of the query request


171
172
173
 
# File 'lib/couchbase/query_options.rb', line 171

def request_id
  @request_id
end

#signature ⇒ Hash

Returns the signature as returned by the query engine which is then decoded as JSON object

Returns:

  • (Hash) —

    returns the signature as returned by the query engine which is then decoded as JSON object


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

def signature
  @signature
end

#status ⇒ Symbol

Returns raw query execution status as returned by the query engine

Returns:

  • (Symbol) —

    returns raw query execution status as returned by the query engine


177
178
179
 
# File 'lib/couchbase/query_options.rb', line 177

def status
  @status
end

#warnings ⇒ Array<QueryWarning>

Returns list of warnings returned by the query engine.

Returns:

  • (Array<QueryWarning>) —

    list of warnings returned by the query engine


189
190
191
 
# File 'lib/couchbase/query_options.rb', line 189

def warnings
  @warnings
end