Skip to content

Commit eef69c3

Browse files
committed
implement SchemaEditor.add/remove_index()
And also creating indexes in create_model() and add_field().
1 parent 41598ec commit eef69c3

File tree

3 files changed

+76
-32
lines changed

3 files changed

+76
-32
lines changed

django_mongodb/features.py

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -79,29 +79,13 @@ class DatabaseFeatures(BaseDatabaseFeatures):
7979
"backends.tests.ThreadTests.test_closing_non_shared_connections",
8080
"backends.tests.ThreadTests.test_default_connection_thread_local",
8181
# AddField
82-
"schema.tests.SchemaTests.test_add_indexed_charfield",
8382
"schema.tests.SchemaTests.test_add_unique_charfield",
84-
# Add/RemoveIndex
85-
"migrations.test_operations.OperationTests.test_add_index",
86-
"migrations.test_operations.OperationTests.test_alter_field_with_index",
87-
"migrations.test_operations.OperationTests.test_remove_index",
88-
"migrations.test_operations.OperationTests.test_rename_index",
89-
"migrations.test_operations.OperationTests.test_rename_index_unknown_unnamed_index",
90-
"migrations.test_operations.OperationTests.test_rename_index_unnamed_index",
91-
"schema.tests.SchemaTests.test_add_remove_index",
92-
"schema.tests.SchemaTests.test_composed_desc_index_with_fk",
93-
"schema.tests.SchemaTests.test_composed_index_with_fk",
94-
"schema.tests.SchemaTests.test_create_index_together",
95-
"schema.tests.SchemaTests.test_order_index",
96-
"schema.tests.SchemaTests.test_text_field_with_db_index",
9783
# AlterField
9884
"schema.tests.SchemaTests.test_alter_field_add_index_to_integerfield",
99-
"schema.tests.SchemaTests.test_alter_field_fk_keeps_index",
10085
"schema.tests.SchemaTests.test_alter_field_fk_to_o2o",
10186
"schema.tests.SchemaTests.test_alter_field_o2o_keeps_unique",
10287
"schema.tests.SchemaTests.test_alter_field_o2o_to_fk",
10388
"schema.tests.SchemaTests.test_alter_int_pk_to_int_unique",
104-
"schema.tests.SchemaTests.test_alter_not_unique_field_to_primary_key",
10589
# AlterField (db_index)
10690
"schema.tests.SchemaTests.test_alter_renames_index",
10791
"schema.tests.SchemaTests.test_indexes",
@@ -123,9 +107,6 @@ class DatabaseFeatures(BaseDatabaseFeatures):
123107
"schema.tests.SchemaTests.test_composed_constraint_with_fk",
124108
"schema.tests.SchemaTests.test_remove_ignored_unique_constraint_not_create_fk_index",
125109
"schema.tests.SchemaTests.test_unique_constraint",
126-
# subclasses of BaseDatabaseIntrospection may require a get_constraints() method
127-
"migrations.test_operations.OperationTests.test_add_func_unique_constraint",
128-
"migrations.test_operations.OperationTests.test_remove_func_unique_constraint",
129110
}
130111
# $bitAnd, #bitOr, and $bitXor are new in MongoDB 6.3.
131112
_django_test_expected_failures_bitwise = {
@@ -229,6 +210,7 @@ def django_test_expected_failures(self):
229210
"get_or_create.tests.GetOrCreateThroughManyToMany.test_something",
230211
"get_or_create.tests.UpdateOrCreateTests.test_manual_primary_key_test",
231212
"get_or_create.tests.UpdateOrCreateTestsWithManualPKs.test_create_with_duplicate_primary_key",
213+
"introspection.tests.IntrospectionTests.test_get_constraints_unique_indexes_orders",
232214
"model_fields.test_filefield.FileFieldTests.test_unique_when_same_filename",
233215
"one_to_one.tests.OneToOneTests.test_multiple_o2o",
234216
"queries.test_bulk_update.BulkUpdateTests.test_database_routing_batch_atomicity",
@@ -618,14 +600,8 @@ def django_test_expected_failures(self):
618600
"introspection.tests.IntrospectionTests.test_get_table_description_types",
619601
"introspection.tests.IntrospectionTests.test_smallautofield",
620602
},
621-
"DatabaseIntrospection.get_constraints() not implemented.": {
622-
"introspection.tests.IntrospectionTests.test_get_constraints",
623-
"introspection.tests.IntrospectionTests.test_get_constraints_index_types",
624-
"introspection.tests.IntrospectionTests.test_get_constraints_indexes_orders",
625-
"introspection.tests.IntrospectionTests.test_get_constraints_unique_indexes_orders",
626-
"introspection.tests.IntrospectionTests.test_get_primary_key_column",
627-
},
628603
"MongoDB can't introspect primary key.": {
604+
"introspection.tests.IntrospectionTests.test_get_primary_key_column",
629605
"schema.tests.SchemaTests.test_alter_primary_key_the_same_name",
630606
"schema.tests.SchemaTests.test_primary_key",
631607
},

