Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
3ff304bc
Commit
3ff304bc
authored
Oct 08, 2020
by
Brett Walker
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Details on our offset pagintaion implementation
in GraphQL
parent
14c064c2
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
26 additions
and
1 deletion
+26
-1
doc/development/graphql_guide/pagination.md
doc/development/graphql_guide/pagination.md
+26
-1
No files found.
doc/development/graphql_guide/pagination.md
View file @
3ff304bc
...
...
@@ -205,7 +205,32 @@ the `order_due_date_and_labels_priority` method creates a very complex query.
These types of queries are not supported. In these instances, you can use offset pagination.
<!-- ### Offset pagination -->
### Offset pagination
There are times when the complexity of sorting is more than our keyset pagination can handle.
For example in
[
`IssuesResolver`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/graphql/resolvers/issues_resolver.rb
)
,
when sorting by
`priority_asc`
, we can't use keyset pagination, as the ordering is much
too complex (see
[
`issuable.rb`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/models/concerns/issuable.rb
)
).
In cases like this, we can fallback to using regular offset pagination by returning a
`Gitlab::Graphql::Pagination::OffsetActiveRecordRelationConnection`
instead of an
`ActiveRecord::Relation`
For example:
```
ruby
def
resolve
(
parent
,
finder
,
**
args
)
issues
=
apply_lookahead
(
Gitlab
::
Graphql
::
Loaders
::
IssuableLoader
.
new
(
parent
,
finder
).
batching_find_all
)
if
non_stable_cursor_sort?
(
args
[
:sort
])
# Certain complex sorts are not supported by the stable cursor pagination yet.
# In these cases, we use offset pagination, so we return the correct connection.
Gitlab
::
Graphql
::
Pagination
::
OffsetActiveRecordRelationConnection
.
new
(
issues
)
else
issues
end
end
```
<!-- ### External pagination -->
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment