milvus-logo
LFAI
< Docs
  • Java

alterCollection()

Alter collection properties. Currently, only support modifies the time to live (TTL) of a collection's data.

R<RpcStatus> alterCollection(AlterCollectionParam requestParam);

AlterCollectionParam

Use the AlterCollectionParam.Builder to construct an AlterCollectionParam object.

import io.milvus.param.AlterCollectionParam;
AlterCollectionParam.Builder builder = AlterCollectionParam.newBuilder();

Methods of AlterCollectionParam.Builder:

Method Description Parameters
withCollectionName(String collectionName) Sets the collection name. Collection name cannot be empty or null. collectionName: The name of the collection to alter properties.
withTTL(Integer ttlSeconds) Collection time to live (TTL) is the expiration time of data in a collection. Expired data in the collection will be cleaned up and will not be involved in searches or queries. Specify TTL in the unit of seconds.
This method internally calls the withProperty() to set value.
ttlSeconds: The time to live value. The value should be 0 or greater.
withProperty(String key, String value) Basic method to set a key-value property. key: The key of a property.
value: The value of a property.
build() Constructs a AlterCollectionParam object. N/A

The AlterCollectionParam.Builder.build() can throw the following exceptions:

  • ParamException: error if the parameter is invalid.

Returns

This method catches all the exceptions and returns an R<RpcStatus> object.

  • If the API fails on the server side, it returns the error code and message from the server.

  • If the API fails by RPC exception, it returns R.Status.Unknown and the error message of the exception.

  • If the API succeeds, it returns R.Status.Success.

Example

import io.milvus.param.*;

AlterCollectionParam param = AlterCollectionParam.newBuilder()
        .withCollectionName(COLLECTION_NAME)
        .withTTL(1800)
        .build();
R<RpcStatus> response = client.alterCollection(param);
if (response.getStatus() != R.Status.Success.getCode()) {
    System.out.println(response.getMessage());
}
Feedback

Was this page helpful?