Skip to content

Commit

Permalink
Change allow_unsafe_locale to also apply on new databases (#17238)
Browse files Browse the repository at this point in the history
We relax this as there are use cases where this is safe, though it is
still highly recommended that people avoid using it.
  • Loading branch information
erikjohnston committed May 29, 2024
1 parent d152f1b commit 21a6ef4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
1 change: 1 addition & 0 deletions changelog.d/17238.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Change the `allow_unsafe_locale` config option to also apply when setting up new databases.
11 changes: 5 additions & 6 deletions docs/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,11 @@ host all all ::1/128 ident

### Fixing incorrect `COLLATE` or `CTYPE`

Synapse will refuse to set up a new database if it has the wrong values of
`COLLATE` and `CTYPE` set. Synapse will also refuse to start an existing database with incorrect values
of `COLLATE` and `CTYPE` unless the config flag `allow_unsafe_locale`, found in the
`database` section of the config, is set to true. Using different locales can cause issues if the locale library is updated from
underneath the database, or if a different version of the locale is used on any
replicas.
Synapse will refuse to start when using a database with incorrect values of
`COLLATE` and `CTYPE` unless the config flag `allow_unsafe_locale`, found in the
`database` section of the config, is set to true. Using different locales can
cause issues if the locale library is updated from underneath the database, or
if a different version of the locale is used on any replicas.

If you have a database with an unsafe locale, the safest way to fix the issue is to dump the database and recreate it with
the correct locale parameter (as shown above). It is also possible to change the
Expand Down
8 changes: 7 additions & 1 deletion synapse/storage/engines/postgres.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ def check_new_database(self, txn: Cursor) -> None:
apply stricter checks on new databases versus existing database.
"""

allow_unsafe_locale = self.config.get("allow_unsafe_locale", False)
if allow_unsafe_locale:
return

collation, ctype = self.get_db_locale(txn)

errors = []
Expand All @@ -154,7 +158,9 @@ def check_new_database(self, txn: Cursor) -> None:
if errors:
raise IncorrectDatabaseSetup(
"Database is incorrectly configured:\n\n%s\n\n"
"See docs/postgres.md for more information." % ("\n".join(errors))
"See docs/postgres.md for more information. You can override this check by"
"setting 'allow_unsafe_locale' to true in the database config.",
"\n".join(errors),
)

def convert_param_style(self, sql: str) -> str:
Expand Down

0 comments on commit 21a6ef4

Please sign in to comment.