AddCollectionStructField()

Add a struct field to an existing collection.

Status AddCollectionStructField(const AddCollectionStructFieldRequest& request)

Request Syntax

auto request = AddCollectionStructFieldRequest()
    .WithDatabaseName(db_name)
    .WithCollectionName(collection_name)
    .WithStructField(struct_field_schema);

REQUEST METHODS:

• WithDatabaseName(const std::string& db_name)

  Set target db name, use default database if it is empty.

• SetDatabaseName(const std::string& db_name)

  Set target db name, use default database if it is empty.

• WithCollectionName(const std::string& collection_name)

  Set name of the collection.

• SetCollectionName(const std::string& collection_name)

  Set the collection name.

• WithStructField(StructFieldSchema&& field_schema)

  Set the struct field schema.

• SetStructField(StructFieldSchema&& field_schema)

  Set the struct field schema.

RETURNS:

Status

Returns a status indicating whether the operation succeeded.

ERROR HANDLING:

• Status

  Failures are reported through the returned Status. The SDK converts internal exceptions into a non-OK Status; public API calls do not throw. Inspect status.IsOk() and status.Message() for failure details.

Example

Demonstrates AddCollectionStructField() with the C++ SDK.

auto client = milvus::MilvusClientV2::Create();
milvus::ConnectParam connect_param{"http://localhost:19530", "root:Milvus"};
util::CheckStatus(client->Connect(connect_param));

auto request = milvus::AddCollectionStructFieldRequest();
util::CheckStatus(client->AddCollectionStructField(request));