New()

This method creates a Milvus client that connects to a specific Milvus deployment.

func New(ctx context.Context, config *ClientConfig) (*Client, error)

Request Parameters

Parameter	Description	Type
ctx	Context for the current call to work.	context.Context
config	Client configurations. For details, refer to the ClientConfig section.	ClientConfig

ClientConfig

This struct type defines all possible client configuration items as follows:

type ClientConfig struct {
    Address  string // Remote address, "YOUR_CLUSTER_ENDPOINT".
    Username string // Username for auth.
    Password string // Password for auth.
    DBName   string // DBName for this client.
    EnableTLSAuth bool   // Enable TLS Auth for transport security.
    APIKey        string // API key
    RetryRateLimit *RetryRateLimitOption // option for retry on rate limit inteceptor
}

Parameter	Description	Type
Address	Specifies the address of your Zilliz Cloud cluster.	string
Username	Specifies a valid username for authentication.	string
Password	Specifies the password of the above user.	string
DBName	Specifies the database to access.	string
EnableTLSAuth	Specifies whether to connect with TLS authentication enabled.	bool
APIKey	Specifies the API key with sufficient permissions to access the above Zilliz Cloud cluster.	string
RetryRateLimit	Specifies the retry rate limit in case the connection fails. For details, refer to the RetryRateLimitOption section.	*RetryRateLimitOption

RetryRateLimitOption

This struct type defines the retry options for the connection.

type RetryRateLimitOption struct {
    MaxRetry   uint
    MaxBackoff time.Duration
}

Parameter	Description	Type
MaxRetry	Specifies the maximum number of times the client should retry the connection.	uint
MaxBackoff	Specifies the maximum back-off duration for the connection.	time.Duration

Return

A Client object.

Example

import (
   "context"
   "github.com/milvus-io/milvus/v2/milvusclient"
)

// user cluster username and password
mclient, err := client.New(context.Background(), client.Config{
   Address: "YOUR_CLUSTER_ENDPOINT",
   Username: "YOUR_USERNAME",
   Password: "YOUR_PASSWORD"
})

// or use an API key with appropriate permissions
// client, err := client.New(context.Background(), client.Config{
//    Address: "YOUR_CLUSTER_ENDPOINT",
//    APIKey: "YOUR_API_KEY",
//    EnableTLSAuth: true,
// })