Skip to content

Commit 95f6048

Browse files
committed
Add changelog for 8.4.0 release
1 parent 49e103a commit 95f6048

File tree

1 file changed

+43
-19
lines changed

1 file changed

+43
-19
lines changed

CHANGELOG.md

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
1+
# 8.4.0
2+
3+
## API
4+
5+
* `get`, `mget` and `search` added `force_synthetic_source`: Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
6+
* `ML.StartTrainedModelDeployment` added `cache_size`: A byte-size value for configuring the inference cache size. For example, 20mb.
7+
* `Snapshot.Get` added `sort`, `size`, `order`, `from_sort_value`, `after`, `offset` and `slm_policy_filter`. More on these in the [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.4/get-snapshot-api.html).
8+
9+
**New API**
10+
11+
* `Security.UpdateAPIKey` [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.4/security-api-update-api-key.html).
12+
13+
## Typed API
14+
15+
As highlighted in the release not for the 8.4.0-alpha.1, this release marks the beginning of the newly arrived `TypedClient`.
16+
17+
This new API is still in `alpha` stage and will be release alongside the existing `esapi`.
18+
19+
A few examples of standard use-cases can be found in the [TypedAPI section of the documentation](https://www.elastic.co/guide/en/elasticsearch/client/go-api/master/typedapi.html).
20+
21+
# 8.4.0-alpha.2
22+
23+
This second prerelease of the 8.4.0 updates the API for the client and fixes the serialization for types using [additional properties](https://github.com/elastic/elasticsearch-specification/blob/main/docs/behaviors.md#additionalproperties--additionalproperty).
24+
125
# 8.4.0-alpha.1
226

3-
This prerelease introduces a new typed API generated from the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification). This generation from the common specification allows us to provide a complete API which uses an exhaustive hierarchy of types reflecting the possibilities given by Elasticsearch.
27+
This prerelease introduces a new typed API generated from the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification). This generation from the common specification allows us to provide a complete API which uses an exhaustive hierarchy of types reflecting the possibilities given by Elasticsearch.
428

529
This new API is the next iteration of the Go client for Elasticsearch, it now lives alongside the existing API, it is in `alpha` state and will gain features over time and releases.
630

@@ -11,19 +35,19 @@ The `TypedClient` is built around a fluent builder for easier request creation a
1135
As a first example, here is a search request:
1236
```go
1337
cfg := elasticsearch.Config{
14-
// Define your configuration
38+
// Define your configuration
1539
}
1640
es, _ := elasticsearch.NewTypedClient(cfg)
1741
res, err := es.Search().
18-
Index("index_name").
19-
Request(&search.Request{
20-
Query: &types.QueryContainer{
21-
Match: map[types.Field]types.MatchQuery{
22-
"name": {Query: "Foo"},
23-
},
24-
},
25-
},
26-
).Do(context.Background())
42+
Index("index_name").
43+
Request(&search.Request{
44+
Query: &types.QueryContainer{
45+
Match: map[types.Field]types.MatchQuery{
46+
"name": {Query: "Foo"},
47+
},
48+
},
49+
},
50+
).Do(context.Background())
2751
```
2852

2953
The `Request` uses the structures found in the `typedapi/types` package which will lead you along the possibilities. A builder for each structure that allows easier access and declaration is also provided.
@@ -64,7 +88,7 @@ Feedback is very welcome, play with it, use it, let us know what you think!
6488
## Client
6589

6690
* Fixed a serialisation error for `retry_on_conflict` in the BulkIndexer. Thanks to @lpflpf for the help!
67-
* Fixed a concurrent map error in the BulkIndexer when custom headers are applied. Thanks to @chzhuo for the contribution!
91+
* Fixed a concurrent map error in the BulkIndexer when custom headers are applied. Thanks to @chzhuo for the contribution!
6892

6993
## API
7094

@@ -83,11 +107,11 @@ Feedback is very welcome, play with it, use it, let us know what you think!
83107
# 8.1.0
84108
## API
85109

86-
* API is generated from the Elasticsearch 8.1.0 specification.
110+
* API is generated from the Elasticsearch 8.1.0 specification.
87111

88112
**New parameters**
89113

90-
* `WithWaitForCompletion` for `Indices.Forcemerge`
114+
* `WithWaitForCompletion` for `Indices.Forcemerge`
91115
* `WithFeatures` for `Indices.Get`
92116
* `WithForce` for `ML.DeleteTrainedModel`
93117

@@ -99,14 +123,14 @@ Feedback is very welcome, play with it, use it, let us know what you think!
99123
# 8.0.0
100124
## Client
101125

102-
* The client now uses `elastic-transport-go` dependency which lives in its [own repository](https://github.com/elastic/elastic-transport-go/).
103-
* With the knewly extracted transport, the `retryOnTimeout` has been replaced with a `retryOnError` callback. This allows to select more finely which error should be retried by the client.
104-
* `BulkIndexerItem` `Body` field is now an `io.ReadSeeker` allowing reread without increasing memory consumption.
105-
* `BulkIndexerItem` know correctly uses the `routing` property instead of the deprecated `_routing`.
126+
* The client now uses `elastic-transport-go` dependency which lives in its [own repository](https://github.com/elastic/elastic-transport-go/).
127+
* With the knewly extracted transport, the `retryOnTimeout` has been replaced with a `retryOnError` callback. This allows to select more finely which error should be retried by the client.
128+
* `BulkIndexerItem` `Body` field is now an `io.ReadSeeker` allowing reread without increasing memory consumption.
129+
* `BulkIndexerItem` know correctly uses the `routing` property instead of the deprecated `_routing`.
106130

107131
## API
108132

109-
* API is generated from the Elasticsearch 8.0.0 specification.
133+
* API is generated from the Elasticsearch 8.0.0 specification.
110134

111135

112136

0 commit comments

Comments
 (0)