Golang官方Elasticsearch客户端插件库go-elasticsearch的使用

兼容性

Go语言

从版本8.12.0开始，该库遵循Go语言的发布策略。每个主要的Go版本会一直支持到有两个更新的主要版本发布为止。

Elasticsearch

语言客户端是向前兼容的，这意味着客户端支持与Elasticsearch的更高或相等的次要版本通信。Elasticsearch语言客户端仅与默认发行版向后兼容，且不提供保证。

使用Go模块时，在导入路径中包含版本号，并指定显式版本或分支：

require github.com/elastic/go-elasticsearch/v9 v9.x.x
require github.com/elastic/go-elasticsearch/v8 v8.x.x

可以在单个项目中使用多个版本的客户端：

// go.mod
github.com/elastic/go-elasticsearch/v8 v8.18.0
github.com/elastic/go-elasticsearch/v9 v9.0.0

// main.go
import (
  elasticsearch7 "github.com/elastic/go-elasticsearch/v8"
  elasticsearch8 "github.com/elastic/go-elasticsearch/v9"
)
// ...
es8, _ := elasticsearch7.NewDefaultClient()
es9, _ := elasticsearch8.NewDefaultClient()

安装

使用go get命令安装：

go get github.com/elastic/go-elasticsearch/v9

连接示例

package main

import (
	"log"

	"github.com/elastic/go-elasticsearch/v9"
)

func main() {
	// 创建默认客户端
	cfg := elasticsearch.Config{
		Addresses: []string{
			"http://localhost:9200",
		},
	}
	
	es, err := elasticsearch.NewClient(cfg)
	if err != nil {
		log.Fatalf("Error creating the client: %s", err)
	}

	// 检查集群健康状态
	res, err := es.Cluster.Health()
	if err != nil {
		log.Fatalf("Error getting response: %s", err)
	}
	defer res.Body.Close()
	
	log.Println(res)
}

基本操作示例

创建索引

// 创建索引
res, err := es.Indices.Create("test-index")
if err != nil {
	log.Fatalf("Cannot create index: %s", err)
}
defer res.Body.Close()
log.Println(res)

索引文档

// 索引文档
doc := `{"title":"Test document","content":"This is a test document"}`

res, err := es.Index(
	"test-index",                      // 索引名
	strings.NewReader(doc),            // 文档内容
	es.Index.WithDocumentID("1"),      // 文档ID
	es.Index.WithRefresh("true"),      // 刷新索引
)
if err != nil {
	log.Fatalf("Error indexing document: %s", err)
}
defer res.Body.Close()
log.Println(res)

搜索文档

// 搜索文档
query := `{
  "query": {
    "match": {
      "title": "test"
    }
  }
}`

res, err := es.Search(
	es.Search.WithIndex("test-index"),
	es.Search.WithBody(strings.NewReader(query)),
	es.Search.WithPretty(),
)
if err != nil {
	log.Fatalf("Error searching documents: %s", err)
}
defer res.Body.Close()
log.Println(res)

删除文档

// 删除文档
res, err := es.Delete(
	"test-index",  // 索引名
	"1",           // 文档ID
)
if err != nil {
	log.Fatalf("Error deleting document: %s", err)
}
defer res.Body.Close()
log.Println(res)

删除索引

// 删除索引
res, err := es.Indices.Delete([]string{"test-index"})
if err != nil {
	log.Fatalf("Cannot delete index: %s", err)
}
defer res.Body.Close()
log.Println(res)

辅助工具

esutil包提供了方便的辅助函数：

import "github.com/elastic/go-elasticsearch/v9/esutil"

// 使用JSONReader创建请求体
body := esutil.JSONReader(map[string]interface{}{
	"query": map[string]interface{}{
		"match": map[string]interface{}{
			"title": "test",
		},
	},
})

res, err := es.Search(
	es.Search.WithIndex("test-index"),
	es.Search.WithBody(body),
)

完整示例

package main

import (
	"context"
	"encoding/json"
	"log"
	"strings"
	"time"

	"github.com/elastic/go-elasticsearch/v9"
	"github.com/elastic/go-elasticsearch/v9/esapi"
)

func main() {
	// 创建客户端
	cfg := elasticsearch.Config{
		Addresses: []string{"http://localhost:9200"},
	}
	es, err := elasticsearch.NewClient(cfg)
	if err != nil {
		log.Fatalf("Error creating the client: %s", err)
	}

	// 1. 创建索引
	createIndex(es, "test-index")

	// 2. 索引文档
	indexDocument(es, "test-index", "1", `{"title":"Test document","content":"This is a test document"}`)

	// 3. 获取文档
	getDocument(es, "test-index", "1")

	// 4. 搜索文档
	searchDocuments(es, "test-index", "test")

	// 5. 删除文档
	deleteDocument(es, "test-index", "1")

	// 6. 删除索引
	deleteIndex(es, "test-index")
}

func createIndex(es *elasticsearch.Client, indexName string) {
	res, err := es.Indices.Create(indexName)
	if err != nil {
		log.Fatalf("Cannot create index: %s", err)
	}
	defer res.Body.Close()
	log.Printf("Create index response: %s", res.String())
}

func indexDocument(es *elasticsearch.Client, index, id, doc string) {
	req := esapi.IndexRequest{
		Index:      index,
		DocumentID: id,
		Body:       strings.NewReader(doc),
		Refresh:    "true",
	}

	res, err := req.Do(context.Background(), es)
	if err != nil {
		log.Fatalf("Error indexing document: %s", err)
	}
	defer res.Body.Close()
	log.Printf("Index document response: %s", res.String())
}

func getDocument(es *elasticsearch.Client, index, id string) {
	res, err := es.Get(index, id)
	if err != nil {
		log.Fatalf("Error getting document: %s", err)
	}
	defer res.Body.Close()
	
	var result map[string]interface{}
	if err := json.NewDecoder(res.Body).Decode(&result); err != nil {
		log.Fatalf("Error parsing the response body: %s", err)
	}
	log.Printf("Document: %+v", result)
}

func searchDocuments(es *elasticsearch.Client, index, query string) {
	searchBody := `{
		"query": {
			"match": {
				"title": "` + query + `"
			}
		}
	}`

	res, err := es.Search(
		es.Search.WithIndex(index),
		es.Search.WithBody(strings.NewReader(searchBody)),
		es.Search.WithPretty(),
	)
	if err != nil {
		log.Fatalf("Error searching documents: %s", err)
	}
	defer res.Body.Close()
	
	var result map[string]interface{}
	if err := json.NewDecoder(res.Body).Decode(&result); err != nil {
		log.Fatalf("Error parsing the response body: %s", err)
	}
	log.Printf("Search results: %+v", result)
}

func deleteDocument(es *elasticsearch.Client, index, id string) {
	res, err := es.Delete(index, id)
	if err != nil {
		log.Fatalf("Error deleting document: %s", err)
	}
	defer res.Body.Close()
	log.Printf("Delete document response: %s", res.String())
}

func deleteIndex(es *elasticsearch.Client, index string) {
	res, err := es.Indices.Delete([]string{index})
	if err != nil {
		log.Fatalf("Cannot delete index: %s", err)
	}
	defer res.Body.Close()
	log.Printf("Delete index response: %s", res.String())
}

更多示例

可以参考项目中的_examples文件夹，其中包含了许多完整的示例代码，包括客户端配置和自定义、使用自定义CA进行安全(TLS)连接、为单元测试模拟传输、将客户端嵌入自定义类型、构建查询、单独和批量执行请求以及解析响应等。