proxy.golang.org : github.com/elastic/go-elasticsearch/v7/esapi
Package esapi provides the Go API for Elasticsearch. It is automatically included in the client provided by the github.com/elastic/go-elasticsearch package: For each Elasticsearch API, such as "Index", the package exports two corresponding types: a function and a struct. The function type allows you to call the Elasticsearch API as a method on the client, passing the parameters as arguments: The struct type allows for a more hands-on approach, where you create a new struct, with the request configuration as fields, and call the Do() method with a context and the client as arguments: The function type is a wrapper around the struct, and allows to configure and perform the request in a more expressive way. It has a minor overhead compared to using a struct directly; refer to the esapi_benchmark_test.go suite for concrete numbers. See the documentation for each API function or struct at https://godoc.org/github.com/elastic/go-elasticsearch, or locally by: The esapi.Response type is a lightweight wrapper around http.Response. The res.Body field is an io.ReadCloser, leaving the JSON parsing to the calling code, in the interest of performance and flexibility (eg. to allow using a custom JSON parser). It is imperative to close the response body for a non-nil response. The Response type implements a couple of convenience methods for accessing the status, checking an error status code or printing the response body for debugging purposes. See the Elasticsearch documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/api-conventions.html for detailed information about the API endpoints and parameters. The Go API is generated from the Elasticsearch JSON specification at https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/api by the internal package available at https://github.com/elastic/go-elasticsearch/tree/master/internal/cmd/generate/commands/gensource. The API is tested by integration tests common to all Elasticsearch official clients, generated from the source at https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/test. The generator is provided by the internal package available at internal/cmd/generate/commands/gentests.
Registry
-
Source
- Documentation
- JSON
purl: pkg:golang/github.com/elastic/go-elasticsearch/v7/esapi
Keywords:
client
, elasticsearch
, go
, golang
License: Apache-2.0
Latest release: 9 days ago
Namespace: github.com/elastic/go-elasticsearch/v7
Stars: 5,716 on GitHub
Forks: 618 on GitHub
Total Commits: 659
Committers: 56
Average commits per author: 11.768
Development Distribution Score (DDS): 0.489
More commit stats: commits.ecosyste.ms
See more repository details: repos.ecosyste.ms
Last synced: 9 days ago