milvus-logo

Manage Milvus Connections

This topic describes how to connect to and disconnect from a Milvus server.

Ensure to connect to a Milvus server before any operations.

Milvus supports two ports, port 19530 and port 9091:

  • Port 19530 is for gRPC. It is the default port when you connect to a Milvus server with different Milvus SDKs.

  • Port 9091 is for RESTful API. It is used when you connect to a Milvus server with an HTTP client.

The example below connects to the Milvus server with host as localhost and port as 19530 or 9091, and disconncets from it. If the connection is refused, try unblocking the corresponding port.

Connect to a Milvus server

Construct a Milvus connection. Ensure to connect to Milvus server before any operations.

# Run `python3` in your terminal to operate in the Python interactive mode.
from pymilvus import connections
connections.connect(
  alias="default", 
  host='localhost', 
  port='19530'
)
import { MilvusClient } from "@zilliz/milvus2-sdk-node";
const address = "localhost:19530";
const milvusClient = new MilvusClient(address);
milvusClient, err := client.NewGrpcClient(
  context.Background(), // ctx
  "localhost:19530",    // addr
)
if err != nil {
  log.Fatal("failed to connect to Milvus:", err.Error())
}
final MilvusServiceClient milvusClient = new MilvusServiceClient(
  ConnectParam.newBuilder()
    .withHost("localhost")
    .withPort(19530)
    .build()
);
connect -h localhost -p 19530 -a default
curl localhost:9091/api/v1/health  
{"status":"ok"}
Parameter Description
alias Alias of the Milvus connection to construct.
host IP address of the Milvus server.
port Port of the Milvus server.
Parameter Description
address Address of the Milvus connection to construct.
Parameter Description
ctx Context to control API invocation process.
addr Address of the Milvus connection to construct.
Parameter Description
Host IP address of the Milvus server.
Port Port of the Milvus server.
Option Description
-h (Optional) The host name. The default is "127.0.0.1".
-p (Optional) The port number. The default is "19530".
-a (Optional) The alias name of the Milvus link. The default is "default".
-D (Optional) Flag to disconnect from the Milvus server specified by an alias. The default alias is "default".

Return

A Milvus connection created by the passed parameters.

Raises

  • NotImplementedError: If handler in connection parameters is not GRPC.
  • ParamError: If pool in connection parameters is not supported.
  • Exception: If server specified in parameters is not ready, we cannot connect to server.

Disconnect from a Milvus server

Disconnect from a Milvus server.

connections.disconnect("default")
await milvusClient.closeConnection();
milvusClient.Close()
milvusClient.close()
connect -D
# Close your HTTP client connection.
Parameter Description
alias Alias of the Milvus server to disconnect from.

Limits

The maximum number of connections is 65,536.

What's next

Having connected to a Milvus server, you can:

Is this page helpful?
On this page