Class: Couchbase::Cluster::QueryMetaData

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/query_options.rb,
/code/couchbase-ruby-client/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:



70
71
72
 
# File 'lib/couchbase/query_options.rb', line 70

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



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

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



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

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



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

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



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

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



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

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



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

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



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

def warnings
  @warnings
end