Support building vector index with django_tidb>=5.0.1 (#64)

Author: JaySon-Huang

.gitignore

@@ -143,3 +143,5 @@ django_tests_dir
 *.swp
 
 .vscode/
+
+.DS_Store

examples/orm-django-quickstart/requirements.txt

@@ -1,5 +1,5 @@
 Django==4.2.4
-django-tidb>=4.2.4
+django-tidb>=5.0.1
 mysqlclient==2.2.0
 python-dotenv==1.0.0
-tidb-vector>=0.0.9
+tidb-vector>=0.0.9

examples/orm-django-quickstart/sample_project/migrations/0001_initial.py

@@ -1,10 +1,11 @@
-# Generated by Django 4.2.4 on 2024-06-25 01:51
+# Generated by Django 4.2.4 on 2024-11-05 05:36
 
 from django.db import migrations, models
 import django_tidb.fields.vector
 
 
 class Migration(migrations.Migration):
+
     initial = True
 
     dependencies = []
@@ -25,26 +26,16 @@ class Migration(migrations.Migration):
                 ("content", models.TextField()),
                 ("embedding", django_tidb.fields.vector.VectorField(dimensions=3)),
             ],
-        ),
-        migrations.CreateModel(
-            name="DocumentWithIndex",
-            fields=[
-                (
-                    "id",
-                    models.BigAutoField(
-                        auto_created=True,
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
+            options={
+                "indexes": [
+                    django_tidb.fields.vector.VectorIndex(
+                        django_tidb.fields.vector.L2Distance("embedding"), name="idx_l2"
                     ),
-                ),
-                ("content", models.TextField()),
-                (
-                    "embedding",
-                    django_tidb.fields.vector.VectorField(
-                        db_comment="hnsw(distance=cosine)", dimensions=3
+                    django_tidb.fields.vector.VectorIndex(
+                        django_tidb.fields.vector.CosineDistance("embedding"),
+                        name="idx_cos",
                     ),
-                ),
-            ],
+                ],
+            },
         ),
     ]

examples/orm-django-quickstart/sample_project/models.py

@@ -1,16 +1,12 @@
 from django.db import models
-from django_tidb.fields.vector import VectorField
+from django_tidb.fields.vector import VectorField, VectorIndex, CosineDistance, L2Distance
 
 
 class Document(models.Model):
     content = models.TextField()
     embedding = VectorField(dimensions=3)
-
-
-class DocumentWithIndex(models.Model):
-    content = models.TextField()
-    # Note:
-    #   - Using comment to add hnsw index is a temporary solution. In the future it will use `CREATE INDEX` syntax.
-    #   - Currently the HNSW index cannot be changed after the table has been created.
-    #   - Only Django >= 4.2 supports `db_comment`.
-    embedding = VectorField(dimensions=3, db_comment="hnsw(distance=cosine)")
+    class Meta:
+        indexes = [
+            VectorIndex(L2Distance("embedding"), name='idx_l2'),
+            VectorIndex(CosineDistance("embedding"), name='idx_cos'),
+        ]

examples/orm-django-quickstart/sample_project/views.py

@@ -50,4 +50,4 @@ def list_routes(request):
             '/get_nearest_neighbors_documents',
             '/get_documents_within_distance'
         ]
-    })
+    })