django_mongodb/introspection.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
11
from django.db.backends.base.introspection import BaseDatabaseIntrospection
2+
from django.db.models import Index
23

34

45
class DatabaseIntrospection(BaseDatabaseIntrospection):
6+
ORDER_DIR = {1: "ASC", -1: "DESC"}
7+
58
def table_names(self, cursor=None, include_views=False):
69
return sorted([x["name"] for x in self.connection.database.list_collections()])
10+
11+
def get_constraints(self, cursor, table_name):
12+
indexes = self.connection.database[table_name].index_information()
13+
constraints = {}
14+
for name, details in indexes.items():
15+
# Remove underscore prefix from "_id" columns in primary key index.
16+
if is_primary_key := name == "_id_":
17+
name = "id"
18+
details["key"] = [("id", 1)]
19+
constraints[name] = {
20+
"check": False,
21+
"columns": [field for field, order in details["key"]],
22+
"definition": None,
23+
"foreign_key": None,
24+
"index": True,
25+
"orders": [self.ORDER_DIR[order] for field, order in details["key"]],
26+
"primary_key": is_primary_key,
27+
"type": Index.suffix,
28+
"unique": details.get("unique", False),
29+
"options": {},
30+
}
31+
return constraints

django_mongodb/schema.py

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,39 @@
11
from django.db.backends.base.schema import BaseDatabaseSchemaEditor
2+
from django.db.models import Index
3+
from pymongo.operations import IndexModel
24

35

46
class DatabaseSchemaEditor(BaseDatabaseSchemaEditor):
57
def create_model(self, model):
68
self.connection.database.create_collection(model._meta.db_table)
9+
self._create_model_indexes(model)
710
# Make implicit M2M tables.
811
for field in model._meta.local_many_to_many:
912
if field.remote_field.through._meta.auto_created:
1013
self.create_model(field.remote_field.through)
1114

15+
def _create_model_indexes(self, model):
16+
"""
17+
Create all indexes (field indexes, index_together, Meta.indexes) for
18+
the specified model.
19+
"""
20+
if not model._meta.managed or model._meta.proxy or model._meta.swapped:
21+
return
22+
# Field indexes
23+
for field in model._meta.local_fields:
24+
if self._field_should_be_indexed(model, field):
25+
index = Index(fields=[field.name])
26+
index.name = self._create_index_name(model._meta.db_table, [field.column])
27+
self.add_index(model, index)
28+
# Meta.index_together (RemovedInDjango51Warning)
29+
for field_names in model._meta.index_together:
30+
index = Index(fields=field_names)
31+
index.set_name_with_model(model)
32+
self.add_index(model, index)
33+
# Meta.indexes
34+
for index in model._meta.indexes:
35+
self.add_index(model, index)
36+
1237
def delete_model(self, model):
1338
# Delete implicit M2m tables.
1439
for field in model._meta.local_many_to_many:
@@ -26,6 +51,11 @@ def add_field(self, model, field):
2651
self.connection.database[model._meta.db_table].update_many(
2752
{}, [{"$set": {column: self.effective_default(field)}}]
2853
)
54+
# Add an index, if required.
55+
if self._field_should_be_indexed(model, field):
56+
index = Index(fields=[field.name])
57+
index.name = self._create_index_name(model._meta.db_table, [field.column])
58+
self.add_index(model, index, field=field)
2959

3060
def _alter_field(
3161
self,
@@ -64,14 +94,27 @@ def alter_index_together(self, model, old_index_together, new_index_together):
6494
def alter_unique_together(self, model, old_unique_together, new_unique_together):
6595
pass
6696

67-
def add_index(self, model, index):
68-
pass
69-
70-
def rename_index(self, model, old_index, new_index):
71-
pass
97+
def add_index(self, model, index, field=None):
98+
if index.contains_expressions:
99+
return
100+
index_orders = (
101+
[(field.column, 1)]
102+
if field
103+
else [
104+
(model._meta.get_field(field_name).column, 1 if order == "" else -1)
105+
for field_name, order in index.fields_orders
106+
]
107+
)
108+
idx = IndexModel(
109+
index_orders,
110+
name=index.name,
111+
)
112+
self.connection.database[model._meta.db_table].create_indexes([idx])
72113

73114
def remove_index(self, model, index):
74-
pass
115+
if index.contains_expressions:
116+
return
117+
self.connection.database[model._meta.db_table].drop_index(index.name)
75118

76119
def add_constraint(self, model, constraint):
77120
pass

0 commit comments

Comments
 (0)