メインコンテンツまでスキップ

alter_collection_field()

この操作は、指定されたコレクションのフィールドパラメータを変更します。

リクエスト構文​

python
alter_collection_field(
    collection_name: str, 
    field_name: str, 
    field_params: Dict,
    db_name="",
    timeout: Optional[float] = None,
    **kwargs,
)

パラメータ:

  • collection_name (str) -

    対象のコレクションの名前です。

  • field_name (str) -

    対象のフィールドの名前です。

  • field_params (dict) -

    変更するフィールドパラメータです。記載されていないプロパティは変更されません。指定できるパラメータはフィールドタイプによって異なります。

    • mmap_enabled (bool) -

      Milvus がフィールドデータを完全にロードする代わりにメモリにマップするかどうかです。詳細については、MMap-enabled Data Storage を参照してください。

  • timeout (Optional[float]) -

    この操作のタイムアウト時間です。

    これを None に設定すると、何らかのレスポンスが到着するか、何らかのエラーが発生した時点でこの操作はタイムアウトします。

Notes

コレクションをロードする前に、フィールドの設定を変更する必要があります。ロード済みのコレクションでフィールドを変更するとエラーが返されます。ロード済みのコレクションの設定を変更するには、まずコレクションを release してからフィールドを変更し、再度ロードしてください。

戻り値の型:

NoneType

戻り値:

None

例外:

  • MilvusException

    この例外は、この操作中に何らかのエラーが発生した場合、特に指定されたエイリアスが存在しない場合に発生します。

例​

python
from pymilvus import MilvusClient

# 1. Create a milvus client
client = MilvusClient(
    uri="https://inxx-xxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530",
    token="user:password"
)

# upsert properties
field_params = {"max_length": 1500}

client.alter_collection_field(
    collection_name="collection_name", 
    field_name="my_varchar",
    field_params=field_params
)
Ctrl I