Class: Google::Cloud::Firestore::V1::ExplainOptions

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/query_profile.rb

Overview

Explain options for the query.

Instance Attribute Summary collapse

Instance Attribute Details

#analyze ⇒ ::Boolean

Returns Optional. Whether to execute this query.

When false (the default), the query will be planned, returning only metrics from the planning stages.

When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.

Returns:

  • (::Boolean) —

    Optional. Whether to execute this query.

    When false (the default), the query will be planned, returning only metrics from the planning stages.

    When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.



34
35
36
37
 
# File 'proto_docs/google/firestore/v1/query_profile.rb', line 34

class ExplainOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end