Class: Couchbase::Cluster::QueryMetaData

Inherits:

Object

• Object
• Couchbase::Cluster::QueryMetaData

Defined in:

lib/couchbase/query_options.rb

Instance Attribute Summary

• #client_context_id ⇒ String

  Returns the client context identifier string set of the query request.

• #metrics ⇒ QueryMetrics

  Metrics as returned by the query engine, if enabled.

• #profile ⇒ Hash

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

• #request_id ⇒ String

  Returns the request identifier string of the query request.

• #signature ⇒ Hash

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

• #status ⇒ Symbol

  Returns raw query execution status as returned by the query engine.

• #warnings ⇒ Array<QueryWarning>

  List of warnings returned by the query engine.

Instance Method Summary

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

  A new instance of QueryMetaData.

Constructor Details

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

Returns a new instance of QueryMetaData.

Yield Parameters:

• self (QueryMetaData)

# File 'lib/couchbase/query_options.rb', line 68

def initialize
  yield self if block_given?
end

Instance Attribute Details

#client_context_id ⇒ String

# File 'lib/couchbase/query_options.rb', line 50

def client_context_id
  @client_context_id
end

#metrics ⇒ QueryMetrics

# File 'lib/couchbase/query_options.rb', line 62

def metrics
  @metrics
end

#profile ⇒ Hash

# File 'lib/couchbase/query_options.rb', line 59

def profile
  @profile
end

#request_id ⇒ String

# File 'lib/couchbase/query_options.rb', line 47

def request_id
  @request_id
end

#signature ⇒ Hash

# File 'lib/couchbase/query_options.rb', line 56

def signature
  @signature
end

#status ⇒ Symbol

# File 'lib/couchbase/query_options.rb', line 53

def status
  @status
end

#warnings ⇒ Array<QueryWarning>

# File 'lib/couchbase/query_options.rb', line 65

def warnings
  @warnings
end