Skip to content

Commit

Permalink
docs: Mark database argument for get_by_id and its async counterpart …
Browse files Browse the repository at this point in the history
…as ignored (#905)

* docs: Mark database argument for get_by_id and its async counterpart as ignored

The Client class should be used to set the database instead.

* Update google/cloud/ndb/model.py

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

* Update google/cloud/ndb/model.py

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

---------

Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
rwhogg and parthea committed Aug 9, 2023
1 parent 978aa4a commit b0f4310
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions google/cloud/ndb/model.py
Expand Up @@ -5764,8 +5764,7 @@ def _get_by_id(
``global_cache_timeout``.
max_memcache_items (int): No longer supported.
force_writes (bool): No longer supported.
database (Optional[str]): Database for the entity to load. If not
passed, uses the client's value.
database (Optional[str]): This parameter is ignored. Please set the database on the Client instead.
Returns:
Optional[Model]: The retrieved entity, if one is found.
Expand Down Expand Up @@ -5851,6 +5850,7 @@ def _get_by_id_async(
``global_cache_timeout``.
max_memcache_items (int): No longer supported.
force_writes (bool): No longer supported.
database (Optional[str]): This parameter is ignored. Please set the database on the Client instead.
Returns:
tasklets.Future: Optional[Model]: The retrieved entity, if one is
Expand Down

0 comments on commit b0f4310

Please sign in to comment.