datastore.query_explain

Classes

ExplainOptions

Options for query explain operations.

IndexDefinition

Represents an index that would be used in PlanSummary.

PlanSummary

Container class for planSummary returned by query explain.

ExecutionStats

Container class for executionStats returned by analyze mode.

ExplainMetrics

Container class for explainMetrics returned by query explain.

Module Contents

class datastore.query_explain.ExplainOptions(*args, **kwds)

Bases: enum.Enum

Options for query explain operations.

DEFAULT = False
ANALYZE = True
to_repr()
Return type:

Dict[str, bool]

classmethod from_repr(data)
Parameters:

data (Dict[str, bool])

Return type:

ExplainOptions

class datastore.query_explain.IndexDefinition(query_scope='', properties=None)

Represents an index that would be used in PlanSummary.

Raw:
[
{

“query_scope”: “Collection group”, “properties”: “(done ASC, priority DESC, __name__ ASC)”

}

]

query_scope: “Collection group” properties: [(“done”, “ASC”), (“priority”, “DESC”), (“__name__”, “ASC”)]

Parameters:

  • query_scope (str)

  • properties (Optional[List[Tuple[str, str]]])

_PROPERTIES_PATTERN
query_scope = ''
properties = []
__repr__()
Return type:

str

__eq__(other)
Parameters:

other (Any)

Return type:

bool

classmethod from_repr(data)
Parameters:

data (Dict[str, Any])

Return type:

IndexDefinition

to_repr()
Return type:

Dict[str, Any]

class datastore.query_explain.PlanSummary(indexes_used=None)

Container class for planSummary returned by query explain.

Parameters:

indexes_used (Optional[List[IndexDefinition]])

indexes_used = []
__repr__()
Return type:

str

__eq__(other)
Parameters:

other (object)

Return type:

bool

classmethod from_repr(data)
Parameters:

data (Dict[str, Any])

Return type:

PlanSummary

to_repr()
Return type:

Dict[str, Any]

class datastore.query_explain.ExecutionStats(results_returned=0, execution_duration=0.0, read_operations=0, debug_stats=None)

Container class for executionStats returned by analyze mode.

Parameters:

  • results_returned (int)

  • execution_duration (float)

  • read_operations (int)

  • debug_stats (Optional[Dict[str, Any]])

results_returned = 0
execution_duration = 0.0
read_operations = 0
debug_stats
__repr__()
Return type:

str

__eq__(other)
Parameters:

other (object)

Return type:

bool

static _parse_execution_duration(execution_duration)

Convert execution_duration from str (e.g. “0.01785s”) to float.

Parameters:

execution_duration (Optional[Union[str, float]])

Return type:

float

static _parse_debug_stats(debug_stats)

Convert debug_stats values from str to int.

Parameters:

debug_stats (Dict[str, Any])

Return type:

Dict[str, Any]

classmethod from_repr(data)
Parameters:

data (Dict[str, Any])

Return type:

ExecutionStats

to_repr()
Return type:

Dict[str, Any]

class datastore.query_explain.ExplainMetrics(plan_summary=None, execution_stats=None)

Container class for explainMetrics returned by query explain.

Parameters:
plan_summary = None
execution_stats = None
__repr__()
Return type:

str

__eq__(other)
Parameters:

other (object)

Return type:

bool

classmethod from_repr(data)
Parameters:

data (Dict[str, Any])

Return type:

ExplainMetrics

to_repr()
Return type:

Dict[str, Any]