From 1ef8d9a879ceec29baed198587c001bff01fe53e Mon Sep 17 00:00:00 2001 From: Eric Avdey Date: Tue, 14 Oct 2025 12:19:08 -0300 Subject: [PATCH] docs: add missing comments to pagination examples --- .../src/features/pagination/partition_search_pagination.py | 5 +++++ test/examples/src/features/pagination/search_pagination.py | 5 +++++ test/examples/src/features/pagination/view_pagination.py | 5 +++++ 3 files changed, 15 insertions(+) diff --git a/test/examples/src/features/pagination/partition_search_pagination.py b/test/examples/src/features/pagination/partition_search_pagination.py index fdcd448e..9347be48 100644 --- a/test/examples/src/features/pagination/partition_search_pagination.py +++ b/test/examples/src/features/pagination/partition_search_pagination.py @@ -45,12 +45,17 @@ # Do something with row pass +# Option: use pager next page # For retrieving one page at a time with a method call. pager: Pager = pagination.pager() if pager.has_next(): page = pager.get_next() # Do something with page +# Option: use pager all results +# For retrieving all result rows in a single list +# Note: all result rows may be very large! +# Preferably use iterables instead of get_all for memory efficiency with large result sets. all_pager: Pager = pagination.pager() all_rows = all_pager.get_all() for page in all_rows: diff --git a/test/examples/src/features/pagination/search_pagination.py b/test/examples/src/features/pagination/search_pagination.py index 5b352973..7dcd4550 100644 --- a/test/examples/src/features/pagination/search_pagination.py +++ b/test/examples/src/features/pagination/search_pagination.py @@ -44,12 +44,17 @@ # Do something with row pass +# Option: use pager next page # For retrieving one page at a time with a method call. pager: Pager = pagination.pager() if pager.has_next(): page = pager.get_next() # Do something with page +# Option: use pager all results +# For retrieving all result rows in a single list +# Note: all result rows may be very large! +# Preferably use iterables instead of get_all for memory efficiency with large result sets. all_pager: Pager = pagination.pager() all_rows = all_pager.get_all() for page in all_rows: diff --git a/test/examples/src/features/pagination/view_pagination.py b/test/examples/src/features/pagination/view_pagination.py index dbd265da..53bff03d 100644 --- a/test/examples/src/features/pagination/view_pagination.py +++ b/test/examples/src/features/pagination/view_pagination.py @@ -43,12 +43,17 @@ # Do something with row pass +# Option: use pager next page # For retrieving one page at a time with a method call. pager: Pager = pagination.pager() if pager.has_next(): page = pager.get_next() # Do something with page +# Option: use pager all results +# For retrieving all result rows in a single list +# Note: all result rows may be very large! +# Preferably use iterables instead of get_all for memory efficiency with large result sets. all_pager: Pager = pagination.pager() all_rows = all_pager.get_all() for page in all_rows: