Skip to content

Improve concurrent database access#361

Merged
JanJakes merged 4 commits intotrunkfrom
db-locked-error
Apr 17, 2026
Merged

Improve concurrent database access#361
JanJakes merged 4 commits intotrunkfrom
db-locked-error

Conversation

@JanJakes
Copy link
Copy Markdown
Member

Summary

Reduces lock contention under concurrent access by avoiding unnecessary write locks for read-only queries.

  1. Skip the wrapper transaction for SELECT statements. A standalone SELECT translates to a single SQLite query, so the implicit autocommit transaction provides sufficient consistency — no explicit BEGIN/COMMIT needed.
  2. Use deferred BEGIN for other read-only wrapper transactions. SHOW and DESCRIBE queries still use a wrapper transaction (they may translate to multiple SQLite queries), but now use a deferred BEGIN (SHARED lock) instead of BEGIN IMMEDIATE (RESERVED lock).

Background

The wrapper transaction previously used BEGIN IMMEDIATE for all queries, including read-only SELECTs. This acquired a RESERVED (write) lock on every query — but SQLite only allows one RESERVED lock at a time. Under concurrent load (e.g., multiple PHP-FPM workers handling requests simultaneously), all processes competed for the single write lock. When the 10-second busy timeout was exceeded, SQLite returned SQLITE_BUSY ("database is locked", error 5).

SHARED locks, acquired by a deferred BEGIN, are compatible with RESERVED locks — multiple readers can proceed concurrently alongside an active writer.

Fixes #318

1. Use deferred BEGIN (SHARED lock) instead of BEGIN IMMEDIATE (RESERVED
   lock) for read-only wrapper transactions (SHOW, DESCRIBE).
2. Skip the wrapper transaction entirely for SELECT statements.

Fixes: #318
@JanJakes JanJakes marked this pull request as ready for review April 13, 2026 15:29
@JanJakes JanJakes requested review from a team and bgrgicak April 14, 2026 14:42
* [GRAMMAR]
* simpleStatement: selectStatement | showStatement | utilityStatement | ...
*/
$statement_node = $child_node->get_first_child_node();
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Should we wrap this in if ( null === $child_node ) because it seems like $child_node can be null?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

👍 At this point in the AST, there is probably always a child node, but it's a good idea to add it, also for consistency with the code above. Fixed in 14dc77a.

/**
* Tests for concurrent access to the same SQLite database file.
*/
class WP_SQLite_Driver_Concurrency_Tests extends TestCase {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Should we add a test for showStatement queries to confirm that it uses the correct BEGIN?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

👍 Added tests for SHOW and DESCRIBE in c559b3a.

@JanJakes JanJakes requested a review from bgrgicak April 16, 2026 10:31
@JanJakes
Copy link
Copy Markdown
Member Author

@bgrgicak Thanks! Addressed both issues.

Pin BEGIN IMMEDIATE for write statements (INSERT, UPDATE, DELETE,
REPLACE, CREATE/ALTER/DROP/TRUNCATE TABLE) so a future regression
that accidentally flags a write as read-only — downgrading the lock
to a deferred BEGIN — is caught immediately.

Mirror the existing SELECT two-connection contention test for SHOW
and DESCRIBE, proving they succeed under a concurrent RESERVED lock
instead of only asserting the logged BEGIN string.

Factor out a couple of small helpers to remove the repeated driver
and query-logger setup boilerplate.
@JanJakes JanJakes merged commit 2224d1a into trunk Apr 17, 2026
16 checks passed
@JanJakes JanJakes deleted the db-locked-error branch April 17, 2026 12:36
@JanJakes JanJakes mentioned this pull request Apr 17, 2026
JanJakes added a commit that referenced this pull request Apr 17, 2026
## Release `3.0.0-rc.1`

Version bump and changelog update for release `3.0.0-rc.1`.

**Changelog draft:**
* Improve concurrent database access
([#361](#361))
* Remove legacy SQLite driver
([#358](#358))

**Full changelog:**
v2.2.23...release/v3.0.0-rc.1

## Next steps

1. **Review** the changes in this pull request.
2. **Push** any additional edits to this branch (`release/v3.0.0-rc.1`).
3. **Merge** this pull request to complete the release.

Merging will automatically build the plugin ZIP and create a [GitHub
release](https://github.com/WordPress/sqlite-database-integration/releases).

> [!NOTE]
> This is a **pre-release**. It will not be deployed to
[WordPress.org](https://wordpress.org/plugins/sqlite-database-integration/).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Address database is locked error

2 participants