| 1 |
from django.db import DatabaseError |
| 2 |
from django.db.backends.sqlite3.schema import DatabaseSchemaEditor |
| 3 |
|
| 4 |
|
| 5 |
class SpatialiteSchemaEditor(DatabaseSchemaEditor): |
| 6 |
sql_add_geometry_column = ( |
| 7 |
"SELECT AddGeometryColumn(%(table)s, %(column)s, %(srid)s, " |
| 8 |
"%(geom_type)s, %(dim)s, %(null)s)" |
| 9 |
) |
| 10 |
sql_add_spatial_index = "SELECT CreateSpatialIndex(%(table)s, %(column)s)" |
| 11 |
sql_drop_spatial_index = "DROP TABLE idx_%(table)s_%(column)s" |
| 12 |
sql_recover_geometry_metadata = ( |
| 13 |
"SELECT RecoverGeometryColumn(%(table)s, %(column)s, %(srid)s, " |
| 14 |
"%(geom_type)s, %(dim)s)" |
| 15 |
) |
| 16 |
sql_remove_geometry_metadata = "SELECT DiscardGeometryColumn(%(table)s, %(column)s)" |
| 17 |
sql_discard_geometry_columns = ( |
| 18 |
"DELETE FROM %(geom_table)s WHERE f_table_name = %(table)s" |
| 19 |
) |
| 20 |
sql_update_geometry_columns = ( |
| 21 |
"UPDATE %(geom_table)s SET f_table_name = %(new_table)s " |
| 22 |
"WHERE f_table_name = %(old_table)s" |
| 23 |
) |
| 24 |
|
| 25 |
geometry_tables = [ |
| 26 |
"geometry_columns", |
| 27 |
"geometry_columns_auth", |
| 28 |
"geometry_columns_time", |
| 29 |
"geometry_columns_statistics", |
| 30 |
] |
| 31 |
|
| 32 |
def __init__(self, *args, **kwargs): |
| 33 |
super().__init__(*args, **kwargs) |
| 34 |
self.geometry_sql = [] |
| 35 |
|
| 36 |
def geo_quote_name(self, name): |
| 37 |
return self.connection.ops.geo_quote_name(name) |
| 38 |
|
| 39 |
def column_sql(self, model, field, include_default=False): |
| 40 |
from django.contrib.gis.db.models import GeometryField |
| 41 |
|
| 42 |
if not isinstance(field, GeometryField): |
| 43 |
return super().column_sql(model, field, include_default) |
| 44 |
|
| 45 |
# Geometry columns are created by the `AddGeometryColumn` function |
| 46 |
self.geometry_sql.append( |
| 47 |
self.sql_add_geometry_column |
| 48 |
% { |
| 49 |
"table": self.geo_quote_name(model._meta.db_table), |
| 50 |
"column": self.geo_quote_name(field.column), |
| 51 |
"srid": field.srid, |
| 52 |
"geom_type": self.geo_quote_name(field.geom_type), |
| 53 |
"dim": field.dim, |
| 54 |
"null": int(not field.null), |
| 55 |
} |
| 56 |
) |
| 57 |
|
| 58 |
if field.spatial_index: |
| 59 |
self.geometry_sql.append( |
| 60 |
self.sql_add_spatial_index |
| 61 |
% { |
| 62 |
"table": self.quote_name(model._meta.db_table), |
| 63 |
"column": self.quote_name(field.column), |
| 64 |
} |
| 65 |
) |
| 66 |
return None, None |
| 67 |
|
| 68 |
def remove_geometry_metadata(self, model, field): |
| 69 |
self.execute( |
| 70 |
self.sql_remove_geometry_metadata |
| 71 |
% { |
| 72 |
"table": self.quote_name(model._meta.db_table), |
| 73 |
"column": self.quote_name(field.column), |
| 74 |
} |
| 75 |
) |
| 76 |
self.execute( |
| 77 |
self.sql_drop_spatial_index |
| 78 |
% { |
| 79 |
"table": model._meta.db_table, |
| 80 |
"column": field.column, |
| 81 |
} |
| 82 |
) |
| 83 |
|
| 84 |
def create_model(self, model): |
| 85 |
super().create_model(model) |
| 86 |
# Create geometry columns |
| 87 |
for sql in self.geometry_sql: |
| 88 |
self.execute(sql) |
| 89 |
self.geometry_sql = [] |
| 90 |
|
| 91 |
def delete_model(self, model, **kwargs): |
| 92 |
from django.contrib.gis.db.models import GeometryField |
| 93 |
|
| 94 |
# Drop spatial metadata (dropping the table does not automatically remove them) |
| 95 |
for field in model._meta.local_fields: |
| 96 |
if isinstance(field, GeometryField): |
| 97 |
self.remove_geometry_metadata(model, field) |
| 98 |
# Make sure all geom stuff is gone |
| 99 |
for geom_table in self.geometry_tables: |
| 100 |
try: |
| 101 |
self.execute( |
| 102 |
self.sql_discard_geometry_columns |
| 103 |
% { |
| 104 |
"geom_table": geom_table, |
| 105 |
"table": self.quote_name(model._meta.db_table), |
| 106 |
} |
| 107 |
) |
| 108 |
except DatabaseError: |
| 109 |
pass |
| 110 |
super().delete_model(model, **kwargs) |
| 111 |
|
| 112 |
def add_field(self, model, field): |
| 113 |
from django.contrib.gis.db.models import GeometryField |
| 114 |
|
| 115 |
if isinstance(field, GeometryField): |
| 116 |
# Populate self.geometry_sql |
| 117 |
self.column_sql(model, field) |
| 118 |
for sql in self.geometry_sql: |
| 119 |
self.execute(sql) |
| 120 |
self.geometry_sql = [] |
| 121 |
else: |
| 122 |
super().add_field(model, field) |
| 123 |
|
| 124 |
def remove_field(self, model, field): |
| 125 |
from django.contrib.gis.db.models import GeometryField |
| 126 |
|
| 127 |
# NOTE: If the field is a geometry field, the table is just recreated, |
| 128 |
# the parent's remove_field can't be used cause it will skip the |
| 129 |
# recreation if the field does not have a database type. Geometry fields |
| 130 |
# do not have a db type cause they are added and removed via stored |
| 131 |
# procedures. |
| 132 |
if isinstance(field, GeometryField): |
| 133 |
self._remake_table(model, delete_field=field) |
| 134 |
else: |
| 135 |
super().remove_field(model, field) |
| 136 |
|
| 137 |
def alter_db_table(self, model, old_db_table, new_db_table): |
| 138 |
from django.contrib.gis.db.models import GeometryField |
| 139 |
|
| 140 |
if old_db_table == new_db_table or ( |
| 141 |
self.connection.features.ignores_table_name_case |
| 142 |
and old_db_table.lower() == new_db_table.lower() |
| 143 |
): |
| 144 |
return |
| 145 |
# Remove geometry-ness from temp table |
| 146 |
for field in model._meta.local_fields: |
| 147 |
if isinstance(field, GeometryField): |
| 148 |
self.execute( |
| 149 |
self.sql_remove_geometry_metadata |
| 150 |
% { |
| 151 |
"table": self.quote_name(old_db_table), |
| 152 |
"column": self.quote_name(field.column), |
| 153 |
} |
| 154 |
) |
| 155 |
# Alter table |
| 156 |
super().alter_db_table(model, old_db_table, new_db_table) |
| 157 |
# Repoint any straggler names |
| 158 |
for geom_table in self.geometry_tables: |
| 159 |
try: |
| 160 |
self.execute( |
| 161 |
self.sql_update_geometry_columns |
| 162 |
% { |
| 163 |
"geom_table": geom_table, |
| 164 |
"old_table": self.quote_name(old_db_table), |
| 165 |
"new_table": self.quote_name(new_db_table), |
| 166 |
} |
| 167 |
) |
| 168 |
except DatabaseError: |
| 169 |
pass |
| 170 |
# Re-add geometry-ness and rename spatial index tables |
| 171 |
for field in model._meta.local_fields: |
| 172 |
if isinstance(field, GeometryField): |
| 173 |
self.execute( |
| 174 |
self.sql_recover_geometry_metadata |
| 175 |
% { |
| 176 |
"table": self.geo_quote_name(new_db_table), |
| 177 |
"column": self.geo_quote_name(field.column), |
| 178 |
"srid": field.srid, |
| 179 |
"geom_type": self.geo_quote_name(field.geom_type), |
| 180 |
"dim": field.dim, |
| 181 |
} |
| 182 |
) |
| 183 |
if getattr(field, "spatial_index", False): |
| 184 |
self.execute( |
| 185 |
self.sql_rename_table |
| 186 |
% { |
| 187 |
"old_table": self.quote_name( |
| 188 |
"idx_%s_%s" % (old_db_table, field.column) |
| 189 |
), |
| 190 |
"new_table": self.quote_name( |
| 191 |
"idx_%s_%s" % (new_db_table, field.column) |
| 192 |
), |
| 193 |
} |
| 194 |
) |