Skip to main content

Default Values

Zilliz Cloud allows you to set default values for scalar fields (excluding the primary field). When a field has a default value configured, Zilliz Cloud automatically applies this value if no data is provided during insertion.

Default values simplify data migration from other database systems to Zilliz Cloud by preserving existing default value settings. You can also use default values for fields where values might be uncertain at the time of insertion.

Limits​

  • Only scalar fields support default values. The primary field and vector fields cannot have default values.

  • JSON and ARRAY fields do not support default values.

  • Default values can only be configured during collection creation and cannot be modified afterward.

Set default values​

When creating a collection, use the default_value parameter in add_field() to define the default value for a field.

The following example creates a collection with two scalar fields that have default values: age defaults to 18 and status defaults to "active".

python
from pymilvus import MilvusClient, DataType

client = MilvusClient(uri='YOUR_CLUSTER_ENDPOINT')

# Drop the collection if it already exists
if client.has_collection("my_collection"):
    client.drop_collection("my_collection")

# Define collection schema
schema = client.create_schema(
    auto_id=False,
    enable_dynamic_field=True,
)

schema.add_field(field_name="id", datatype=DataType.INT64, is_primary=True)
schema.add_field(field_name="vector", datatype=DataType.FLOAT_VECTOR, dim=5)
schema.add_field(field_name="age", datatype=DataType.INT64, default_value=18)
schema.add_field(field_name="status", datatype=DataType.VARCHAR, default_value="active", max_length=10)

# Set index params
index_params = client.prepare_index_params()
index_params.add_index(field_name="vector", index_type="AUTOINDEX", metric_type="L2")

# Create collection
client.create_collection(collection_name="my_collection", schema=schema, index_params=index_params)

# Load the collection
client.load_collection("my_collection")

Insert entities​

When inserting data, if you omit a field that has a default value or explicitly set it to NULL, Zilliz Cloud automatically uses the configured default value.

python
data = [
    # All fields provided explicitly
    {"id": 1, "vector": [0.1, 0.2, 0.3, 0.4, 0.5], "age": 30, "status": "premium"},
    # age and status omitted → both use default values (18 and "active")
    {"id": 2, "vector": [0.2, 0.3, 0.4, 0.5, 0.6]},
    # status set to None → uses default value "active"
    {"id": 3, "vector": [0.3, 0.4, 0.5, 0.6, 0.7], "age": 25, "status": None},
    # age set to None → uses default value 18
    {"id": 4, "vector": [0.4, 0.5, 0.6, 0.7, 0.8], "age": None, "status": "inactive"}
]

client.insert(collection_name="my_collection", data=data)

# Flush so the inserted rows are immediately queryable
client.flush(collection_name="my_collection")

Search and query with default values​

Entities containing default values behave the same as any other entities during vector searches and scalar filtering. You can filter by default values in both search and query operations.

The following example searches for entities where age equals the default value 18:

python
res = client.search(
    collection_name="my_collection",
    data=[[0.1, 0.2, 0.4, 0.3, 0.5]],
    search_params={"params": {"nprobe": 16}},
    filter="age == 18",
    limit=10,
    output_fields=["id", "age", "status"]
)

print("Search results (age == 18):")
for hit in res[0]:
    print(f"  id: {hit['id']}, age: {hit['entity']['age']}, status: {hit['entity']['status']}")
Expected output
plaintext
Output:
Search results (age == 18):
  id: 2, age: 18, status: active
  id: 4, age: 18, status: inactive

You can also query entities by matching default values directly:

python
# Query entities where age equals the default value (18)
default_age_results = client.query(
    collection_name="my_collection",
    filter="age == 18",
    output_fields=["id", "age", "status"]
)

print("\nQuery results (age == 18):")
for r in default_age_results:
    print(f"  id: {r['id']}, age: {r['age']}, status: {r['status']}")

# Query entities where status equals the default value ("active")
default_status_results = client.query(
    collection_name="my_collection",
    filter='status == "active"',
    output_fields=["id", "age", "status"]
)

print("\nQuery results (status == 'active'):")
for r in default_status_results:
    print(f"  id: {r['id']}, age: {r['age']}, status: {r['status']}")
Expected output
plaintext
Query results (age == 18):
  id: 2, age: 18, status: active
  id: 4, age: 18, status: inactive

Query results (status == 'active'):
  id: 2, age: 18, status: active
  id: 3, age: 25, status: active

Applicable rules​

When both nullable and default_value are configured for a field, the following rules determine how Zilliz Cloud handles NULL input or missing field values during insertion.

NullableDefault ValueUser InputResult
(non-NULL)NULL or omittedUses the default value
NULL or omittedStored as NULL
(non-NULL)NULL or omittedUses the default value
NULL or omittedThrows an error
(NULL)NULL or omittedThrows an error

Key takeaways:

  • When a field has a non-NULL default value, that value is used regardless of whether nullable is enabled.

  • When nullable=True but no default value is set, the field stores NULL.

  • When nullable=False and no default value is set, insertion fails with an error.

  • Setting a NULL default value on a non-nullable field is invalid and causes an error.

Contact Sales
Was this page helpful?
Ctrl I