Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve schema config migration utils #5475

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Improve schema config migration utils #5475

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f0b2c5
Improve schema config migration utils
sharadsw Dec 13, 2024
311082d
Catch table name exceptions
sharadsw Dec 16, 2024
bf39ae5
Avoid skipping revert on error
sharadsw Dec 16, 2024
1156398
Improve revert functions
sharadsw Dec 16, 2024
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
66 changes: 27 additions & 39 deletions specifyweb/specify/migration_utils/update_schema_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
import re

from typing import NamedTuple, List
import logging

from django.db.models import Q
from django.apps import apps

from specifyweb.specify.load_datamodel import Table
from specifyweb.specify.load_datamodel import Table, FieldDoesNotExistError, TableDoesNotExistError
from specifyweb.specify.models import (
datamodel,
)

logger = logging.getLogger(__name__)

HIDDEN_FIELDS = [
"timestampcreated", "timestampmodified", "version", "createdbyagent", "modifiedbyagent"
]
Expand Down Expand Up @@ -62,9 +65,13 @@ def update_table_schema_config_with_defaults(
):
Splocalecontainer = apps.get_model('specify', 'Splocalecontainer')
Splocaleitemstr = apps.get_model('specify', 'Splocaleitemstr')
Splocalecontaineritem = apps.get_model('specify', 'Splocalecontaineritem')

table: Table = datamodel.get_table(table_name)
try:
table: Table = datamodel.get_table_strict(table_name)
except TableDoesNotExistError:
logger.warning(f"Table does not exist in latest state of the datamodel, skipping Schema Config entry for: {table_name}")
return

table_config = TableSchemaConfig(
name=table.name,
discipline_id=discipline_id,
Expand All @@ -74,7 +81,7 @@ def update_table_schema_config_with_defaults(
)

# Create Splocalecontainer for the table
sp_local_container = Splocalecontainer.objects.create(
sp_local_container, _ = Splocalecontainer.objects.get_or_create(
name=table_config.name.lower(),
discipline_id=discipline_id,
schematype=table_config.schema_type,
Expand All @@ -91,38 +98,13 @@ def update_table_schema_config_with_defaults(
'version': 0,
}
item_str[k] = sp_local_container
Splocaleitemstr.objects.create(**item_str)
Splocaleitemstr.objects.get_or_create(**item_str)

for field in table.all_fields:
# Create Splocalecontaineritem for each field
sp_local_container_item = Splocalecontaineritem.objects.create(
name=field.name,
container=sp_local_container,
type=datamodel_type_to_schematype(field.type) if field.is_relationship else field.type,
ishidden=field.name.lower() in HIDDEN_FIELDS,
isrequired=field.required,
issystem=table.system,
version=0,
)

# Splocaleitemstr for the field name and description
for k, text in {
"itemname": camel_to_spaced_title_case(field.name),
"itemdesc": camel_to_spaced_title_case(field.name),
}.items():
itm_str = {
"text": text,
"language": "en",
"version": 0,
}
itm_str[k] = sp_local_container_item
Splocaleitemstr.objects.create(**itm_str)
update_table_field_schema_config_with_defaults(table_name, discipline_id, field.name, apps)


def revert_table_schema_config(table_name, apps = apps):
table: Table = datamodel.get_table(table_name)
table_name = table.name

Splocalecontainer = apps.get_model('specify', 'Splocalecontainer')
Splocaleitemstr = apps.get_model('specify', 'Splocaleitemstr')
Splocalecontaineritem = apps.get_model('specify', 'Splocalecontaineritem')
Expand All @@ -144,7 +126,12 @@ def update_table_field_schema_config_with_defaults(
field_name: str,
apps = apps
):
table: Table = datamodel.get_table(table_name)
try:
table: Table = datamodel.get_table_strict(table_name)
except TableDoesNotExistError:
logger.warning(f"Table does not exist in latest state of the datamodel, skipping Schema Config entry for: {table_name}")
return

table_name = table.name
table_config = TableSchemaConfig(
name=table_name.lower(),
Expand All @@ -157,13 +144,17 @@ def update_table_field_schema_config_with_defaults(
Splocaleitemstr = apps.get_model('specify', 'Splocaleitemstr')
Splocalecontaineritem = apps.get_model('specify', 'Splocalecontaineritem')

sp_local_container = Splocalecontainer.objects.get(
sp_local_container, _ = Splocalecontainer.objects.get_or_create(
name=table.name.lower(),
discipline_id=discipline_id,
schematype=table_config.schema_type,
)

field = table.get_field(field_name)
try:
field = table.get_field_strict(field_name)
except FieldDoesNotExistError:
logger.warning(f"Field does not exist in latest state of the datamodel, skipping Schema Config entry for: {table_name} -> {field_name}")
return

field_config = FieldSchemaConfig(
name=field_name,
Expand All @@ -173,7 +164,7 @@ def update_table_field_schema_config_with_defaults(
language="en"
)

sp_local_container_item = Splocalecontaineritem.objects.create(
sp_local_container_item, _ = Splocalecontaineritem.objects.get_or_create(
name=field_config.name,
container=sp_local_container,
type=field_config.java_type,
Expand All @@ -193,12 +184,9 @@ def update_table_field_schema_config_with_defaults(
'version': 0,
}
itm_str[k] = sp_local_container_item
Splocaleitemstr.objects.create(**itm_str)
Splocaleitemstr.objects.get_or_create(**itm_str)

def revert_table_field_schema_config(table_name, field_name, apps = apps):
table: Table = datamodel.get_table(table_name)
table_name = table.name

Splocalecontainer = apps.get_model('specify', 'Splocalecontainer')
Splocaleitemstr = apps.get_model('specify', 'Splocaleitemstr')
Splocalecontaineritem = apps.get_model('specify', 'Splocalecontaineritem')
Expand Down
Loading