Commit Graph

38 Commits

Author SHA1 Message Date
Henning Andersen dea935ac31
Reindex max_docs parameter name ()
Previously, a reindex request had two different size specifications in the body:
* Outer level, determining the maximum documents to process
* Inside the source element, determining the scroll/batch size.

The outer level size has now been renamed to max_docs to
avoid confusion and clarify its semantics, with backwards compatibility and
deprecation warnings for using size.
Similarly, the size parameter has been renamed to max_docs for
update/delete-by-query to keep the 3 interfaces consistent.

Finally, all 3 endpoints now support max_docs in both body and URL.

Relates 
2019-06-07 12:16:36 +02:00
Boaz Leskes 033ba725af
Remove support for internal versioning for concurrency control ()
Elasticsearch has long [supported](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#index-versioning) compare and set (a.k.a optimistic concurrency control) operations using internal document versioning. Sadly that approach is flawed and can sometime do the wrong thing. Here's the relevant excerpt from the resiliency status page:

> When a primary has been partitioned away from the cluster there is a short period of time until it detects this. During that time it will continue indexing writes locally, thereby updating document versions. When it tries to replicate the operation, however, it will discover that it is partitioned away. It won’t acknowledge the write and will wait until the partition is resolved to negotiate with the master on how to proceed. The master will decide to either fail any replicas which failed to index the operations on the primary or tell the primary that it has to step down because a new primary has been chosen in the meantime. Since the old primary has already written documents, clients may already have read from the old primary before it shuts itself down. The version numbers of these reads may not be unique if the new primary has already accepted writes for the same document 

We recently [introduced](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/optimistic-concurrency-control.html) a new sequence number based approach that doesn't suffer from this dirty reads problem. 

This commit removes support for internal versioning as a concurrency control mechanism in favor of the sequence number approach.

Relates to 
2019-02-05 20:53:35 +01:00
markharwood 434430506b
Type removal - added deprecation warnings to _bulk apis ()
Added warnings checks to existing tests
Added “defaultTypeIfNull” to DocWriteRequest interface so that Bulk requests can override a null choice of document type with any global custom choice.
Related to 
2019-01-10 21:35:19 +00:00
Josh Soref edb48321ba [DOCS] Various spelling corrections () 2019-01-07 14:44:12 +01:00
Mayya Sharipova f884b2b1cd
Deprecate types in index API ()
* Deprecate types in index API

- deprecate type-based constructors of IndexRequest
- update tests to use typeless IndexRequest constructors
- no yaml tests as they have been already added in 

Relates to 
2018-12-18 08:53:49 -05:00
Julie Tibshirani ccd1beb9b3
Deprecate types in update requests. ()
The following updates were made:
* Add deprecation warnings to `RestUpdateAction`, plus a test in `RestUpdateActionTests`.
* Deprecate relevant methods on the Java HLRC requests/ responses.
* Add HLRC integration tests for the typed APIs.
* Update documentation (for both the REST API and Java HLRC).
* Fix failing integration tests.

Because of an earlier PR, the REST yml tests were already updated (one version without types, and another legacy version that retains types).
2018-12-14 10:47:27 -08:00
Mayya Sharipova d40037c91e
Deprecate uses of _type as a field name in queries () 2018-12-12 21:21:53 -05:00
Julie Tibshirani 99f89cd3b4
Deprecate types in get, exists, and multi get. ()
For each API, the following updates were made:
- Add deprecation warnings to `Rest*Action`, plus tests in `Rest*ActionTests`.
- For each REST yml test, make sure there is one version without types, and another legacy version that retains types (called *_with_types.yml).
- Deprecate relevant methods on the Java HLRC requests/ responses.
- Update documentation (for both the REST API and Java HLRC).
2018-12-10 17:22:48 -08:00
Julie Tibshirani 3f3cde41d3
Deprecate types in termvector and mtermvector requests. ()
* Add deprecation warnings to `Rest*TermVectorsAction`, plus tests in `Rest*TermVectorsActionTests`.
* Deprecate relevant methods on the Java HLRC requests/ responses.
* Update documentation (for both the REST API and Java HLRC).
* For each REST yml test, create one version without types, and another legacy version that retains types (called *_with_types.yml).
2018-12-06 10:23:15 -08:00
Julie Tibshirani 0e1ddfd825
Deprecate types in document delete requests. ()
* Make sure to use _doc as a type name in the CRUD HLRC tests.
* Deprecate types in document delete requests.
2018-11-30 15:11:29 -08:00
Mayya Sharipova aaeb47d1f7
HLRC for _mtermvectors ()
relates to 
2018-11-19 12:24:31 -05:00
Przemyslaw Gomulka c6e2634bf8
Docs: HLRC: refactor bulk, migrate and reindex apis ()
fix typos and refactor to DRY up documentation for bulk, reindex and migration apis
relates 
2018-11-16 08:58:13 +01:00
Mayya Sharipova a2c22ad7ae
Small corrections to HLRC doc for _termvectors ()
Relates to 
2018-11-04 18:29:07 -05:00
Przemyslaw Gomulka 995bf0ee66
Bulk Api support for global parameters ()
Bulk Request in High level rest client should be consistent with what is
possible in Rest API, therefore should support global parameters. Global
parameters are passed in URL in Rest API.

Some parameters are mandatory - index, type - and would fail validation
if not provided before before the bulk is executed.
Optional parameters - routing, pipeline.

The usage of these should be consistent across sync/async execution,
bulk processor and BulkRequestBuilder

closes 
2018-10-30 09:08:12 +01:00
Nik Everett 6fd7ea71f1
HLRC: DRY up remaining CRUD docs ()
This further applies the pattern set in  to reduce copy-and-paste
in the multi-document CRUD portion of the High Level REST Client docs.
It also adds line wraps to snippets that are too wide to fit into the box
when rendered in the docs, following up on the work started in .
2018-10-29 10:32:17 -04:00
markharwood 3181083781
HLRC - add support for source exists API ()
HLRC - add support for source exists API
API re-uses the GetRequest object (following the precedent set by the plain “exists” api).

Relates to 
2018-10-26 14:21:35 +01:00
Mayya Sharipova d7afd7c123 Reduce the number of callouts to 15 in docs
relates to 
2018-10-24 17:57:35 -04:00
Mayya Sharipova 3211760e2c Correct term-vectors.asciidoc
relates to 
2018-10-24 16:35:20 -04:00
Mayya Sharipova bf4d90a5dc
HLRC API for _termvectors ()
* HLRC API for _termvectors

relates to 
2018-10-24 14:27:22 -04:00
Yannick Welsch 9fb2f7cc20
HLRC: Delete role API ()
Adds the "Delete role" API to the high-level REST client.
2018-10-20 12:11:36 +02:00
lipsill 9b5eaafc24 HLRC: Documentation examples cleanup ()
* Replace deprecated field `code` with `source` for stored scripts ()
* Replace examples using the deprecated endpoint `{index}/{type}/_search`
with `{index}/_search` ()
* Use a system property to avoid deprecation warnings after the Update
Scripts have been moved to their own context ()
2018-10-16 10:46:14 -04:00
Nik Everett a9fa5f2b33
Docs: DRY up CRUD docs ()
This further applies the pattern set in  to reduce copy-and-paste
in the single document CRUD portion of the High Level REST Client docs.
It also adds line wraps to snippets that are too wide to fit into the box
when rendered in the docs, following up on the work started in .
2018-10-05 11:41:03 -04:00
Christoph Büscher a1c441f78a
HLRC: Add throttling for update & delete-by-query ()
This change adds throttling to the update-by-query and delete-by-query cases
similar to throttling for reindex. This mostly means additional methods on the
client class itself, since the request hits the same RestHandler, just with
slightly different endpoints, and also the return values are similar.
2018-10-02 21:44:15 +02:00
Nik Everett 8082b4ad4a
Docs: DRY up HLRC index docs ()
Use tricks pioneered in  to shorted asciidoc for the index API's
docs. Also slightly shorten the supported-api docs file.
2018-10-01 09:59:36 -04:00
Christoph Büscher 77145bb477
HLRC: Add support for reindex rethrottling ()
This change adds support for rethrottling reindex requests to the
RestHighLevelClient.
2018-09-20 18:56:12 +02:00
Sohaib Iftikhar 761e8c461f HLRC: Add delete by query API ()
Adds the delete-by-query API to the High Level REST Client.
2018-09-04 08:56:26 -04:00
Sohaib Iftikhar 389bf67275 HLREST: add update by query API ()
Adds update by query to the high level rest client.
2018-09-02 15:15:00 -04:00
Sohaib Iftikhar 7f5e29ddb2 HLREST: add reindex API ()
Adds the reindex API to the high level REST client.
2018-08-28 13:02:23 -04:00
Nik Everett 0a21533097 Docs: Fix callouts after _parent removed
Fix the callouts in the docs for the high level rest client after
_parent support was removed.
2018-04-11 12:56:13 -04:00
Adrien Grand 4918924fae
Remove legacy mapping code. ()
Some features have been deprecated since `6.0` like the `_parent` field or the
ability to have multiple types per index. This allows to remove quite some
code, which in-turn will hopefully make it easier to proceed with the removal
of types.
2018-04-11 09:41:37 +02:00
Nik Everett 2f21dc7129
Docs: HighLevelRestClient#multiGet ()
Add documentation for HighLevelRestClient#multiGet.

Relates to .
2018-03-16 18:52:34 -04:00
Nik Everett cf60e93a21
Docs: HighLevelRestClient#exists ()
Docs: HighLevelRestClient#exists

Add documentation for `HighLevelRestClient#exists`.

Relates to 
2018-03-15 12:10:30 -04:00
Luca Cavanna 075fdc579f
[DOCS] Update APIs grouping and ordering in REST high-level Client docs ()
With this new structure supported APIs are ordered and grouped in the same way as they are in the Elasticsearch reference docs
2018-02-02 17:19:50 +01:00
Luca Cavanna 99fef2490a [DOCS] add docs for REST high level client index method ()
This commit restructures the existing high level client docs, adapts the existing delete method docs and adds docs for the index method.
2017-07-03 10:48:16 +02:00
Nik Everett 23b8b97275 Use include-tagged macro for high level client docs ()
This should make it simpler to include example snippets from
tests.
2017-03-20 14:50:19 -04:00
David Pilato ee4a17a0e2 Adapt per Nik's comments 2017-03-01 11:51:06 +01:00
David Pilato c373ed102f Extract documentation from test code 2017-02-24 17:38:18 +01:00
David Pilato 60661ec9cc Add first High level client documentation
The REST Client is split into 2 parts:

* Low level
* High level

The High level client has a main common section and the document delete API documentation as a start.
2017-02-24 13:52:36 +01:00