Opened 6 weeks ago

Closed 6 weeks ago

#36517 closed New feature (wontfix)

Add Native Vector Support for Oracle: VectorField, VectorIndex, and VectorDistance

Reported by: SAVAN SONI Owned by:
Component: Database layer (models, ORM) Version: dev
Severity: Normal Keywords:
Cc: SAVAN SONI Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by SAVAN SONI)

This feature adds native support for the Oracle Database’s Vector data type introduced in Oracle 23c. It enables AI and ML applications to store and query high-dimensional data directly in the database using a new VectorField model field, VectorIndex support for similarity search, and ORM expressions for vector operations.

Features Included:

VectorField model field:

  1. Accepts optional dimensions, storage_format, and storage_type arguments.
  1. Supports Dense and Sparse vector storage.
  1. Auto-converts lists, NumPy arrays, and oracledb.SparseVector for insert/update.

Vector Index support:

  1. VectorIndex class using Meta.indexes.
  1. Support for HNSW and IVF index types.
  1. Optional parameters: distance, accuracy, parallel, etc.

Vector distance expressions and lookups:

  1. Custom Func class VectorDistance for VECTOR_DISTANCE(lhs, rhs, metric)
  1. CosineDistance, EuclideanDistance, and NegativeDotProduct etc. as lookups.
  1. Query syntax via filter() and order_by() for similarity search.

Testing:

  1. Dense and Sparse vector insert/query tests added.
  1. Stress test scripts for repeated inserts/queries included.

Example:

from django.db import models
VectorIndex = model.VectorIndex
VectorDistanceType = models.VectorDistanceType
VectorIndexType = models.VectorIndexType

class Product(models.Model):
    name = models.CharField(max_length=100)
    embedding = models.VectorField(dim=3, storage_format=VectorStorageFormat.FLOAT32, storage_type=VectorStorageType.DENSE)

    class Meta:
        indexes = [
            VectorIndex(
                fields=["embedding"],
                name="vec_idx_product",
                index_type=VectorIndexType.HNSW,
                distance=VectorDistanceType.COSINE,
            )
        ]

And a Similarity search can be performed

query_vector = array.array("f", [1.0, 2.0, 3.0])

    products = Product.objects.annotate(
        score=VectorDistance(
            "embedding",
            query_vector,
            metric=VectorDistanceType.COSINE,
        )
    ).order_by("score")[:5]

Implementation Status

We have already implemented:

  1. Custom VectorField with support for DENSE and SPARSE formats
  1. Automatic SQL generation for model/table creation
  1. VectorIndex support with customizable parameters and distance metrics
  1. ORM expressions and lookups for vector distance queries (e.g., CosineDistance, EuclideanDistance)
  1. Basic tests for dense vector creation, insertion, indexing, and querying
  1. Integration with Oracle’s Python driver (oracledb) for runtime behavior

PR Readiness

We have finalized the major components of this feature and are ready to open a public pull request after community feedback or approval of this feature proposal.

Change History (2)

comment:1 by SAVAN SONI, 6 weeks ago

Description: modified (diff)

comment:2 by Sarah Boyce, 6 weeks ago

Resolution: wontfix
Status: newclosed

Thank you for your suggestion! When suggesting a new feature for Django, the feature idea should first be proposed and discussed with the community. To do that, please raise this on the new feature tracker.

I'll close the ticket for now, but if the community agrees with the proposal, please return to this ticket and reference the feature tracker discussion so we can re-open it. For more information, please refer to the documented guidelines for requesting features.

Thanks!

Note: See TracTickets for help on using tickets.
Back to Top