googleapis / googleapis/google-cloud-python

page_size not needed for list_documents

Open
#15,380 1 comment 0 reactions 1 assignee Claimed by @daniel-sanche View on GitHub
api: firestore priority: p3 type: cleanup
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
3d 4h
Merged PRs (30d)
122

Description

We have three rpcs that use pagers: [ListDocuments](https://github.com/googleapis/python-firestore/blob/f10b503b0dc2b23e43495e3f0417ae2630c13d82/google/cloud/firestore_v1/collection.py#L147C48-L147C62), [ListCollectionIds](https://github.com/googleapis/python-firestore/blob/f10b503b0dc2b23e43495e3f0417ae2630c13d82/google/cloud/firestore_v1/client.py#L288), and [PartitionQuery](https://github.com/googleapis/python-firestore/blob/f10b503b0dc2b23e43495e3f0417ae2630c13d82/google/cloud/firestore_v1/query.py#L465)

Currently, onlt list_documents provides the user with a [customizable page_size arg](https://github.com/googleapis/python-firestore/blob/f10b503b0dc2b23e43495e3f0417ae2630c13d82/google/cloud/firestore_v1/collection.py#L124). But all 3 rpcs abstract the pages from the users, and provide them with a flat generator over the underlying resources, so it's debatable whether the page_size argument even makes sense to provide.

To be consistent, we should either remove it from list_documents, or provide it in all three

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.