AlterCollectionPropertiesAsync()

Alters the properties of a collection.

public async Task AlterCollectionPropertiesAsync(AlterCollectionPropertiesReq request, CancellationToken cancellationToken = default)

Request Syntax

var request = new AlterCollectionPropertiesReq
{
    CollectionName = "my_collection",
    Properties = { { "ttl.seconds", "3600" } }
};

await client.AlterCollectionPropertiesAsync(request);

REQUEST PARAMETERS:

  • DatabaseName (string?) -

    An optional database name to operate on. When empty, the client’s currently selected database is used.

  • CollectionName (string) -

    The name of the collection.

  • Properties (IDictionary) -

    The properties to set or update on the collection. Entries are added via the collection-initializer syntax Properties = { ... }.

  • DeleteKeys (IReadOnlyList?) -

    The names of properties to remove from the collection.

RETURN TYPE:

Task

RETURNS:

This method does not return a value.

EXCEPTIONS:

  • MilvusException

    Thrown when the RPC fails or the server returns an error. Inspect the exception message for details.

Example

using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Collection;

using var client = new MilvusClientV2(new ConnectConfig
{
    Uri = "localhost:19530",
    Username = "root",
    Password = "Milvus"
});
await client.ConnectAsync();

await client.AlterCollectionPropertiesAsync(new AlterCollectionPropertiesReq
{
    CollectionName = "my_collection",
    Properties = { { "ttl.seconds", "3600" } }
});

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?