LoadCollectionAsync()

Loads a collection into memory.

public async Task LoadCollectionAsync(LoadCollectionReq request, CancellationToken cancellationToken = default)

Request Syntax

var request = new LoadCollectionReq
{
    CollectionName = "my_collection",
    ReplicaNumber = 1,
    Sync = true,
    TimeoutMs = 60000
};

await client.LoadCollectionAsync(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 to load.

  • ReplicaNumber (int) -

    The replica number to load. Defaults to 1.

  • Sync (bool) -

    Whether to wait until the collection is fully loaded. Defaults to true.

  • TimeoutMs (long) -

    The maximum time in milliseconds to wait for the collection to load when Sync is enabled. Defaults to 60000. A value of 0 means wait forever.

  • Refresh (bool) -

    When true, loads with refresh enabled, causing the server to reload the collection metadata.

  • LoadFields (IReadOnlyList) -

    When set, only the listed fields are loaded into memory (field partial loading).

  • SkipLoadDynamicField (bool) -

    When true, dynamic fields are not loaded even when partial loading is not otherwise requested.

  • TargetResourceGroups (IReadOnlyList) -

    The resource groups to load the collection replicas into.

  • Priority (string?) -

    The load priority, e.g. "Low", "Medium" or "High". When set, it is sent to the server as the load_priority load parameter (normalized to lower case).

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 Milvus.Client.V2.Types;

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

await client.LoadCollectionAsync(new LoadCollectionReq
{
    CollectionName = "my_collection",
    ReplicaNumber = 1,
    Sync = true,
    TimeoutMs = 60000
});

Try Managed Milvus for Free

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

Get Started
Feedback

Was this page helpful?