Improve support for sorting by a timestamp column #142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aaronsama
force-pushed
the
support_sorting_by_datetime
branch
3 times, most recently
from
180f828
to
ef00cf5
Compare
aaronsama
force-pushed
the
support_sorting_by_datetime
branch
from
ef00cf5
to
8979030
Compare
There was a problem hiding this comment.
Thanks for submitting this PR and for factoring in the changes done by
@xijo in #92 and @amandawraymond in #111 . I think having this in a separate cursor class should make maintenance and extensibility easier in future and having the cursor encode a number for the timestamp field should lead to more compact cursors than encoding an object with their own keys.
I've left a few comments, let me know if there are any questions on them and let's try to get this released soon 🙂
…rsors add spec coverage for timestamp order_by selector in pagination fetch Bump version to 0.3.1
Merge the latest changes from master into this PR to "rebase" it and avoid a force push.
aaronsama
force-pushed
the
support_sorting_by_datetime
branch
from
ddf8237
to
f255e47
Compare
Add a new subclass of the `Cursor` class to encode/decode cursors using a timestamp column (such as `created_at`) as order field. It encodes the value of the field as a number with microsecond resolution (the default for MySQL). This cursor class is instantiated instead of the regular `Cursor` when an `order_field` of a compatible type is used to configure the paginator.
Apply suggestions to improve methods' documentation Co-authored-by: Nicolas Fricke <1423331+nicolas-fricke@users.noreply.github.com>
aaronsama
force-pushed
the
support_sorting_by_datetime
branch
from
f255e47
to
e7e539e
Compare
nicolas-fricke
approved these changes
Oct 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR uses #111 as a base to introduce a new type of cursor to be used when ordering by timestamp columns (e.g.
created_at).The paginator detects that the SQL type of
order_byis a:datetime(here) and instantiates a new type of cursor that is able to correctly encode timestamps with the resolution of 1 microsecond.This allows pagination to work correctly down to the smallest fraction supported by default.
Fixes #101 #92