Skip to content

docs: explain the optional dedicated activity database#2550

Merged
miaulalala merged 1 commit intomasterfrom
docs/dedicated-db-config
May 5, 2026
Merged

docs: explain the optional dedicated activity database#2550
miaulalala merged 1 commit intomasterfrom
docs/dedicated-db-config

Conversation

@karlitschek
Copy link
Copy Markdown
Member

The Activity app already supports an activity_db*-prefixed connection that the AppInfo registers via ConnectionFactory::createConnectionParams('activity_'), falling back to the main Nextcloud DB when none of the keys are set. The behaviour is undocumented outside the source, which makes admins nervous about touching it on busy installations where the activity table grows fastest.

Add docs/database.md covering:

  • when a dedicated connection is worth the operational cost,
  • the full set of activity_db* config keys with types/defaults, including driver options and persistent-connection toggle,
  • a worked config.php example for "same engine, separate host",
  • a TLS driver-options snippet for MySQL,
  • migration, backup and troubleshooting notes.

Link the new doc from the README under a new "Administration" section.

@cypress
Copy link
Copy Markdown

cypress Bot commented May 2, 2026

Activity    Run #3667

Run Properties:  status check passed Passed #3667  •  git commit 48d6f1d76c: docs: explain the optional dedicated activity database
Project Activity
Branch Review docs/dedicated-db-config
Run status status check passed Passed #3667
Run duration 02m 12s
Commit git commit 48d6f1d76c: docs: explain the optional dedicated activity database
Committer Frank Karlitschek
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 1
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 9
View all changes introduced in this branch ↗︎

The Activity app already supports an `activity_db*`-prefixed connection
that the AppInfo registers via `ConnectionFactory::createConnectionParams('activity_')`,
falling back to the main Nextcloud DB when none of the keys are set.
The behaviour is undocumented outside the source, which makes admins
nervous about touching it on busy installations where the activity
table grows fastest.

Add `docs/database.md` covering:

- when a dedicated connection is worth the operational cost,
- the full set of `activity_db*` config keys with types/defaults,
  including driver options and persistent-connection toggle,
- a worked `config.php` example for "same engine, separate host",
- a TLS driver-options snippet for MySQL,
- migration, backup and troubleshooting notes.

Link the new doc from the README under a new "Administration" section.

Signed-off-by: Frank Karlitschek <frank@nextcloud.com>
@miaulalala miaulalala force-pushed the docs/dedicated-db-config branch from 63e3bd2 to 2a6a248 Compare May 5, 2026 18:36
Copy link
Copy Markdown
Collaborator

@miaulalala miaulalala left a comment

Choose a reason for hiding this comment

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

Also added the config options to the sample config: nextcloud/server#59911

@miaulalala miaulalala enabled auto-merge May 5, 2026 18:40
@miaulalala miaulalala merged commit 06eb66f into master May 5, 2026
52 checks passed
@miaulalala miaulalala deleted the docs/dedicated-db-config branch May 5, 2026 18:45
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.

2 participants