メインコンテンツまでスキップ
バージョン: User Guides (BYOC)

デフォルト値

Zilliz Cloud では、スカラーフィールド（主キーフィールドを除く）にデフォルト値を設定できます。フィールドにデフォルト値が構成されている場合、挿入時にデータが提供されていないと、Zilliz Cloud が自動的にこの値を適用します。

デフォルト値は、既存のデフォルト値設定を維持することで、他のデータベースシステムから Zilliz Cloud へのデータ移行を簡素化します。また、挿入時点で値が不確実なフィールドにもデフォルト値を使用できます。

制限​

  • スカラーフィールドのみがデフォルト値をサポートします。主キーフィールドおよびベクトルフィールドにはデフォルト値を設定できません。

  • JSON フィールドおよび ARRAY フィールドはデフォルト値をサポートしません。

  • デフォルト値はコレクション作成時のみ構成でき、後から変更することはできません。

デフォルト値の設定​

コレクションを作成する際、add_field() の default_value パラメータを使用して、フィールドのデフォルト値を定義します。

以下の例では、デフォルト値を持つ 2 つのスカラーフィールドを含むコレクションを作成します。age のデフォルト値は 18、status のデフォルト値は "active" です。

from pymilvus import MilvusClient, DataType

client = MilvusClient(uri='YOUR_CLUSTER_ENDPOINT')

# Define collection schema
schema = client.create_schema(
    auto_id=False,
    enable_dynamic_schema=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)

Insert entities​

データを挿入する際、デフォルト値が設定されているフィールドを省略するか、明示的に NULL に設定した場合、Zilliz Cloud は自動的に構成されたデフォルト値を使用します。

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)

デフォルト値を使用した検索とクエリ​

デフォルト値を含むエンティティは、ベクトル検索およびスカラーによるフィルタリング中に他のエンティティと同様に動作します。search 操作および query 操作の両方で、デフォルト値によるフィルタリングが可能です。

次の例では、age がデフォルト値 18 に等しいエンティティを検索します：

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']}")
予想される出力
Output:
Search results (age == 18):
  id: 2, age: 18, status: active
  id: 4, age: 18, status: inactive

デフォルト値を直接照合してエンティティをクエリすることもできます：

# 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']}")
予想される出力
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

適用ルール​

フィールドに対して nullable と default_value の両方が構成されている場合、以下のルールにより、挿入時に Zilliz Cloud が NULL 入力または欠落したフィールド値をどのように処理するかが決定されます。

NULL 許容

デフォルト値

ユーザー入力

結果

✅

✅ (NULL 以外)

NULL または省略

デフォルト値が使用されます

✅

❌

NULL または省略

NULL として保存されます

❌

✅ (NULL 以外)

NULL または省略

デフォルト値が使用されます

❌

❌

NULL または省略

エラーが発生します

❌

✅ (NULL)

NULL または省略

エラーが発生します

主なポイント:

  • フィールドに NULL 以外のデフォルト値がある場合、nullable が有効かどうかに関わらず、その値が使用されます。

  • nullable=True だがデフォルト値が設定されていない場合、フィールドには NULL が保存されます。

  • nullable=False かつデフォルト値が設定されていない場合、挿入はエラーで失敗します。

  • NULL 許容でないフィールドに NULL デフォルト値を設定することは無効であり、エラーの原因となります。