github.com/elastic/go-elasticsearch/v8

⚠ BREAKING CHANGES

• esapi: params previously typed *int on ~20 esapi endpoints are now *int64 to match the spec long type. Call sites passing untyped integer literals keep compiling; call sites passing a typed int variable need an int64(...) cast.

Features

• client: Add (*Client).ToTyped() conversion method (#1450) (5615aed)
• esutil: Add FlushJitter option to BulkIndexer (#1439) (f0ad701)

Bug Fixes

• esapi: Regenerate esapi with *int64 for long-typed params (#1414) (13e5d5e)
• gen: Accept bool form for deprecated in URL parts and paths (#1413) (9874577)
• gen: Map spec long to *int64 for esapi params (#1391) (9a2424c)
• gen: Support *int64 fields in gen-tests output (#1417) (fa81ccf)

⚠ BREAKING CHANGES

• Typed API: update client from spec 6ee016a

Features

• Add AutoDrainBody option for automatic response body draining (#1370) (c9a2b0b)
• Add functional options pattern for client instantiation (#1321) (7561adf)
• esutil: Add Flush method to BulkIndexer for explicit flush-and-wait (#1361) (be8564d)
• Typed API: Improved generated code comments (fe06c54)
• Typed API: Update client from spec 6ee016a (74ed65d)

Bug Fixes

• esutil: Deterministic context check in BulkIndexer.Close (#1338) (a00439e)
• esutil: Propagate caller context through BulkIndexer item callbacks (#1314) (ca77d44)
• Typed API: Context variable shadowing in TypedAPI Perform causing otel attributes to leak to parent span (#1329) (fe06c54)

Bug Fixes

• bulk_indexer: Enable instrumentation support in bulk index requests (#1244) (55c605e)
• esutil: Avoid duplicate bulk indexer OnError callbacks (#1249) (3f5bf89)
• esutil: Propagate context timeout while closing bulk indexer (#1252) (9fe5ea8)
• Prevent BulkIndexer from silently dropping items on flush failure (#1239) (b80ae39)
• Typed API: Add field-level nil checks during deserialisation (#1223) (7f27889)
• Typed API: Add missing custom UnmarshalJSON methods for types with additional properties (7f27889)

Features

• Expose FlushedMs metric in BulkIndexer (#1188) (9199fa4)

Bug Fixes

• esutil: Handle error from Seek in BulkIndexer.writeBody (#1160) (cf53b87)
• Typed API: Marshal Additional Properties into json.RawMessage instead of any to avoid loss of precision (#1196) (08855c2)

Features

• Add Close method to BaseClient (#1056) (#1076) (e73cb92)
• Add queue size multiplier config to BulkIndexer (#1029) (#1055) (cdaf2aa)
• Add support for interceptors in Elasticsearch client (#1080) (#1086) (f4bda5f)

Bug Fixes

• Notify items if an error occurs in bulk indexer (#615) (#1057) (00b0ac1)

API

• Updated APIs to 8.19.0

Typed API

• Update TypedAPI to latest elasticsearch-specification 8.19

• This patch release fixes the broken build found in 8.18.0. If you are using the TypedClient, you should update to this version.

• Update elastictransport to 8.7.0.
• Thanks to @zaneli, the TypedClient can now be used in the BulkIndexer.

New

• This release adds a BaseClient constructor with no attached APIs, allowing it to be used purely as a transport layer instead of a full-featured API client.

baseClient, err := elasticsearch.NewBaseClient(elasticsearch.Config{
    Addresses: []string{
        "http://localhost:9200",
    },
})

if err != nil {
    log.Println(err)
    return
}

res, err := esapi.InfoRequest{
    Pretty:     false,
    Human:      false,
    ErrorTrace: false,
    FilterPath: nil,
    Header:     nil,
    Instrument: baseClient.InstrumentationEnabled(),
}.Do(context.Background(), baseClient)

if err != nil {
    log.Println(err)
    return
}
defer res.Body.Close()
if res.IsError() {
    log.Println("Error response:", res)
    return
}
var infoMap map[string]interface{}
if err := json.NewDecoder(res.Body).Decode(&infoMap); err != nil {
    log.Println("Error parsing response:", err)
    return
}
log.Printf("Elasticsearch version esapi: %s\n", infoMap["version"].(map[string]interface{})["number"])

typedRes, err := info.New(baseClient).Do(context.Background())
if err != nil {
    log.Println(err)
    return
}
log.Printf("Elasticsearch version typedapi: %s\n", typedRes.Version.Int)

API

• Updated APIs to 8.18.0

Typed API

• Update APIs to 8.18.0 (f6a370d)

• Update elastictransport to 8.6.1 fixes #912

Thanks to @AkisAya and @jmfrees for their contributions!

• Expose BulkIndexer total flushed bytes metric #914 thanks to @aureleoules

API

Updated APIs to 8.17.0

Typed API

Update APIs to latest elasticsearch-specification 8.17

API

• InferenceStreamInference Documentation
• QueryRulesTest Documentation
• Ingest.DeleteIPLocationDatabase Documentation
• Ingest.GetIPLocationDatabase Documentation
• Ingest.PutIPLocationDatabase Documentation

Typed API

Update APIs to latest elasticsearch-specification 8.16

API

• API is generated from the Elasticsearch 8.15.0 specification.

Typed API

Update APIs to latest elasticsearch-specification 8.15

API

New APIs:

• ConnectorUpdateActiveFiltering Documentation
• ConnectorUpdateFilteringValidation Documentation
• TextStructureFindFieldStructure Documentation
• TextStructureFindMessageStructure Documentation

Typed API

New APIs:

• UpdateTrainedModelDeployment Documentation

Transport

• Fixed a deadlock in the connection pool https://github.com/elastic/elastic-transport-go/issues/20

Typed API

Update APIs to latest elasticsearch-specification 8.13

Fixes

This patch release brings a fix to the initialisation of the Request in endpoints which would prevent using the shortcuts for fields. Canonical.Request() method was unaffected.

• Autoscaling.PutAutoscalingPolicy
• Indices.Downsample
• Indices.PutSettings
• Indices.SimulateTemplate
• Inference.PutModel
• Logstash.PutPipeline
• Ml.ValidateDetector
• SearchApplication.Put

API

New APIS:

• ConnectorSecretGet

• ConnectorSecretPost

• ConnectorSecretPut

• ConnectorSecretDelete

• ConnectorUpdateIndexName

• ConnectorUpdateNative

• ConnectorUpdateStatus

• ConnectorUpdateAPIKeyDocumentID

• ConnectorUpdateServiceDocumentType

• EsqlAsyncQuery Documentation

• EsqlAsyncQueryGet Documentation

• ProfilingFlamegraph Documentation

• ProfilingStacktraces Documentation

• TextStructureTestGrokPattern Documentation

• Indices.ResolveCluster Documentation

• Security.QueryUser Documentation

Typed API

• indices.ResolveCluster Documentation
• textstructure.TestGrokPattern Documentation

Thanks to @pakio, transport now has an optional pool based compression option. https://github.com/elastic/elastic-transport-go/pull/19 And to @tblyler for fixing a very subtle memory leak in the BulkIndexer. #797

• Fix: ticker memory leak in bulk indexer due to internal flush call resetting the ticker. #797
• Fix: Scroll now uses the body to pass the scroll_id. #785
• Add: generated UnmarshalJSON for Requests to allow injecting payloads using aliases.

Many thanks to @tblyler, @frkntplglu and @HaraldNordgren for their contribution!

Client

Golang version

The client now requires Golang version 1.20

OpenTelemetry

The client now provides OpenTelemetry integration. This integration can be enabled in the config using the elasticsearch.NewOpenTelemetryInstrumentation. Once set up, the provided context will be used to record spans with useful information about the request being made to the server.

More about what you can expect in the Semantic Conventions for Elasticsearch.

BulkIndexer

if_seq_no & if_primary_term are now supported thanks to @benjyiw #783

API

• SimulateIngest
• ConnectorCheckIn
• ConnectorDelete
• ConnectorGet
• ConnectorLastSync
• ConnectorList
• ConnectorPost
• ConnectorPut
• ConnectorSyncJobCancel
• ConnectorSyncJobCheckIn
• ConnectorSyncJobDelete
• ConnectorSyncJobError
• ConnectorSyncJobGet
• ConnectorSyncJobList
• ConnectorSyncJobPost
• ConnectorSyncJobUpdateStats
• ConnectorUpdateConfiguration
• ConnectorUpdateError
• ConnectorUpdateFiltering
• ConnectorUpdateName
• ConnectorUpdatePipeline
• ConnectorUpdateScheduling

Typed API

• Esql.Query documentation
• Fleet.PostSecret
• Inference documentation
  • DeleteModel documentation
  • GetModel documentation
  • Inference documentation
  • PutModel documentation
• SearchApplication
  • GetSettings documentation
  • UpdateSettings documentation

Typed API

• Fix https://github.com/elastic/go-elasticsearch/issues/756 preventing from settings indices in indices.PutSettings

API

Experimental APIs

• EsqlQuery documentation
• InferenceDeleteModel documentation
• InferenceGetModel documentation
• InferenceInference documentation
• InferencePutModel documentation

Typed API

• Mandatory URL parameters are not exposed as functions anymore as they already exist in the constructor.

New Compatibility Policy

Starting from version 8.12.0, this library follow the Go language policy. Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.

If you have any questions or concerns, please do not hesitate to reach out to us.

Typed API

Update APIs to latest elasticsearch-specification 8.10

API

Experimental APIs for internal use

• FleetDeleteSecret
• FleetGetSecret
• FleetPostSecret

Exprimental APIs

QueryRulesetList

Stable APIs

Security.GetSettings Security.UpdateSettings

Typed API

Exprimental APIs

QueryRuleset.List

Technical Preview

• QueryRuleSet

Beta

• Synonyms

API

New API

• Cluster.Info Documentation

Experimental APIs

• QueryRulesetGet Documentation
• QueryRulesetDelete Documentation
• QueryRulesetPut Documentation
• SearchApplicationRenderQuery Documentation
• Security.CreateCrossClusterAPIKey Documentation
• Security.UpdateCrossClusterAPIKey Documentation

Typed API

• Propagated request fields towards the endpoint for ease of access, taking priority over same-name query string fields.
• Added a stub for Do methods on endpoints that only support a boolean response such as core.exists.
• NDJSON endpoints support with custom serialization like core.bulk.
• Link to endpoints documentation in API index to better display and ease of use.

fixes

• Fixed a deserialization issue for Property & Analyzer #696

Typed API

• Fixed deserialization for Suggest in search responses.
• Fixed double-quoted strings in deserialization for unions normalized as string. #684
• Fixed handling of core.Get response when the index did not exist. #678

API

New APIs

• Watcher.GetSettings Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-get-settings.html
• Watcher.UpdateSettings Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/watcher-api-update-settings.html

Experimental APIs

• ML.DeleteDataLifecycle Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-delete-lifecycle.html

• ML.ExplainDataLifecycle Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-explain-lifecycle.html

• ML.GetDataLifecycle Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-get-lifecycle.html

• ML.PutDataLifecycle Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/dlm-put-lifecycle.html

• SearchApplications https://www.elastic.co/guide/en/elasticsearch/reference/8.8/search-application-apis.html

Typed API

• This release include fixes for responses deserialization. #654 #655