AlterIndexProperties()

This operation alters the properties of an index.

c++

Status AlterIndexProperties(const AlterIndexPropertiesRequest& request)

Request Syntax

c++

auto request = AlterIndexPropertiesRequest()
    .WithDatabaseName(db_name)
    .WithCollectionName(collection_name)
    .WithIndexName(index_name)
    .WithProperties(properties)
    .AddProperty(key, property);

REQUEST METHODS:

• WithDatabaseName(const std::string& db_name)

  Sets the name of the target database. The default database is used if it is empty.

• WithCollectionName(const std::string& collection_name)

  Sets the name of the collection that contains the index.

• WithIndexName(const std::string& index_name)

  Sets the name of the index. Currently, this API only supports the index name.

• WithProperties(std::unordered_map<std::string, std::string>&& properties)

  Sets the properties to alter on the index, moving the given unordered_map of key-value pairs into the request.

• AddProperty(const std::string& key, const std::string& property)

  Adds a single property to the index, specified as a key-value pair.

RETURNS:

Status

Returns a Status indicating whether the index properties were altered successfully.

ERROR HANDLING:

• std::exception

  Thrown when request construction, transport, or response processing fails. Inspect the exception message or the returned Status for failure details.

Example

Call AlterIndexProperties() on a connected MilvusClientV2 to alter index properties such as enabling mmap.

c++

auto client = milvus::MilvusClientV2::Create();
milvus::ConnectParam connect_param{"YOUR_CLUSTER_ENDPOINT", "YOUR_CLUSTER_TOKEN"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

std::unordered_map<std::string, std::string> properties{{"mmap.enabled", "true"}};
auto request = milvus::AlterIndexPropertiesRequest()
    .WithDatabaseName(db_name)
    .WithCollectionName(collection_name)
    .WithIndexName(index_name)
    .WithProperties(std::move(properties));
status = client->AlterIndexProperties(request);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}