Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

let update_synapse_database run on a multi-database configurations #13422

Merged
merged 5 commits into from
Oct 19, 2022
Merged

let update_synapse_database run on a multi-database configurations #13422

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0874fd4
Allow sharded database in db migrate script
Jul 27, 2022
974d152
Update changelog.d/13422.bugfix
thefinn93 Jul 29, 2022
2d28e7b
Remove check entirely
Jul 29, 2022
602e254
remove unused import
Jul 29, 2022
e7423cd
Merge branch 'develop' into allow-update-synapse-with-sharded-databases
Oct 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13422.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a long-standing bug where the `update_synapse_database` script could not be run with multiple databases. Contributed by @thefinn93 @ Beeper.
5 changes: 0 additions & 5 deletions synapse/_scripts/update_synapse_database.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

import argparse
import logging
import sys
from typing import cast

import yaml
Expand Down Expand Up @@ -97,10 +96,6 @@ def main() -> None:
# Load, process and sanity-check the config.
hs_config = yaml.safe_load(args.database_config)

if "database" not in hs_config:
sys.stderr.write("The configuration file must have a 'database' section.\n")
sys.exit(4)

Copy link
Contributor

Choose a reason for hiding this comment

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

Does this mean we no longer error when both database and databases are missing?

Also does anything rely on the exit code being 4?

Copy link
Member

Choose a reason for hiding this comment

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

I think we do this checking at:

synapse/synapse/config/database.py

Lines 97 to 123 in 493c2fc

multi_database_config = config.get("databases")
database_config = config.get("database")
database_path = config.get("database_path")
if multi_database_config and database_config:
raise ConfigError("Can't specify both 'database' and 'databases' in config")
if multi_database_config:
if database_path:
raise ConfigError("Can't specify 'database_path' with 'databases'")
self.databases = [
DatabaseConnectionConfig(name, db_conf)
for name, db_conf in multi_database_config.items()
]
if database_config:
self.databases = [DatabaseConnectionConfig("master", database_config)]
if database_path:
if self.databases and self.databases[0].name != "sqlite3":
logger.warning(NON_SQLITE_DATABASE_PATH_WARNING)
return
database_config = {"name": "sqlite3", "args": {}}
self.databases = [DatabaseConnectionConfig("master", database_config)]
self.set_databasepath(database_path)

Maybe I missed something though!

config = HomeServerConfig()
config.parse_config_dict(hs_config, "", "")

Expand Down