Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion gcloud/datastore/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,31 @@ def fetch(self, limit=None, offset=0, start_cursor=None, end_cursor=None,


class Iterator(object):
"""Represent the state of a given execution of a Query."""
"""Represent the state of a given execution of a Query.

:type query: :class:`gcloud.datastore.query.Query`
:param query: Query object holding permanent configuration (i.e.
things that don't change on with each page in
a results set).

:type client: :class:`gcloud.datastore.client.Client`
:param client: The client used to make a request.

:type limit: integer
:param limit: (Optional) Limit the number of results returned.

:type offset: integer
:param offset: (Optional) Defaults to 0. Offset used to begin
a query.

:type start_cursor: bytes
:param start_cursor: (Optional) Cursor to begin paging through
query results.

:type end_cursor: bytes
:param end_cursor: (Optional) Cursor to end paging through
query results.
"""

_NOT_FINISHED = datastore_pb.QueryResultBatch.NOT_FINISHED

Expand Down