Skip to content

Increase performance of invoice query #9756

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ziggie1984
Copy link
Collaborator

@ziggie1984 ziggie1984 commented Apr 23, 2025

We used to paginate through the invoice dataset via the offset parameter, however using offset for large databases is very inefficient because it has to scan and discard invoices. Now we use the keyset to paginate through the dataset.

Fixes: #9730

Copy link
Contributor

coderabbitai bot commented Apr 23, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ziggie1984 ziggie1984 added this to the v0.19.0 milestone Apr 23, 2025
@ziggie1984 ziggie1984 self-assigned this Apr 23, 2025
@ziggie1984 ziggie1984 requested review from bhandras and Roasbeef April 23, 2025 12:12
@@ -70,6 +70,11 @@ var (
// schema. This is optional and can be disabled by the
// user if necessary.
},
{
Name: "000007_invoice_modification",
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is supposed to add the index? Maybe the file is missing from the PR now as the tests fail.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Wonder if we should come up with a nice naming convention because we might fix stuff in the future as well.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe something as simple as 000007_invoices if we do more changes to the schema than adding the index, otherwise 000007_invoices_settle_id_index.

@bhandras
Copy link
Collaborator

Great catch!!

@saubyk saubyk moved this to In Progress in lnd v0.19 Apr 23, 2025
We remove the offset query variable and instead use the keyset to
filter and paginate through the index.
We also make sure AMP subinvoices are also fetched with the
pagination limit.
@ziggie1984 ziggie1984 marked this pull request as ready for review April 23, 2025 15:36
@ZZiigguurraatt
Copy link

We used to paginate through the invoice dataset via the offset parameter, however using offset for large databases is very inefficient because it has to scan and discard invoices. Now we use the keyset to paginate through the dataset.

so even if we have an add or settle index you are saying the old way still scanned through everything still and internally discarded before responding to the client?

@ziggie1984
Copy link
Collaborator Author

so even if we have an add or settle index you are saying the old way still scanned through everything still and internally discarded before responding to the client?

The old way used the offset of SQL for pagination instead of the keyset pagination. So it would for every new query increase the offset which is super inefficient for large dbs as we know right now. It is ok for smaller dbs tho, so the approach is logically right but does not account for large dbs.

@Roasbeef
Copy link
Member

Perhaps we can make a one off benchmark w/ the postgres backend so we can gauge the tangible perf increase here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

[bug]: unknown postgres query hangs on startup
4 participants