Skip to content

kvdb/sqlite: enable incremental auto_vacuum on DB creation #9672

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

Merged

Conversation

Roasbeef
Copy link
Member

@Roasbeef Roasbeef commented Apr 2, 2025

In this commit, we make a change that enables the auto_vacuum = incremental pragma for SQLite databases, but only when the database file is first created. Incremental auto-vacuum allows SQLite to reclaim unused space within the database file over time, preventing indefinite growth.

According to the SQLite documentation, the auto_vacuum mode must be set before any tables are created in the database. To achieve this, a new boolean parameter isCreate has been added to the NewSqliteBackend function.

The createDBDriver now passes true for this parameter, ensuring the pragma is set during initial database setup. Conversely, openDBDriver passes false when opening an existing database, leaving the existing vacuum mode untouched.

We also change, the internal representation of pragma options was refactored to use a named struct pragmaOption for improved clarity.

@Roasbeef Roasbeef added kvdb sqlite Issues related to SQLite labels Apr 2, 2025
@Roasbeef Roasbeef added this to the v0.19.0 milestone Apr 2, 2025
@Roasbeef Roasbeef requested review from a team, Copilot, bhandras and bitromortac and removed request for a team April 2, 2025 21:39
Copy link
Contributor

coderabbitai bot commented Apr 2, 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enables incremental auto_vacuum for newly created SQLite databases by setting the corresponding SQLite pragma during database creation.

  • Updated NewSqliteBackend to include a new isCreate boolean parameter.
  • Modified createDBDriver and openDBDriver to pass appropriate values for isCreate.
  • Refactored internal representation of pragma options to use the named struct pragmaOption.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
kvdb/sqlite/driver.go Updated function calls to NewSqliteBackend with a new boolean flag.
kvdb/sqlite/db.go Modified NewSqliteBackend signature and added auto_vacuum logic using pragmaOption.

@ziggie1984 ziggie1984 self-requested a review April 2, 2025 21:45
@Roasbeef Roasbeef force-pushed the kvdb-sqlite-incremental-vacuum branch from a28b432 to faba39f Compare April 2, 2025 22:57
// is meant to open existing databases, but the underlying driver might
// create one if it doesn't exist. We need to know if we are creating
// it here to set the initial pragmas correctly (like auto_vacuum).
fullPath := filepath.Join(dbPath, filename)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We'll need to do the same thing for sqldb.NewSqliteStore(...)

func NewSqliteStore(cfg *SqliteConfig, dbPath string) (*SqliteStore, error) {
which is used if the user requested to run lnd with native schema.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah good catch. Added in the latest commit.

Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

just a reminder to add a temporary replace in the go.mod to point to the kvdb package so that the sqlite itests can run against this (or open another PR with a go.mod that points to this PR)

@Roasbeef Roasbeef requested review from bhandras and ziggie1984 April 3, 2025 23:20
@Roasbeef
Copy link
Member Author

Roasbeef commented Apr 3, 2025

Added the temp replace.

@Roasbeef Roasbeef force-pushed the kvdb-sqlite-incremental-vacuum branch from 319d881 to ec02bb0 Compare April 4, 2025 03:03
Copy link
Collaborator

@bhandras bhandras left a comment

Choose a reason for hiding this comment

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

LGTM, thank you! 🎉

@bhandras bhandras requested a review from ellemouton April 4, 2025 06:04
@bhandras
Copy link
Collaborator

bhandras commented Apr 4, 2025

Please note that the sqlite unit tests are failing now.

Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

looks good - just a quick question re if it matters that we do this switch on isCreate

@Roasbeef Roasbeef force-pushed the kvdb-sqlite-incremental-vacuum branch from ec02bb0 to 29a9f4e Compare April 4, 2025 22:48
Roasbeef added 3 commits April 4, 2025 15:49
In this commit, we make a change that enables the `auto_vacuum =
incremental` pragma for SQLite databases, but only when the database
file is first created. Incremental auto-vacuum allows SQLite to reclaim
unused space within the database file over time, preventing indefinite
growth.
@Roasbeef Roasbeef force-pushed the kvdb-sqlite-incremental-vacuum branch from 29a9f4e to 9eef2a0 Compare April 4, 2025 22:49
@Roasbeef Roasbeef merged commit f0ea5bf into lightningnetwork:master Apr 5, 2025
32 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kvdb no-changelog sqlite Issues related to SQLite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants