Class MilvusStore

constructor

• new MilvusStore(options: ClientConfig): MilvusStore

  Parameters

  • options: ClientConfig

  Returns MilvusStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): MilvusClient

  Returns the underlying MilvusClient for anything not wrapped here.

  Returns MilvusClient

createCollection

• createCollection(
      collectionName: string,
      fields: MilvusFieldDefinition[],
      options?: MilvusCreateCollectionOptions,
  ): Promise<void>

  Create a collection with an explicit field schema (primary key + one or more vector fields + optional scalars).

  Parameters

  • collectionName: string
  • fields: MilvusFieldDefinition[]
  • options: MilvusCreateCollectionOptions = {}

  Returns Promise<void>

dropCollection

• dropCollection(collectionName: string): Promise<void>

  Parameters

  • collectionName: string

  Returns Promise<void>

hasCollection

• hasCollection(collectionName: string): Promise<boolean>

  Parameters

  • collectionName: string

  Returns Promise<boolean>

describeCollection

• describeCollection(collectionName: string): Promise<DescribeCollectionResponse>

  Parameters

  • collectionName: string

  Returns Promise<DescribeCollectionResponse>

listCollections

• listCollections(): Promise<CollectionData[]>

  List all collections.

  Returns Promise<CollectionData[]>

loadCollection

• loadCollection(collectionName: string, replicaNumber?: number): Promise<void>

  Load a collection's data into query nodes' memory so it can be searched/queried.

  Parameters

  • collectionName: string
  • OptionalreplicaNumber: number

  Returns Promise<void>

releaseCollection

• releaseCollection(collectionName: string): Promise<void>

  Release a collection's data from memory (it remains persisted; reload with loadCollection() to search it again).

  Parameters

  • collectionName: string

  Returns Promise<void>

getCollectionStatistics

• getCollectionStatistics(
      collectionName: string,
  ): Promise<Record<string, unknown>>

  Parameters

  • collectionName: string

  Returns Promise<Record<string, unknown>>

createIndex

• createIndex(
      collectionName: string,
      options: MilvusCreateIndexOptions,
  ): Promise<void>

  Parameters

  • collectionName: string
  • options: MilvusCreateIndexOptions

  Returns Promise<void>

dropIndex

• dropIndex(
      collectionName: string,
      fieldName?: string,
      indexName?: string,
  ): Promise<void>

  Parameters

  • collectionName: string
  • OptionalfieldName: string
  • OptionalindexName: string

  Returns Promise<void>

describeIndex

• describeIndex(
      collectionName: string,
      fieldName?: string,
  ): Promise<MilvusIndexInfo[]>

  Parameters

  • collectionName: string
  • OptionalfieldName: string

  Returns Promise<MilvusIndexInfo[]>

listIndexes

• listIndexes(collectionName: string): Promise<string[]>

  Parameters

  • collectionName: string

  Returns Promise<string[]>

insert

• insert(
      collectionName: string,
      rows: RowData[],
      options?: MilvusWriteOptions,
  ): Promise<MutationResult>

  Parameters

  • collectionName: string
  • rows: RowData[]
  • options: MilvusWriteOptions = {}

  Returns Promise<MutationResult>

upsert

• upsert(
      collectionName: string,
      rows: RowData[],
      options?: MilvusWriteOptions,
  ): Promise<MutationResult>

  Parameters

  • collectionName: string
  • rows: RowData[]
  • options: MilvusWriteOptions = {}

  Returns Promise<MutationResult>

search

• search(
      collectionName: string,
      options: MilvusSearchOptions,
  ): Promise<MilvusSearchHit[]>

  Approximate-nearest-neighbor search against a vector field. Ranks by the collection's index metric (L2/IP/COSINE/...), optionally narrowed by a scalar filter expression evaluated alongside the vector comparison.

  Parameters

  • collectionName: string
  • options: MilvusSearchOptions

  Returns Promise<MilvusSearchHit[]>

query

• query(
      collectionName: string,
      options?: MilvusQueryOptions,
  ): Promise<Record<string, unknown>[]>

  Scalar-only lookup (no vector similarity) via a filter expression and/or primary key list.

  Parameters

  • collectionName: string
  • options: MilvusQueryOptions = {}

  Returns Promise<Record<string, unknown>[]>

get

• get(
      collectionName: string,
      ids: (string | number)[],
      outputFields?: string[],
  ): Promise<Record<string, unknown>[]>

  Fetch specific rows by primary key. Equivalent to query() with ids set, using Milvus's dedicated Get RPC.

  Parameters

  • collectionName: string
  • ids: (string | number)[]
  • OptionaloutputFields: string[]

  Returns Promise<Record<string, unknown>[]>

count

• count(collectionName: string, filter?: string): Promise<number>

  Count rows matching an optional filter expression (all rows if omitted).

  Parameters

  • collectionName: string
  • Optionalfilter: string

  Returns Promise<number>

deleteByIds

• deleteByIds(
      collectionName: string,
      ids: (string | number)[],
      partitionName?: string,
  ): Promise<MutationResult>

  Parameters

  • collectionName: string
  • ids: (string | number)[]
  • OptionalpartitionName: string

  Returns Promise<MutationResult>

deleteByFilter

• deleteByFilter(
      collectionName: string,
      filter: string,
      partitionName?: string,
  ): Promise<MutationResult>

  Parameters

  • collectionName: string
  • filter: string
  • OptionalpartitionName: string

  Returns Promise<MutationResult>

createPartition

• createPartition(collectionName: string, partitionName: string): Promise<void>

  Parameters

  • collectionName: string
  • partitionName: string

  Returns Promise<void>

dropPartition

• dropPartition(collectionName: string, partitionName: string): Promise<void>

  Parameters

  • collectionName: string
  • partitionName: string

  Returns Promise<void>

hasPartition

• hasPartition(collectionName: string, partitionName: string): Promise<boolean>

  Parameters

  • collectionName: string
  • partitionName: string

  Returns Promise<boolean>

listPartitions

• listPartitions(collectionName: string): Promise<string[]>

  Parameters

  • collectionName: string

  Returns Promise<string[]>

loadPartitions

• loadPartitions(
      collectionName: string,
      partitionNames: string[],
      replicaNumber?: number,
  ): Promise<void>

  Parameters

  • collectionName: string
  • partitionNames: string[]
  • OptionalreplicaNumber: number

  Returns Promise<void>

releasePartitions

• releasePartitions(
      collectionName: string,
      partitionNames: string[],
  ): Promise<void>

  Parameters

  • collectionName: string
  • partitionNames: string[]

  Returns Promise<void>

getPartitionStatistics

• getPartitionStatistics(
      collectionName: string,
      partitionName: string,
  ): Promise<Record<string, unknown>>

  Parameters

  • collectionName: string
  • partitionName: string

  Returns Promise<Record<string, unknown>>