client

module
v3.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2026 License: Apache-2.0

README

Go MilvusClient

license Go Reference

Go MilvusClient for Milvus. To contribute code to this project, please read our contribution guidelines first.

Getting started

Prerequisites

Go 1.24.12 or higher

Install Milvus Go SDK
  1. Use go get to install the latest version of the Milvus Go SDK and dependencies:

    go get -u github.com/milvus-io/milvus/client/v3
    
  2. Include the Go MilvusClient in your application:

     import "github.com/milvus-io/milvus/client/v3/milvusclient"
    
     //...other snippet ...
     ctx, cancel := context.WithCancel(context.Background())
     defer cancel()
    
     milvusAddr := "YOUR_MILVUS_ENDPOINT"
    
     cli, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
     	Address: milvusAddr,
     })
     if err != nil {
     	// handle error
     }
    
     // Do your work with milvus client
    
API Documentation

Refer to https://milvus.io/api-reference/go/v3.0.x/About.md for the Go SDK API documentation.

Code format

The Go source code is formatted using gci & gofumpt. Please run make lint-fix before sumbit a PR.

Directories

Path Synopsis
internal
merr
Package merr contains the client-side subset of Milvus RPC error handling.
Package merr contains the client-side subset of Milvus RPC error handling.
typeutil
Package typeutil contains the small set of generic and vector helpers used by the standalone Go SDK.
Package typeutil contains the small set of generic and vector helpers used by the standalone Go SDK.
membership
roaringfilter
Package roaringfilter builds the exact MRB1 membership-filter envelope for membership_match(field, {bitmap}, type=roaring), as specified by the roaring-membership design doc (docs/design-docs/design_docs/20260714-roaring-exact-membership-expression.md).
Package roaringfilter builds the exact MRB1 membership-filter envelope for membership_match(field, {bitmap}, type=roaring), as specified by the roaring-membership design doc (docs/design-docs/design_docs/20260714-roaring-exact-membership-expression.md).
sbbf
Package sbbf implements the Parquet Split-Block Bloom Filter (SBBF) wrapped in the Milvus MBF1 envelope, as specified by the bloom-filter-expression design doc (docs/design-docs/design_docs/20260707-bloom-filter-expression.md).
Package sbbf implements the Parquet Split-Block Bloom Filter (SBBF) wrapped in the Milvus MBF1 envelope, as specified by the bloom-filter-expression design doc (docs/design-docs/design_docs/20260707-bloom-filter-expression.md).
Package milvusclient implements the official Go Milvus client for v3.
Package milvusclient implements the official Go Milvus client for v3.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL