Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Correct read_consistency docs. #948

Merged
merged 2 commits into from
Feb 27, 2024
Merged

docs: Correct read_consistency docs. #948

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e549d0b
docs: Correct read_consistency docs.
sorced-jim Feb 23, 2024
862e1cb
Merge branch 'main' into query-docs
sorced-jim Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
56 changes: 21 additions & 35 deletions google/cloud/ndb/query.py
View file
Open in desktop
Expand Up @@ -1742,11 +1742,9 @@ def fetch(self, limit=None, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down Expand Up @@ -1795,11 +1793,9 @@ def fetch_async(self, limit=None, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down Expand Up @@ -1897,11 +1893,9 @@ def iter(self, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down Expand Up @@ -1960,11 +1954,9 @@ def map(self, callback, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down Expand Up @@ -2073,11 +2065,9 @@ def get(self, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down Expand Up @@ -2178,11 +2168,9 @@ def count(self, limit=None, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down Expand Up @@ -2272,11 +2260,9 @@ def fetch_page(self, page_size, **kwargs):
end_cursor: Endpoint point for search.
timeout (Optional[int]): Override the gRPC timeout, in seconds.
deadline (Optional[int]): DEPRECATED: Synonym for ``timeout``.
read_consistency: If not in a transaction, defaults to
``ndb.EVENTUAL`` for potentially faster query results without
having to wait for Datastore to apply pending changes to all
returned records. Otherwise consistency with current
transaction is maintained.
read_consistency: If set then passes the explicit read consistency to
the server. May not be set to ``ndb.EVENTUAL`` when a transaction
is specified.
read_policy: DEPRECATED: Synonym for ``read_consistency``.
transaction (bytes): Transaction ID to use for query. Results will
be consistent with Datastore state for that transaction.
Expand Down