README.md

Milvus Go SDK

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

SDK versions

Milvus version	Recommended Go SDK version
2.4.x	2.4.0
2.3.x	2.3.1
2.2.x	2.2.8
2.1.0	2.1.0
2.0.0	2.0.0
1.1.x	1.1.0
1.0.x	1.0.0

Note: Major versions is NOT compatible between Milvus and SDK

Getting started

Prerequisites

Go 1.17 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-sdk-go/v2

2. Include the Milvus Go SDK in your application:

   import "github.com/milvus-io/milvus-sdk-go/v2/client"
   
   //...other snippet ...
   client, err := client.NewClient(context.Background(), client.Config{
      Address: "localhost:19530",
   })
   if err != nil {
       // handle error
   }
   defer client.Close()
   
   client.HasCollection(context.Background(), "YOUR_COLLECTION_NAME")

API Documentation

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

Examples

See examples about how to use this package to communicate with Milvus

Code format

The Go source code is formatted using gofmt and golint.