master/synapse
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix schema lint script to understand CREATE TABLE IF NOT EXISTS (#19020)

Browse Source 
The schema lint tries to make sure we don't add or remove indices in
schema files (rather than as background updates), *unless* the table was
created in the same schema file.

The regex to pull out the `CREATE TABLE` SQL incorrectly didn't
recognise `IF NOT EXISTS`.

There is a test delta file that shows that we accept different types of
`CREATE TABLE` and `CREATE INDEX` statements, as well as an index
creation that doesn't have a matching create table (to show that we do
still catch it). The test delta should be removed before merge.
This commit is contained in:
Erik Johnston 2025-10-31 13:16:47 +00:00 committed by GitHub
parent 07e7980572
commit 3ccc5184e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/19020.misc Normal file
View File

@ -0,0 +1 @@
Fix CI linter for schema delta files to correctly handle all types of `CREATE TABLE` syntax.

20
scripts-dev/check_schema_delta.py
View File

@ -11,9 +11,13 @@ import click
import git import git
SCHEMA_FILE_REGEX = re.compile(r"^synapse/storage/schema/(.*)/delta/(.*)/(.*)$") SCHEMA_FILE_REGEX = re.compile(r"^synapse/storage/schema/(.*)/delta/(.*)/(.*)$")
INDEX_CREATION_REGEX = re.compile(r"CREATE .*INDEX .*ON ([a-z_]+)", flags=re.IGNORECASE) INDEX_CREATION_REGEX = re.compile(
INDEX_DELETION_REGEX = re.compile(r"DROP .*INDEX ([a-z_]+)", flags=re.IGNORECASE) r"CREATE .*INDEX .*ON ([a-z_0-9]+)", flags=re.IGNORECASE
TABLE_CREATION_REGEX = re.compile(r"CREATE .*TABLE ([a-z_]+)", flags=re.IGNORECASE) )
INDEX_DELETION_REGEX = re.compile(r"DROP .*INDEX ([a-z_0-9]+)", flags=re.IGNORECASE)
TABLE_CREATION_REGEX = re.compile(
r"CREATE .*TABLE.* ([a-z_0-9]+)\s*\(", flags=re.IGNORECASE
)
# The base branch we want to check against. We use the main development branch # The base branch we want to check against. We use the main development branch
# on the assumption that is what we are developing against. # on the assumption that is what we are developing against.
@ -173,11 +177,14 @@ def main(force_colors: bool) -> None:
clause = match.group() clause = match.group()
click.secho( click.secho(
f"Found delta with index deletion: '{clause}' in {delta_file}\nThese should be in background updates.", f"Found delta with index deletion: '{clause}' in {delta_file}",
fg="red", fg="red",
bold=True, bold=True,
color=force_colors, color=force_colors,
) )
click.secho(
" ↪ These should be in background updates.",
)
return_code = 1 return_code = 1
# Check for index creation, which is only allowed for tables we've # Check for index creation, which is only allowed for tables we've
@ -188,11 +195,14 @@ def main(force_colors: bool) -> None:
table_name = match.group(1) table_name = match.group(1)
if table_name not in created_tables: if table_name not in created_tables:
click.secho( click.secho(
f"Found delta with index creation: '{clause}' in {delta_file}\nThese should be in background updates.", f"Found delta with index creation for existing table: '{clause}' in {delta_file}",
fg="red", fg="red",
bold=True, bold=True,
color=force_colors, color=force_colors,
) )
click.secho(
" ↪ These should be in background updates (or the table should be created in the same delta).",
)
return_code = 1 return_code = 1
click.get_current_context().exit(return_code) click.get_current_context().exit(return_code)