datastore.query¶
Classes¶
Container class for results returned by a query operation (with or without |
Module Contents¶
- class datastore.query.BaseQuery¶
- json_key: str¶
- value_kind¶
- __repr__()¶
- Return type:
str
- classmethod from_repr(data)¶
- Abstractmethod:
- Parameters:
data (Dict[str, Any])
- Return type:
- abstractmethod to_repr()¶
- Return type:
Dict[str, Any]
- class datastore.query.Query(kind='', query_filter=None, order=None, start_cursor='', end_cursor='', offset=None, limit=None, projection=None, distinct_on=None)¶
Bases:
BaseQuery- Parameters:
kind (str)
query_filter (Optional[datastore.filter.Filter])
order (Optional[List[datastore.property_order.PropertyOrder]])
start_cursor (str)
end_cursor (str)
offset (Optional[int])
limit (Optional[int])
projection (Optional[List[datastore.projection.Projection]])
distinct_on (Optional[List[str]])
- json_key = 'query'¶
- kind = ''¶
- query_filter = None¶
- orders = []¶
- start_cursor = ''¶
- end_cursor = ''¶
- offset = None¶
- limit = None¶
- projection = []¶
- distinct_on = []¶
- __eq__(other)¶
- Parameters:
other (Any)
- Return type:
bool
- to_repr()¶
- Return type:
Dict[str, Any]
- class datastore.query.GQLQuery(query_string, allow_literals=True, named_bindings=None, positional_bindings=None)¶
Bases:
BaseQuery- Parameters:
query_string (str)
allow_literals (bool)
named_bindings (Optional[Dict[str, Any]])
positional_bindings (Optional[List[Any]])
- json_key = 'gqlQuery'¶
- query_string¶
- allow_literals = True¶
- named_bindings¶
- positional_bindings = []¶
- __eq__(other)¶
- Parameters:
other (Any)
- Return type:
bool
- classmethod _param_from_repr(param_repr)¶
- Parameters:
param_repr (Dict[str, Any])
- Return type:
Any
- to_repr()¶
- Return type:
Dict[str, Any]
- _param_to_repr(param)¶
- Parameters:
param (Any)
- Return type:
Dict[str, Any]
- class datastore.query.GQLCursor(value)¶
- Parameters:
value (str)
- value¶
- __eq__(other)¶
- Parameters:
other (Any)
- Return type:
bool
- class datastore.query.QueryResultBatch(end_cursor, entity_result_type=ResultType.UNSPECIFIED, entity_results=None, more_results=MoreResultsType.UNSPECIFIED, skipped_cursor='', skipped_results=0, snapshot_version='', read_time=None)¶
- Parameters:
end_cursor (str)
entity_result_type (datastore.constants.ResultType)
entity_results (Optional[List[datastore.entity.EntityResult]])
more_results (datastore.constants.MoreResultsType)
skipped_cursor (str)
skipped_results (int)
snapshot_version (str)
read_time (Optional[str])
- entity_result_kind¶
- end_cursor¶
- entity_result_type¶
- entity_results = []¶
- more_results¶
- skipped_cursor = ''¶
- skipped_results = 0¶
- snapshot_version = ''¶
- read_time = None¶
- __eq__(other)¶
- Parameters:
other (Any)
- Return type:
bool
- __repr__()¶
- Return type:
str
- classmethod from_repr(data)¶
- Parameters:
data (Dict[str, Any])
- Return type:
- to_repr()¶
- Return type:
Dict[str, Any]
- class datastore.query.QueryResult(result_batch=None, explain_metrics=None, transaction=None)¶
Container class for results returned by a query operation (with or without explain metrics).
- Parameters:
result_batch (Optional[QueryResultBatch])
explain_metrics (Optional[datastore.query_explain.ExplainMetrics])
transaction (Optional[str])
- query_result_batch_kind¶
- result_batch = None¶
- explain_metrics = None¶
- transaction = None¶
- __repr__()¶
- Return type:
str
- __eq__(other)¶
- Parameters:
other (object)
- Return type:
bool
- classmethod from_repr(data)¶
- Parameters:
data (Dict[str, Any])
- Return type:
- to_repr()¶
- Return type:
Dict[str, Any]
- get_explain_metrics()¶
- Return type:
Optional[datastore.query_explain.ExplainMetrics]
- get_plan_summary()¶
- Return type:
Optional[datastore.query_explain.PlanSummary]
- get_execution_stats()¶
- Return type:
Optional[datastore.query_explain.ExecutionStats]