# Milvus Node.js SDK

Connect a Node.js application to Milvus or Zilliz Cloud and list collections.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/

## Section links

- [Install](https://milvus-io.github.io/milvus-sdk-node/#install)
- [Connect and list collections](https://milvus-io.github.io/milvus-sdk-node/#connect-and-list-collections)
- [Start building](https://milvus-io.github.io/milvus-sdk-node/#start-building)
- [Compatibility](https://milvus-io.github.io/milvus-sdk-node/#compatibility)

`@zilliz/milvus2-sdk-node` v3.x is the official Node.js SDK for compatible Milvus 2.x and 3.0+ deployments and Zilliz Cloud, with `MilvusClient` for gRPC and `HttpClient` for REST v2.

## Install

```sh
npm install @zilliz/milvus2-sdk-node
```

## Connect and list collections

```js
import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const client = new MilvusClient({
  address: process.env.MILVUS_ADDRESS ?? 'localhost:19530',
  token: process.env.MILVUS_TOKEN,
});

try {
  const { status, data } = await client.listCollections();
  if (status.error_code !== 'Success') throw new Error(status.reason);
  console.log(data.map((collection) => collection.name));
} finally {
  await client.closeConnection();
}
```

Run `node list-collections.mjs` against local Milvus, or set `MILVUS_ADDRESS` and `MILVUS_TOKEN` for your cluster.

## Start building

- [Create a collection](https://milvus-io.github.io/milvus-sdk-node/getting-started/getting-started/#your-first-collection)
- [Insert data](https://milvus-io.github.io/milvus-sdk-node/operations/data-operations-insert/)
- [Search vectors](https://milvus-io.github.io/milvus-sdk-node/operations/data-operations-query/)
- [Explore the REST API](https://milvus-io.github.io/milvus-sdk-node/rest-api/)

## Compatibility

SDK 3.0.10 · Node.js 18+

Tested with Milvus 3.0.6
