Skip to Content
ReferenceAPI Reference

API Reference

Complete API reference for the Milvus Node.js SDK.

MilvusClient

Main client class for interacting with Milvus.

Constructor

new MilvusClient(config: ClientConfig | string, ssl?: boolean, username?: string, password?: string, channelOptions?: ChannelOptions)

Static Properties

sdkInfo

Get SDK version information:

MilvusClient.sdkInfo
// Returns: { version: string, recommendMilvus: string }

Collection Operations

createCollection

Create a new collection.

createCollection(data: CreateCollectionReq): Promise<ResStatus>

Parameters:

  • collection_name: Collection name
  • fields: Array of field schemas
  • consistency_level?: Consistency level
  • properties?: Collection properties

hasCollection

Check if collection exists.

hasCollection(data: HasCollectionReq): Promise<BoolResponse>

showCollections

List all collections.

showCollections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse>

describeCollection

Get collection information.

describeCollection(data: DescribeCollectionReq): Promise<DescribeCollectionResponse>

alterCollectionProperties

Modify collection properties.

alterCollectionProperties(data: AlterCollectionReq): Promise<ResStatus>

dropCollection

Delete a collection.

dropCollection(data: DropCollectionReq): Promise<ResStatus>

loadCollection

Load collection into memory.

loadCollection(data: LoadCollectionReq): Promise<ResStatus>

loadCollectionSync

Load collection synchronously.

loadCollectionSync(data: LoadCollectionReq): Promise<ResStatus>

releaseCollection

Release collection from memory.

releaseCollection(data: ReleaseLoadCollectionReq): Promise<ResStatus>

Data Operations

insert

Insert data into collection.

insert(data: InsertReq): Promise<MutationResult>

Parameters:

  • collection_name: Collection name
  • data: Array of data objects
  • partition_name?: Partition name

upsert

Upsert data (insert or update).

upsert(data: UpsertReq): Promise<MutationResult>

query

Query entities by filter.

query(data: QueryReq): Promise<QueryResults>

Parameters:

  • collection_name: Collection name
  • expr: Filter expression
  • output_fields: Fields to return
  • limit?: Result limit
  • offset?: Result offset

Search similar vectors.

search(data: SearchReq): Promise<SearchResults>

Parameters:

  • collection_name: Collection name
  • data: Array of search vectors
  • limit: Number of results
  • expr?: Filter expression
  • output_fields?: Fields to return
  • params?: Search parameters

delete

Delete entities.

delete(data: DeleteReq): Promise<MutationResult>

Parameters:

  • collection_name: Collection name
  • ids?: Array of IDs
  • filter?: Filter expression
  • expr?: Filter expression

count

Count entities matching filter.

count(data: CountReq): Promise<CountResult>

Index Operations

createIndex

Create an index.

createIndex(data: CreateIndexReq): Promise<ResStatus>

Parameters:

  • collection_name: Collection name
  • field_name: Field name
  • index_type: Index type
  • metric_type: Metric type
  • params?: Index parameters

describeIndex

Get index information.

describeIndex(data: DescribeIndexReq): Promise<DescribeIndexResponse>

dropIndex

Delete an index.

dropIndex(data: DropIndexReq): Promise<ResStatus>

getIndexState

Get index build state.

getIndexState(data: GetIndexStateReq): Promise<GetIndexStateResponse>

Partition Operations

createPartition

Create a partition.

createPartition(data: CreatePartitionReq): Promise<ResStatus>

listPartitions

List partitions.

listPartitions(data: ListPartitionsReq): Promise<ListPartitionsResponse>

dropPartition

Delete a partition.

dropPartition(data: DropPartitionReq): Promise<ResStatus>

Database Operations

createDatabase

Create a database.

createDatabase(data: CreateDatabaseRequest): Promise<ResStatus>

listDatabases

List all databases.

listDatabases(data?: ListDatabasesRequest): Promise<ListDatabasesResponse>

dropDatabase

Delete a database.

dropDatabase(data: DropDatabasesRequest): Promise<ResStatus>

User & Role Operations

createUser

Create a user.

createUser(data: CreateUserReq): Promise<ResStatus>

updateUser

Update user password.

updateUser(data: UpdateUserReq): Promise<ResStatus>

deleteUser

Delete a user.

deleteUser(data: DeleteUserReq): Promise<ResStatus>

createRole

Create a role.

createRole(data: CreateRoleReq): Promise<ResStatus>

grantPrivilege

Grant privilege to role.

grantPrivilege(data: OperateRolePrivilegeReq): Promise<ResStatus>

Data Types

DataType Enum

enum DataType {
  None = 0,
  Bool = 1,
  Int8 = 2,
  Int16 = 3,
  Int32 = 4,
  Int64 = 5,
  Float = 10,
  Double = 11,
  String = 20,
  VarChar = 21,
  BinaryVector = 100,
  FloatVector = 101,
  Float16Vector = 102,
  BFloat16Vector = 103,
  SparseFloatVector = 104,
  Int8Vector = 105,
  JSON = 106,
  Array = 107,
  Struct = 108,
  Geometry = 109,
  Timestamptz = 110,
}

Error Codes

ErrorCode Enum

enum ErrorCode {
  SUCCESS = 'Success',
  IndexNotExist = 'IndexNotExist',
  UnexpectedError = 'UnexpectedError',
  EmptyCollection = 'EmptyCollection',
  UpsertAutoIDTrue = 'UpsertAutoIDTrue',
  CollectionNotExists = 'CollectionNotExists',
  IllegalArgument = 'IllegalArgument',
  RateLimit = 'RateLimit',
  SchemaMismatch = 'SchemaMismatch',
}

Response Types

ResStatus

interface ResStatus {
  error_code: string;
  reason?: string;
}

MutationResult

interface MutationResult {
  IDs: number[] | string[];
  insert_cnt: number;
  delete_cnt: number;
  upsert_cnt: number;
  timestamp: string;
  status: ResStatus;
}

QueryResults

interface QueryResults {
  data: RowData[];
  status: ResStatus;
}

SearchResults

interface SearchResults {
  results: SearchResult[];
  status: ResStatus;
}

Next Steps

Last updated on
Best PracticesTroubleshooting