Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::ExplainOptions (v1.2.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::ExplainOptions.

Explain options for the query.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#analyze

def analyze() -> ::Boolean
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.

#analyze=

def analyze=(value) -> ::Boolean
Parameter
  • value (::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.

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.