Skip to content
This repository was archived by the owner on May 10, 2024. It is now read-only.

Commit dfa456f

Browse files
committed
Trying to make the docs around the count param a bit more clear.
1 parent de09d40 commit dfa456f

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

boto/dynamodb/layer2.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -681,6 +681,9 @@ def query(self, table, hash_key, range_key_condition=None,
681681
:param count: If True, Amazon DynamoDB returns a total
682682
number of items for the Query operation, even if the
683683
operation has no matching items for the assigned filter.
684+
If count is True, the actual items are not returned and
685+
the count is accessible as the ``count`` attribute of
686+
the returned object.
684687
685688
:type exclusive_start_key: list or tuple
686689
:param exclusive_start_key: Primary key of the item from
@@ -769,6 +772,9 @@ def scan(self, table, scan_filter=None,
769772
:param count: If True, Amazon DynamoDB returns a total
770773
number of items for the Scan operation, even if the
771774
operation has no matching items for the assigned filter.
775+
If count is True, the actual items are not returned and
776+
the count is accessible as the ``count`` attribute of
777+
the returned object.
772778
773779
:type exclusive_start_key: list or tuple
774780
:param exclusive_start_key: Primary key of the item from

boto/dynamodb/table.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,9 @@ def query(self, hash_key, *args, **kw):
435435
:param count: If True, Amazon DynamoDB returns a total
436436
number of items for the Query operation, even if the
437437
operation has no matching items for the assigned filter.
438+
If count is True, the actual items are not returned and
439+
the count is accessible as the ``count`` attribute of
440+
the returned object.
438441
439442
440443
:type item_class: Class
@@ -494,6 +497,9 @@ def scan(self, *args, **kw):
494497
:param count: If True, Amazon DynamoDB returns a total
495498
number of items for the Scan operation, even if the
496499
operation has no matching items for the assigned filter.
500+
If count is True, the actual items are not returned and
501+
the count is accessible as the ``count`` attribute of
502+
the returned object.
497503
498504
:type exclusive_start_key: list or tuple
499505
:param exclusive_start_key: Primary key of the item from

0 commit comments

Comments
 (0)