Skip to content
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.

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

Update docs for pagination. #1592

Merged
merged 8 commits into from
May 17, 2023

Conversation

Yury-Fridlyand
Copy link
Collaborator

Description

Add docs for pagination feature.
Keeping this as a draft, because there are some upcoming changes. Reviews and discussions are welcome though.
Note: query-optimizer-improvement.md wasn't deleted and recreated, just renamed and changed.

Issues Resolved

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Yury-Fridlyand <[email protected]>
@codecov-commenter
Copy link

codecov-commenter commented Apr 28, 2023

Codecov Report

Merging #1592 (d3888ce) into feature/pagination/integ (8e624a5) will not change coverage.
The diff coverage is n/a.

@@                     Coverage Diff                     @@
##             feature/pagination/integ    #1592   +/-   ##
===========================================================
  Coverage                       97.23%   97.23%           
  Complexity                       4233     4233           
===========================================================
  Files                             387      387           
  Lines                           10628    10628           
  Branches                          721      721           
===========================================================
  Hits                            10334    10334           
  Misses                            287      287           
  Partials                            7        7           
Flag Coverage Δ
sql-engine 97.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/index.md Show resolved Hide resolved
Signed-off-by: Yury-Fridlyand <[email protected]>
@Yury-Fridlyand
Copy link
Collaborator Author

Thanks @acarbonetto for your review. I addressed most of your comments. There are upcoming changes for merging index scans and removing total hits - those are not yet reflected in docs.

Copy link
Collaborator

@dai-chen dai-chen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the doc!

@dai-chen dai-chen added the documentation Improvements or additions to documentation label May 3, 2023
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Yury-Fridlyand <[email protected]>
Copy link
Collaborator

@acarbonetto acarbonetto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Several minor comments, but good to push once they are addressed

docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
SecondPageTree --> SecondPage : Execution\nPreparation
```

#### Serialization
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not mentioned here (although maybe we should):

  • What about the request context (like the query start time clock) - how is this serialized
  • What about other request artefacts, such as fetch_size or maybe the filter - if provided. How do these translate from request-to-request?
  • Does this work with post-request processing?
  • What about requests larger than the max window size of 10,000?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • It is not supported yet, but actually it is just binary dumped into cursor
  • It is not supported
  • What do you mean?
  • Good idea, I'll add

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything that we know is not-supported should be mentioned.

docs/dev/Pagination-v2.md Outdated Show resolved Hide resolved
docs/dev/query-optimizer-improvement.md Outdated Show resolved Hide resolved
Yury-Fridlyand and others added 3 commits May 11, 2023 20:29
Co-authored-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Yury-Fridlyand <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Yury-Fridlyand <[email protected]>
Signed-off-by: Yury-Fridlyand <[email protected]>
@Yury-Fridlyand Yury-Fridlyand merged commit bede0b9 into feature/pagination/integ May 17, 2023
@Yury-Fridlyand Yury-Fridlyand deleted the feature/pagination/docs branch May 17, 2023 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pagination Pagination feature, ref #656
Projects
Status: Planned work items
Development

Successfully merging this pull request may close these issues.

8 participants