Method: Diplomat::Query#explain

Defined in:
lib/diplomat/query.rb

#explain(key, options = {}) ⇒ OpenStruct

Get the fully rendered query template

Parameters:

  • key (String) —

    the prepared query ID or name

  • options (Hash) (defaults to: {}) —

    :dc Consul datacenter to query

Returns:

  • (OpenStruct) —

    the list of results from the prepared query or prepared query template



83
84
85
86
87
 
# File 'lib/diplomat/query.rb', line 83

def explain(key, options = {})
  custom_params = options[:dc] ? use_named_parameter('dc', options[:dc]) : nil
  ret = send_get_request(@conn, ["/v1/query/#{key}/explain"], options, custom_params)
  OpenStruct.new JSON.parse(ret.body)
end