Milvus Node.js SDK Documentation

Welcome to the official documentation for the Milvus Node.js SDK. This SDK provides a powerful and easy-to-use interface for interacting with Milvus, a cloud-native vector database designed for scalable similarity search and AI applications.

What is Milvus?

Milvus is an open-source vector database built to power embedding similarity search and AI applications. It provides:

Scalability: Handle billions of vectors with ease
Performance: Optimized for fast similarity search
Flexibility: Support for multiple vector types and data types
Cloud-native: Built for modern cloud architectures

SDK Features

The Milvus Node.js SDK offers:

Full API Coverage: Complete access to all Milvus features
TypeScript Support: Full type definitions for better development experience
Connection Pooling: Efficient connection management
Error Handling: Comprehensive error handling and retry mechanisms
HTTP & gRPC Support: Choose the protocol that fits your needs
Production Ready: Battle-tested in production environments

Version Compatibility

The following table shows the recommended @zilliz/milvus2-sdk-node versions for different Milvus versions:

Milvus version	Node SDK version	Installation
v2.6.0+	latest	`yarn add @zilliz/milvus2-sdk-node@latest`
v2.5.0+	v2.5.0	`yarn add @zilliz/milvus2-sdk-node@2.5.12`
v2.4.0+	v2.4.9	`yarn add @zilliz/milvus2-sdk-node@2.4.9`
v2.3.0+	v2.3.5	`yarn add @zilliz/milvus2-sdk-node@2.3.5`
v2.2.0+	v2.3.5	`yarn add @zilliz/milvus2-sdk-node@2.3.5`

Prerequisites

Node.js: Version 18 or higher
Milvus: A running Milvus instance (standalone or cluster)
Package Manager: npm or yarn

Quick Start


import { MilvusClient } from '@zilliz/milvus2-sdk-node';
 
const client = new MilvusClient({
  address: 'localhost:19530',
});
 
await client.connectPromise;
 
console.log('Connected to Milvus!');

Documentation Structure

Getting Started

Getting Started: Installation and basic usage
Examples & Tutorials: Code examples and tutorials

Core Concepts

Client Configuration: Connection and configuration options
Data Types & Schemas: Understanding data types and schema definition

Data Operations

Database Operations: Database-level operations
Insert & Update: Inserting and updating data
Query & Search: Querying and searching vectors
Delete: Deleting data
Data Management: Data management operations

Management

Collection Management: Creating and managing collections
Partition Management: Managing partitions
Index Management: Creating and managing indexes
User & Role Management: Managing users and roles
Resource Management: Resource management

Advanced

Advanced Features: Connection pooling, retries, and more
HTTP Client: Using HTTP client for serverless environments
Best Practices: Production-ready patterns and optimizations

Reference

API Reference: Complete API documentation
Troubleshooting: Common issues and solutions
Migration & Compatibility: Version migration guides
Contributing: How to contribute to the SDK
Additional Resources: Additional learning resources