elasticsearch

README

Elasticsearch Serverless Client

This is the official Elastic client for the Elasticsearch Serverless service. If you're looking to develop your Go application with the Elasticsearch Stack, you should look at the Elasticsearch Client instead.

Installation

You can install the Elasticsearch Serverless Go client with the following commands:

go get -u github.com/elastic/elasticsearch-serverless-go@latest

Instantiate a Client

You can instantiate a client by running the following command:

client, err := elasticsearch.NewClient(elasticsearch.Config{
	APIKey: "you_api_key",
	Address: "https://my-project-url",
})

Usage

You can read to the official documentation page for a getting started guide.

Development

See CONTRIBUTING.

Docs

TBD

License 📗

Apache 2.0 © Elastic

Documentation

Index

• Constants
• type BaseClient
  • func (c *BaseClient) Metrics() (elastictransport.Metrics, error)
  • func (c *BaseClient) Perform(req *http.Request) (*http.Response, error)
• type Client
• type Config
• type TypedClient
  • func NewClient(cfg Config) (*TypedClient, error)

Constants

const (
	// Version returns the package version as a string.
	Version = version.Client

	// HeaderClientMeta Key for the HTTP Header related to telemetry data sent with
	// each request to Elasticsearch.
	HeaderClientMeta = "x-elastic-client-meta"
)

Types

type BaseClient

type BaseClient struct {
	Transport elastictransport.Interface
	// contains filtered or unexported fields
}

BaseClient represents the Elasticsearch client.

func (*BaseClient) Metrics

func (c *BaseClient) Metrics() (elastictransport.Metrics, error)

Metrics returns the client metrics.

func (*BaseClient) Perform

func (c *BaseClient) Perform(req *http.Request) (*http.Response, error)

Perform delegates to Transport to execute a request and return a response.

type Client

type Client struct {
	BaseClient
}

Client represents the Functional Options API.

type Config

type Config struct {
	Address  string // A list of Elasticsearch nodes to use.
	Username string // Username for HTTP Basic Authentication.
	Password string // Password for HTTP Basic Authentication.

	CloudID      string // Endpoint for the Elastic Service (https://elastic.co/cloud).
	APIKey       string // Base64-encoded token for authorization; if set, overrides username/password and service token.
	ServiceToken string // Service token for authorization; if set, overrides username/password.

	Header http.Header // Global HTTP request header.

	RetryOnStatus []int                           // List of status codes for retry. Default: 502, 503, 504.
	DisableRetry  bool                            // Default: false.
	MaxRetries    int                             // Default: 3.
	RetryOnError  func(*http.Request, error) bool // Optional function allowing to indicate which error should be retried. Default: nil.

	CompressRequestBody      bool // Default: false.
	CompressRequestBodyLevel int  // Default: gzip.DefaultCompression.

	DiscoverNodesOnStart  bool          // Discover nodes when initializing the client. Default: false.
	DiscoverNodesInterval time.Duration // Discover nodes periodically. Default: disabled.

	EnableDebugLogger bool // Enable the debug logging.

	DisableMetaHeader bool // Disable the additional "X-Elastic-Client-Meta" HTTP header.

	RetryBackoff func(attempt int) time.Duration // Optional backoff duration. Default: nil.

	Transport http.RoundTripper       // The HTTP transport object.
	Logger    elastictransport.Logger // The logger object.
}

Config represents the client configuration.

type TypedClient

type TypedClient struct {
	BaseClient
	*typedapi.API
}

TypedClient represents the Typed API.

func NewClient

func NewClient(cfg Config) (*TypedClient, error)

NewClient creates a new client with configuration from cfg.

It will use http://localhost:9200 as the default address.

It will use the ELASTICSEARCH_URL environment variable, if set, to configure the addresses; use a comma to separate multiple URLs.

If cfg.Address or cfg.CloudID is set, the ELASTICSEARCH_URL environment variable is ignored.

It's an error to set both cfg.Address and cfg.CloudID.