Declarative DSL for defining Milvus collection schemas.

This module provides a Spark-based DSL for declaring collection schemas in a declarative, compile-time validated way.

Basic Example

defmodule MyApp.Movies do
  use Milvex.Collection

  collection do
    name "movies"
    description "Movie embeddings collection"

    fields do
      primary_key :id, :int64, auto_id: true
      varchar :title, 512
      scalar :year, :int32
      vector :embedding, 128
    end
  end
end

Field Types

Primary Key

Every collection must have exactly one primary key field:

primary_key :id, :int64                    # Integer primary key
primary_key :id, :int64, auto_id: true     # Auto-generated IDs
primary_key :pk, :varchar, max_length: 64  # String primary key

Vector Fields

Vector fields store embeddings:

vector :embedding, 128                              # Float vector (default)
vector :embedding, 768, type: :float16_vector       # Half-precision
vector :binary_emb, 256, type: :binary_vector       # Binary vector
sparse_vector :sparse_embedding                      # Sparse vector (no dimension)

Varchar Fields

Variable-length string fields:

varchar :title, 256                         # Basic varchar
varchar :description, 1024, nullable: true  # Nullable
varchar :category, 64, default: "general"   # With default

Scalar Fields

Numeric, boolean, and JSON fields:

scalar :count, :int32
scalar :score, :float, nullable: true
scalar :is_active, :bool
scalar :metadata, :json

Array Fields

Arrays of scalar types:

array :tags, :varchar, max_capacity: 100, max_length: 64
array :scores, :float, max_capacity: 10

Converting to Schema

The DSL modules can be converted to the existing Milvex.Schema format for use with the Milvex client:

schema = Milvex.Collection.to_schema(MyApp.Movies)

Introspection

You can inspect a collection's configuration at runtime:

Milvex.Collection.collection_name(MyApp.Movies)
Milvex.Collection.fields(MyApp.Movies)
Milvex.Collection.primary_key(MyApp.Movies)

Options

• :extensions (list of module that adopts Spark.Dsl.Extension) - A list of DSL extensions to add to the Spark.Dsl

• :otp_app (atom/0) - The otp_app to use for any application configurable options

• :fragments (list of module/0) - Fragments to include in the Spark.Dsl. See the fragments guide for more.