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
|
import logging
from typing import TYPE_CHECKING
from django.conf import settings
from django.contrib.postgres.signals import (
get_hstore_oids,
register_type_handlers,
)
from django.db import ProgrammingError
from . import base_impl
from .introspection import PostgresIntrospection
from .operations import PostgresOperations
from .schema import PostgresSchemaEditor
from django.db.backends.postgresql.base import ( # isort:skip
DatabaseWrapper as PostgresDatabaseWrapper,
)
logger = logging.getLogger(__name__)
if TYPE_CHECKING:
class Wrapper(PostgresDatabaseWrapper):
pass
else:
Wrapper = base_impl.backend()
class DatabaseWrapper(Wrapper):
"""Wraps the standard PostgreSQL database back-end.
Overrides the schema editor with our custom schema editor and makes
sure the `hstore` extension is enabled.
"""
SchemaEditorClass = PostgresSchemaEditor # type: ignore[assignment]
introspection_class = PostgresIntrospection
ops_class = PostgresOperations
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# Some base back-ends such as the PostGIS back-end don't properly
# set `ops_class` and `introspection_class` and initialize these
# classes themselves.
#
# This can lead to broken functionality. We fix this automatically.
if not isinstance(self.introspection, self.introspection_class):
self.introspection = self.introspection_class(self)
if not isinstance(self.ops, self.ops_class):
self.ops = self.ops_class(self)
for expected_compiler_class in self.ops.compiler_classes:
compiler_class = self.ops.compiler(expected_compiler_class.__name__)
if not issubclass(compiler_class, expected_compiler_class):
logger.warning(
"Compiler '%s.%s' is not properly deriving from '%s.%s'."
% (
compiler_class.__module__,
compiler_class.__name__,
expected_compiler_class.__module__,
expected_compiler_class.__name__,
)
)
def prepare_database(self):
"""Ran to prepare the configured database.
This is where we enable the `hstore` extension if it wasn't
enabled yet.
"""
super().prepare_database()
setup_ext = getattr(
settings, "POSTGRES_EXTRA_AUTO_EXTENSION_SET_UP", True
)
if not setup_ext:
return False
with self.cursor() as cursor:
try:
cursor.execute("CREATE EXTENSION IF NOT EXISTS hstore")
except ProgrammingError: # permission denied
logger.warning(
'Failed to create "hstore" extension. '
"Tables with hstore columns may fail to migrate. "
"If hstore is needed, make sure you are connected "
"to the database as a superuser "
"or add the extension manually.",
exc_info=True,
)
return
# Clear old (non-existent), stale oids.
get_hstore_oids.cache_clear()
# Verify that we (and Django) can find the OIDs
# for hstore.
oids, _ = get_hstore_oids(self.alias)
if not oids:
logger.warning(
'"hstore" extension was created, but we cannot find the oids'
"in the database. Something went wrong.",
)
return
# We must trigger Django into registering the type handlers now
# so that any subsequent code can properly use the newly
# registered types.
register_type_handlers(self)
|
