Skip to content

feat: use keyset pagination by default for all=True #1003

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

Merged
bufferoverflow merged 2 commits into from
Feb 25, 2020
Merged

feat: use keyset pagination by default for all=True #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99b4484
feat: use keyset pagination by default for `all=True`
max-wittig Jan 27, 2020
1609824
docs(pagination): clear up pagination docs
max-wittig Feb 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/api-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,11 @@ listing methods support the ``page`` and ``per_page`` parameters:
By default GitLab does not return the complete list of items. Use the ``all``
parameter to get all the items when using listing methods:

.. warning::

The all=True option uses keyset pagination by default if order_by is not supplied,
or if order_by="id".

.. code-block:: python

all_groups = gl.groups.list(all=True)
Expand Down Expand Up @@ -391,4 +396,3 @@ parameter to that API invocation:

gl = gitlab.gitlab(url, token, api_version=4)
gl.projects.import_github(ACCESS_TOKEN, 123456, "root", timeout=120.0)

6 changes: 6 additions & 0 deletions gitlab/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,12 @@ def http_list(self, path, query_data=None, as_list=None, **kwargs):
get_all = kwargs.pop("all", False)
url = self._build_url(path)

# use keyset pagination automatically, if all=True
order_by = kwargs.get("order_by")
if get_all and (not order_by or order_by == "id"):
kwargs["pagination"] = "keyset"
kwargs["order_by"] = "id"

if get_all is True and as_list is True:
return list(GitlabList(self, url, query_data, **kwargs))

Expand Down