milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Add README for go milvusclient (#40630) 

Related to #31293

Signed-off-by: Congqi Xia <congqi.xia@zilliz.com>
pull/40643/head
congqixia 2025-03-13 16:02:07 +08:00 committed by GitHub
parent aaf8ddcec6
commit e93d53ca28
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
client/README.md Normal file
View File

@ -0,0 +1,50 @@
# Go MilvusClient
[![license](https://img.shields.io/hexpm/l/plug.svg?color=green)](https://github.com/milvus-io/milvus/blob/master/LICENSE)
[![Go Reference](https://pkg.go.dev/badge/github.com/milvus-io/milvus/client/v2.svg)](https://pkg.go.dev/github.com/milvus-io/milvus/client/v2)
Go MilvusClient for [Milvus](https://github.com/milvus-io/milvus). To contribute code to this project, please read our [contribution guidelines](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md) first.
## Getting started
### Prerequisites
Go 1.21 or higher
### Install Milvus Go SDK
1. Use `go get` to install the latest version of the Milvus Go SDK and dependencies:
```shell
go get -u github.com/milvus-io/milvus/client/v2
```
2. Include the Go MilvusClient in your application:
```go
import "github.com/milvus-io/milvus/client/v2/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/v2.5.x/About.md](https://milvus.io/api-reference/go/v2.5.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.