1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
|
import contextlib
import re
from collections.abc import Sequence
from typing import Any, Union
from django import __version__ as DJANGO_VERSION
from django.apps import apps
from django.db import transaction
from django.db.backends.base.schema import BaseDatabaseSchemaEditor
from django.db.migrations.operations.base import Operation
from django.db.migrations.operations.fields import AddField
from django.db.migrations.operations.models import CreateModel, IndexOperation
from django.db.migrations.state import ModelState, ProjectState
from django.db.models import Model
from pgtrigger import compiler, core, utils
if DJANGO_VERSION >= "5.1":
from django.db.migrations.autodetector import OperationDependency
OPERATION_DEPENDENCY_CREATE = OperationDependency.Type.CREATE
else:
OperationDependency = lambda *args: tuple((args)) # noqa: E731
OPERATION_DEPENDENCY_CREATE = True
def _add_trigger(
schema_editor: BaseDatabaseSchemaEditor,
model: type[Model],
trigger: Union[core.Trigger, compiler.Trigger],
) -> None:
"""Add a trigger to a model."""
if not isinstance(trigger, compiler.Trigger): # pragma: no cover
trigger = trigger.compile(model)
with transaction.atomic(using=schema_editor.connection.alias):
# Trigger install SQL returns interpolated SQL which makes
# params=None a necessity to avoid escaping attempts on execution.
schema_editor.execute(trigger.install_sql, params=None)
def _remove_trigger(
schema_editor: BaseDatabaseSchemaEditor,
model: type[Model],
trigger: Union[core.Trigger, compiler.Trigger],
) -> None:
"""Remove a trigger from a model."""
if not isinstance(trigger, compiler.Trigger): # pragma: no cover
trigger = trigger.compile(model)
# Trigger uninstall SQL returns interpolated SQL which makes
# params=None a necessity to avoid escaping attempts on execution.
schema_editor.execute(trigger.uninstall_sql, params=None)
class TriggerOperationMixin:
def allow_migrate_model_trigger(
self, schema_editor: BaseDatabaseSchemaEditor, model: type[Model]
) -> bool:
"""
The check for determinig if a trigger is migrated
"""
assert isinstance(self, Operation)
assert model._meta.concrete_model is not None
return schema_editor.connection.vendor == "postgresql" and self.allow_migrate_model(
schema_editor.connection.alias, model._meta.concrete_model
)
class AddTrigger(TriggerOperationMixin, IndexOperation):
option_name = "triggers"
def __init__(self, model_name: str, trigger: Union[core.Trigger, compiler.Trigger]) -> None:
self.model_name = model_name
self.trigger = trigger
def state_forwards(self, app_label: str, state: ProjectState) -> None:
model_state = state.models[app_label, self.model_name]
model_state.options["triggers"] = model_state.options.get("triggers", []) + [self.trigger]
state.reload_model(app_label, self.model_name, delay=True)
def database_forwards(
self,
app_label: str,
schema_editor: BaseDatabaseSchemaEditor,
from_state: ProjectState,
to_state: ProjectState,
) -> None:
model = to_state.apps.get_model(app_label, self.model_name)
assert issubclass(model, Model)
if self.allow_migrate_model_trigger(schema_editor, model): # pragma: no branch
_add_trigger(schema_editor, model, self.trigger)
def database_backwards(
self,
app_label: str,
schema_editor: BaseDatabaseSchemaEditor,
from_state: ProjectState,
to_state: ProjectState,
) -> None:
model = to_state.apps.get_model(app_label, self.model_name)
assert issubclass(model, Model)
if self.allow_migrate_model_trigger(schema_editor, model): # pragma: no branch
_remove_trigger(schema_editor, model, self.trigger)
def describe(self) -> str:
return f"Create trigger {self.trigger.name} on model {self.model_name}"
def deconstruct(self) -> tuple[str, Sequence[Any], dict[str, Any]]:
return (
self.__class__.__name__,
[],
{
"model_name": self.model_name,
"trigger": self.trigger,
},
)
@property
def migration_name_fragment(self) -> str:
assert self.trigger.name is not None
return f"{self.model_name_lower}_{self.trigger.name.lower()}"
def _get_trigger_by_name(
model_state: ModelState, name: str
) -> Union[compiler.Trigger, core.Trigger]:
for trigger in model_state.options.get("triggers", []): # pragma: no branch
assert isinstance(trigger, (compiler.Trigger, core.Trigger))
if trigger.name == name:
return trigger
raise ValueError(f"No trigger named {name} on model {model_state.name}") # pragma: no cover
class RemoveTrigger(TriggerOperationMixin, IndexOperation):
option_name = "triggers"
def __init__(self, model_name: str, name: str) -> None:
self.model_name = model_name
self.name = name
def state_forwards(self, app_label: str, state: ProjectState) -> None:
model_state = state.models[app_label, self.model_name]
objs = model_state.options.get("triggers", [])
model_state.options["triggers"] = [obj for obj in objs if obj.name != self.name]
state.reload_model(app_label, self.model_name, delay=True)
def database_forwards(
self,
app_label: str,
schema_editor: BaseDatabaseSchemaEditor,
from_state: ProjectState,
to_state: ProjectState,
) -> None:
model = to_state.apps.get_model(app_label, self.model_name)
assert issubclass(model, Model)
if self.allow_migrate_model_trigger(schema_editor, model): # pragma: no branch
from_model_state = from_state.models[app_label, self.model_name_lower]
trigger = _get_trigger_by_name(from_model_state, self.name)
_remove_trigger(schema_editor, model, trigger)
def database_backwards(
self,
app_label: str,
schema_editor: BaseDatabaseSchemaEditor,
from_state: ProjectState,
to_state: ProjectState,
) -> None:
model = to_state.apps.get_model(app_label, self.model_name)
assert issubclass(model, Model)
if self.allow_migrate_model_trigger(schema_editor, model): # pragma: no branch
to_model_state = to_state.models[app_label, self.model_name_lower]
trigger = _get_trigger_by_name(to_model_state, self.name)
_add_trigger(schema_editor, model, trigger)
def describe(self) -> str:
return f"Remove trigger {self.name} from model {self.model_name}"
def deconstruct(self) -> tuple[str, Sequence[Any], dict[str, Any]]:
return (
self.__class__.__name__,
[],
{
"model_name": self.model_name,
"name": self.name,
},
)
@property
def migration_name_fragment(self) -> str:
return f"remove_{self.model_name_lower}_{self.name.lower()}"
def _inject_m2m_dependency_in_proxy(proxy_op):
"""
Django does not properly add dependencies to m2m fields that are base classes for
proxy models. Inject the dependency here
"""
for base in proxy_op.bases:
# Ignore inherited bases that are not models or abstract
# https://github.com/Opus10/django-pgtrigger/issues/126
if not (isinstance(base, str) and "." in base):
continue
model = apps.get_model(base)
creator = model._meta.auto_created
if creator:
for field in creator._meta.many_to_many:
if field.remote_field.through == model:
app_label, model_name = creator._meta.label_lower.split(".")
proxy_op._auto_deps.append(
OperationDependency(
app_label, model_name, field.name, OPERATION_DEPENDENCY_CREATE
)
)
class MigrationAutodetectorMixin:
"""A mixin that can be subclassed with MigrationAutodetector and detects triggers"""
def _detect_changes(self, *args, **kwargs):
self.altered_triggers = {}
return super()._detect_changes(*args, **kwargs)
def _get_add_trigger_op(self, model, trigger):
if not isinstance(trigger, compiler.Trigger):
trigger = trigger.compile(model)
return AddTrigger(model_name=model._meta.model_name, trigger=trigger)
def create_altered_constraints(self):
"""
Piggyback off of constraint generation hooks to generate
trigger migration operations
"""
for app_label, model_name in sorted(self.kept_model_keys | self.kept_proxy_keys):
old_model_name = self.renamed_models.get((app_label, model_name), model_name)
old_model_state = self.from_state.models[app_label, old_model_name]
new_model_state = self.to_state.models[app_label, model_name]
new_model = self.to_state.apps.get_model(app_label, model_name)
old_triggers = old_model_state.options.get("triggers", [])
new_triggers = [
trigger.compile(new_model)
for trigger in new_model_state.options.get("triggers", [])
]
add_triggers = [c for c in new_triggers if c not in old_triggers]
rem_triggers = [c for c in old_triggers if c not in new_triggers]
self.altered_triggers.update(
{
(app_label, model_name): {
"added_triggers": add_triggers,
"removed_triggers": rem_triggers,
}
}
)
return super().create_altered_constraints()
def generate_added_constraints(self):
for (app_label, model_name), alt_triggers in self.altered_triggers.items():
model = self.to_state.apps.get_model(app_label, model_name)
for trigger in alt_triggers["added_triggers"]:
self.add_operation(
app_label, self._get_add_trigger_op(model=model, trigger=trigger)
)
return super().generate_added_constraints()
def generate_removed_constraints(self):
for (app_label, model_name), alt_triggers in self.altered_triggers.items():
for trigger in alt_triggers["removed_triggers"]:
self.add_operation(
app_label, RemoveTrigger(model_name=model_name, name=trigger.name)
)
return super().generate_removed_constraints()
def generate_created_models(self):
super().generate_created_models()
added_models = self.new_model_keys - self.old_model_keys
added_models = sorted(added_models, key=self.swappable_first_key, reverse=True)
for app_label, model_name in added_models:
model = self.to_state.apps.get_model(app_label, model_name)
model_state = self.to_state.models[app_label, model_name]
if not model_state.options.get("managed", True):
continue # pragma: no cover
related_fields = {
op.name: op.field
for op in self.generated_operations.get(app_label, [])
if isinstance(op, AddField) and model_name == op.model_name
}
related_dependencies = [
OperationDependency(app_label, model_name, name, OPERATION_DEPENDENCY_CREATE)
for name in sorted(related_fields)
]
# Depend on the model being created
related_dependencies.append(
OperationDependency(app_label, model_name, None, OPERATION_DEPENDENCY_CREATE)
)
for trigger in model_state.options.pop("triggers", []):
self.add_operation(
app_label,
self._get_add_trigger_op(model=model, trigger=trigger),
dependencies=related_dependencies,
)
def generate_created_proxies(self):
super().generate_created_proxies()
added = self.new_proxy_keys - self.old_proxy_keys
for app_label, model_name in sorted(added):
# Django has a bug that prevents it from injecting a dependency
# to an M2M through model when a proxy model inherits it.
# Inject an additional dependency for created proxies to
# avoid this
for op in self.generated_operations.get(app_label, []):
if isinstance(op, CreateModel) and op.options.get( # pragma: no branch
"proxy", False
):
_inject_m2m_dependency_in_proxy(op)
model = self.to_state.apps.get_model(app_label, model_name)
model_state = self.to_state.models[app_label, model_name]
assert model_state.options.get("proxy")
for trigger in model_state.options.pop("triggers", []):
self.add_operation(
app_label,
self._get_add_trigger_op(model=model, trigger=trigger),
dependencies=[
OperationDependency(
app_label, model_name, None, OPERATION_DEPENDENCY_CREATE
)
],
)
def generate_deleted_proxies(self):
deleted = self.old_proxy_keys - self.new_proxy_keys
for app_label, model_name in sorted(deleted):
model_state = self.from_state.models[app_label, model_name]
assert model_state.options.get("proxy")
for trigger in model_state.options.pop("triggers", []):
self.add_operation(
app_label,
RemoveTrigger(model_name=model_name, name=trigger.name),
dependencies=[
OperationDependency(
app_label, model_name, None, OPERATION_DEPENDENCY_CREATE
)
],
)
super().generate_deleted_proxies()
class DatabaseSchemaEditorMixin:
"""
A schema editor mixin that can subclass a DatabaseSchemaEditor and
handle altering column types of triggers.
Postgres does not allow altering column types of columns used in trigger
conditions. Here we fix this with the following approach:
1. Detect that a column type is being changed and set a flag so that we
can alter behavior of the schema editor.
2. In execute(), check for the special error message that's raised
when trying to alter a column of a trigger. Temporarily drop triggers
during the alter statement and reinstall them. Ensure this is all
wrapped in a transaction
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.temporarily_dropped_triggers = set()
self.is_altering_field_type = False
@contextlib.contextmanager
def alter_field_type(self):
"""
Temporarily sets state so that execute() knows we are trying to alter a column type
"""
self.is_altering_field_type = True
try:
yield
finally:
self.is_altering_field_type = False
def _alter_field(
self,
model,
old_field,
new_field,
old_type,
new_type,
old_db_params,
new_db_params,
strict=False,
):
"""
Detects that a field type is being altered and sets the appropriate state
"""
context = self.alter_field_type() if old_type != new_type else contextlib.nullcontext()
with context:
return super()._alter_field(
model,
old_field,
new_field,
old_type,
new_type,
old_db_params,
new_db_params,
strict=strict,
)
@contextlib.contextmanager
def temporarily_drop_trigger(self, trigger, table):
"""
Given a table and trigger, temporarily drop the trigger and recreate it
after the context manager yields.
"""
self.temporarily_dropped_triggers.add((trigger, table))
try:
with transaction.atomic(self.connection.alias), self.connection.cursor() as cursor:
cursor.execute(
f"""
SELECT pg_get_triggerdef(oid) FROM pg_trigger
WHERE tgname = '{trigger}' AND tgrelid = '{table}'::regclass;
"""
)
trigger_create_sql = cursor.fetchall()[0][0]
cursor.execute(f"DROP TRIGGER {trigger} on {utils.quote(table)};")
yield
cursor.execute(trigger_create_sql)
finally:
self.temporarily_dropped_triggers.remove((trigger, table))
def execute(self, *args, **kwargs):
"""
If we are altering a field type, catch the special error psycopg raises
when a column on a trigger is altered. Temporarily drop and recreate
triggers to ensure the alter operation is successful.
"""
if self.is_altering_field_type:
try:
with transaction.atomic(self.connection.alias):
return super().execute(*args, **kwargs)
except Exception as exc:
match = re.search(
r"cannot alter type of a column used in a trigger definition\n"
r'DETAIL:\s+trigger (?P<trigger>\w+).+on table "?(?P<table>\w+)"?',
str(exc),
)
if match:
trigger = match.groupdict()["trigger"]
table = match.groupdict()["table"]
# In practice we should never receive the same error message for
# the same trigger/table, but check anyways to avoid infinite
# recursion
if (
trigger.startswith("pgtrigger_")
and (table, trigger) not in self.temporarily_dropped_triggers
):
with self.temporarily_drop_trigger(trigger, table):
return self.execute(*args, **kwargs)
raise # pragma: no cover
else:
return super().execute(*args, **kwargs)
def create_model(self, model):
"""
Create the model
`Meta.triggers` isn't populated on the forwards `CreateTable` migration
(as Triggers are only added to the migration state via `AddTrigger`
operations). `Meta.triggers` may be populated when:
- The backwards operation of a `RemoveTable` operation where there was
still triggers defined in the model state when the table was
removed.
- Creating the tables of an unmigrated app when `run_syncdb` is
supplied to the migrate command (or when running tests).
"""
super().create_model(model)
for trigger in getattr(model._meta, "triggers", []):
_add_trigger(self, model, trigger)
|