ListCollections()

This method lists collections within the connected database.

func (c *GrpcClient) ListCollections(ctx context.Context, opts ...ListCollectionOption) ([]*entity.Collection, error)

Request Parameters

client.ListCollectionOption

You can add extra settings to the ListCollections() request using the following methods.

Return

A list of entity.Collection structs. An entity.Collection struct is as follows:

type Collection struct {
    ID               int64
    Name             string  
    Schema           *Schema // Not included
    PhysicalChannels []string
    VirtualChannels  []string
    Loaded           bool    // Controled by `WithShowInMemory()`
    ConsistencyLevel ConsistencyLevel
    ShardNum         int32
    Properties       map[string]string
}

Errors

Any error in the execution of the request. Possible errors are as follows:

• ErrClientNotReady: The client is not connected to Milvus.

• The call to this API fails.

Example

// list collections
collections, errList := mc.ListCollections(context.Background(), client.WithShowInMemory(false))
if errList != nil {
   log.Fatal("failed to list collection:", errList.Error())
}
for _, c := range collections{
   log.Println(c.Name)
}