说明
Elastic 官方鼓励在项目中尝试用这个包,但请记住以下几点:
这个项目的工作还在进行中,并非所有计划的功能和 Elasticsearch 官方客户端中的标准(故障重试,节点自动发现等)都实现了。
API 稳定性无法保证。 尽管公共 API 的设计非常谨慎,但它们可以根据进一步的探索和用户反馈以不兼容的方式进行更改。
客户端的目标是 Elasticsearch 7.x 版本。后续将添加对 6.x 和 5.x 版本 API 的支持。
安装
用go get
安装这个包:
go get -u github.com/elastic/go-elasticsearch
或者将这个包添加到go.mod
文件:
require github.com/elastic/go-elasticsearch v0.0.0
或者克隆这个仓库:
git clone https://github.com/elastic/go-elasticsearch.git && cd go-elasticsearch
一个完整的示例:
mkdir my-elasticsearch-app && cd my-elasticsearch-app
cat > go.mod <<-END
module my-elasticsearch-app
require github.com/elastic/go-elasticsearch v0.0.0
END
cat > main.go <<-END
package main
import (
"log"
"github.com/elastic/go-elasticsearch"
)
func main() {
es, _ := elasticsearch.NewDefaultClient()
log.Println(es.Info())
}
END
go run main.go
用法
elasticsearch
包与另外两个包绑定在一起,esapi
用于调用 Elasticsearch 的 API,estransport
通过 HTTP 传输数据。
使用elasticsearch.NewDefaultClient()
函数创建带有以下默认设置的客户端:
es, err := elasticsearch.NewDefaultClient()
if err != nil {
log.Fatalf("Error creating the client: %s", err)
}
res, err := es.Info()
if err != nil {
log.Fatalf("Error getting response: %s", err)
}
log.Println(res)
// [200 OK] {
// "name" : "node-1",
// "cluster_name" : "go-elasticsearch"
// ...
注意:当导出ELASTICSEARCH_URL
环境变量时,它将被用作集群端点。
使用elasticsearch.NewClient()
函数(仅用作演示)配置该客户端:
cfg := elasticsearch.Config{
Addresses: []string{
"http://localhost:9200",
"http://localhost:9201",
},
Transport: &http.Transport{
MaxIdleConnsPerHost: 10,
ResponseHeaderTimeout: time.Second,
DialContext: (&net.Dialer{Timeout: time.Second}).DialContext,
TLSClientConfig: &tls.Config{
MaxVersion: tls.VersionTLS11,
InsecureSkipVerify: true,
},
},
}
es, err := elasticsearch.NewClient(cfg)
// ...
下面的示例展示了更复杂的用法。它从集群中获取 Elasticsearch 版本,同时索引几个文档,并使用响应主体周围的一个轻量包装器打印搜索结果。
// $ go run _examples/main.go
package main
import (
"context"
"encoding/json"
"log"
"strconv"
"strings"
"sync"
"github.com/elastic/go-elasticsearch"
"github.com/elastic/go-elasticsearch/esapi"
)
func main() {
log.SetFlags(0)
var (
r map[string]interface{}
wg sync.WaitGroup
)
// Initialize a client with the default settings.
//
// An `ELASTICSEARCH_URL` environment variable will be used when exported.
//
es, err := elasticsearch.NewDefaultClient()
if err != nil {
log.Fatalf("Error creating the client: %s", err)
}
// 1. Get cluster info
//
res, err := es.Info()
if err != nil {
log.Fatalf("Error getting response: %s", err)
}
// Deserialize the response into a map.
if err := json.NewDecoder(res.Body).Decode(&r); err != nil {
log.Fatalf("Error parsing the response body: %s", err)
}
// Print version number.
log.Printf("~~~~~~~> Elasticsearch %s", r["version"].(map[string]interface{})["number"])
// 2. Index documents concurrently
//
for i, title := range []string{"Test One", "Test Two"} {
wg.Add(1)
go func(i int, title string) {
defer wg.Done()
// Set up the request object directly.
req := esapi.IndexRequest{
Index: "test",
DocumentID: strconv.Itoa(i + 1),
Body: strings.NewReader(`{"title" : "` + title + `"}`),
Refresh: "true",
}
// Perform the request with the client.
res, err := req.Do(context.Background(), es)
if err != nil {
log.Fatalf("Error getting response: %s", err)
}
defer res.Body.Close()
if res.IsError() {
log.Printf("[%s] Error indexing document ID=%d", res.Status(), i+1)
} else {
// Deserialize the response into a map.
var r map[string]interface{}
if err := json.NewDecoder(res.Body).Decode(&r); err != nil {
log.Printf("Error parsing the response body: %s", err)
} else {
// Print the response status and indexed document version.
log.Printf("[%s] %s; version=%d", res.Status(), r["result"], int(r["_version"].(float64)))
}
}
}(i, title)
}
wg.Wait()
log.Println(strings.Repeat("-", 37))
// 3. Search for the indexed documents
//
// Use the helper methods of the client.
res, err = es.Search(
es.Search.WithContext(context.Background()),
es.Search.WithIndex("test"),
es.Search.WithBody(strings.NewReader(`{"query" : { "match" : { "title" : "test" } }}`)),
es.Search.WithTrackTotalHits(true),
es.Search.WithPretty(),
)
if err != nil {
log.Fatalf("ERROR: %s", err)
}
defer res.Body.Close()
if res.IsError() {
var e map[string]interface{}
if err := json.NewDecoder(res.Body).Decode(&e); err != nil {
log.Fatalf("error parsing the response body: %s", err)
} else {
// Print the response status and error information.
log.Fatalf("[%s] %s: %s",
res.Status(),
e["error"].(map[string]interface{})["type"],
e["error"].(map[string]interface{})["reason"],
)
}
}
if err := json.NewDecoder(res.Body).Decode(&r); err != nil {
log.Fatalf("Error parsing the response body: %s", err)
}
// Print the response status, number of results, and request duration.
log.Printf(
"[%s] %d hits; took: %dms",
res.Status(),
int(r["hits"].(map[string]interface{})["total"].(map[string]interface{})["value"].(float64)),
int(r["took"].(float64)),
)
// Print the ID and document source for each hit.
for _, hit := range r["hits"].(map[string]interface{})["hits"].([]interface{}) {
log.Printf(" * ID=%s, %s", hit.(map[string]interface{})["_id"], hit.(map[string]interface{})["_source"])
}
log.Println(strings.Repeat("=", 37))
}
// ~~~~~~~> Elasticsearch 7.0.0-SNAPSHOT
// [200 OK] updated; version=1
// [200 OK] updated; version=1
// -------------------------------------
// [200 OK] 2 hits; took: 7ms
// * ID=1, map[title:Test One]
// * ID=2, map[title:Test Two]
// =====================================
如上述示例所示,esapi
包允许通过两种不同的方式调用 Elasticsearch API:通过创建结构(如IndexRequest
),并向其传递上下文和客户端来调用其Do()
方法,或者通过客户端上可用的函数(如WithIndex()
)直接调用其上的Search()
函数。更多信息请参阅包文档。
estransport
包处理与 Elasticsearch 之间的数据传输。 目前,这个实现只占据很小的空间:它只在已配置的集群端点上进行循环。后续将添加更多功能:重试失败的请求,忽略某些状态代码,自动发现群集中的节点等等。
Examples
_examples
文件夹包含许多全面的示例,可帮助你上手使用客户端,包括客户端的配置和自定义,模拟单元测试的传输,将客户端嵌入自定义类型,构建查询,执行请求和解析回应。
许可证
遵循 Apache License 2.0 版本。
参考链接:
https://github.com/elastic/go-elasticsearch#go-elasticsearch
更多内容推荐
Druid 独立服务器方式部署文档
Druid 包含有一组可用的参考配置和用于单机部署的启动脚本:
2021-08-05
在 Kubernetes 集群上部署和管理 JFrog Artifactory
本文来自RancherLabs微信公众号
23|从集群角度拆解 RabbitMQ 的架构设计与实现
详解RabbitMQ在集群构建、数据可靠性、数据安全、集群可观测性等四大模块的实现。
2023-08-11
如何在 GO 语言中使用 Kubernetes API?
本文来自RancherLabs微信公众号
5. ZooKeeper 总结
2023-09-08
Graylog 部署文档
Graylog的架构主要有两种,一种是最小化Graylog,用于较小的非关键或测试环境,各组成组件之间不冗余,设置简单快捷;另一种是针对更大生产环境下的Graylog,各组成组件之间组成集群架构,在Graylog节点前部署负载均衡,适用于生产环境。
2020-05-06
扩展 Elasticsearch 客户端简化 ES 查询 (.net core/framework)
Elasticsearch .net 客户端提供了两种方式进行查询操作
2021-07-07
你要的 Elasticsearch ORM 框架终于来了
如果你在使用Elasticsearch的过程中,还在为构建Elasticsearch的DSL语句而苦恼,还在为构建复杂冗长的条件而头疼,还在为一次次的响应提取而奔溃,那你这时候需要一个简单方便上手的Elasticsearch ORM框架:**ebatis**!
基于 Kafka 技术栈构建和部署实时搜索引擎的实践
实现强大的搜索能力——从设计决策到幕后的一切
07|如何解决 Prometheus 的存储容量问题?
如何扩展 Prometheus 的存储
2023-01-23
Elasticsearch 安装
登录你的服务器,作者在这里准备了一台云服务器,创建一个目录,将Elasticsearch下载到你的服务器上。
2020-08-22
39|Elasticsearch 高可用:怎么保证 Elasticsearch 的高可用?
怎么保证Elasticsearch的高可用?
2023-09-20
Filebeat 配置部署指南
在本文中,我们将了解如何配置Filebeat作为DaemonSet在我们的Kubernetes集群中运行,以便将日志运送到Elasticsearch后端。
Elasticsearch 源码学习(1)源码编译调试
Elasticsearch 源码学习(1)源码编译调试
2021-09-21
26|从集群角度拆解 Pulsar 的架构设计与实现
Pulsar 作为 Kafka 的升级替代品,它主要解决了 Kafka 在集群层面的弹性和规模限制问题。
2023-08-18
ZooKeeper 浅析(二)
ZooKeeper客户端操作
2022-10-29
SpringBoot 整合 Elasticsearch
============================================================================
2021-11-11
Etcd 超全解:原力阐释及部署设置的最佳实践
本文来自RancherLabs微信公众号
03|架构概述:一个监控系统的典型架构是什么样的?
监控系统由哪些模块组成,各个模块是如何相互协同的
2023-01-13
快速上手 Elasticsearch bboss restclient
Elasticsearch Bboss--高性能Elasticsearch Java RestClient
2022-08-29
InfoQ 技术编辑
推荐阅读
17. Prometheus 详解
2023-09-26
如何基于 Apache Doris 构建新一代日志分析平台
数据湖仓不借助 Fiori client,直接在手机浏览器里调用 SAP UI5 BarcodeScanner 实现条形码扫描的可能性?
2022-11-05
干货 | Elasticsearch Java 客户端演进历史和选型指南
2023-09-15
4、高可用集群基本原理与搭建
2023-09-27
7、Nginx 应用实战之反向代理应用
2023-09-28
苹果电脑 FTP 客户端:Transmit for mac 中文版 支持 M/intel
2023-12-08
电子书
大厂实战PPT下载
换一换 王耀 | 百度智能云 技术委员会主席
William Yang | HashiCorp 资深解决方案工程师
郑芸 | 畅捷通 总架构师
评论 1 条评论