10 Commits

Author SHA1 Message Date
Alexander Reelsen
3b9ab5da04 Fix order of request body search parameter names in documentation ()
The order was random, which made it super hard to find anything. This
changes the order to be alphabetically.
2019-04-09 16:35:45 +02:00
Clinton Gormley
0170e0e8d3 Remove usage of multi-types from the docs and added a page explaining type removal ()
Closes 
2017-07-05 12:30:19 +02:00
Clinton Gormley
8ace37e214 Fix asciidoc in stored fields 2017-02-03 10:18:01 +01:00
Adrin Jalali
953928b2c5 typo fix (it self -> itself) ()
* typo fix.

* apply "stored field value"

* replaced "whereas" with "on the contrary"
2016-11-24 17:11:43 +01:00
Jim Ferenczi
1764ec56b3 Fixed naming inconsistency for fields/stored_fields in the APIs ()
This change replaces the fields parameter with stored_fields when it makes sense.
This is dictated by the renaming we made in  for the search API.

The following list of endpoint has been changed to use `stored_fields` instead of `fields`:
* get
* mget
* explain

The documentation and the rest API spec has been updated to cope with the changes for the following APIs:
* delete_by_query
* get
* mget
* explain

The `fields` parameter has been deprecated for the following APIs (it is replaced by _source filtering):
* update: the fields are extracted from the _source directly.
* bulk: the fields parameter is used but fields are extracted from the source directly so it is allowed to have non-stored fields.

Some APIs still have the `fields` parameter for various reasons:
* cat.fielddata: the fields paramaters relates to the fielddata fields that should be printed.
* indices.clear_cache: used to indicate which fielddata fields should be cleared.
* indices.get_field_mapping: used to filter fields in the mapping.
* indices.stats: get stats on fields (stored or not stored).
* termvectors: fields are retrieved from the stored fields if possible and extracted from the _source otherwise.
* mtermvectors:
* nodes.stats: the fields parameter is used to concatenate completion_fields and fielddata_fields so it's not related to stored_fields at all.

Fixes 
2016-09-13 20:54:41 +02:00
Jim Ferenczi
9bedbbaa6a Fixed doc links 2016-08-24 22:37:59 +02:00
Jim Ferenczi
4682fc34ae Add the ability to disable the retrieval of the stored fields entirely
This change adds a special field named _none_ that allows to disable the retrieval of the stored fields in a search request or in a TopHitsAggregation.

To completely disable stored fields retrieval (including disabling metadata fields retrieval such as _id or _type) use _none_ like this:

````
POST _search
{
   "stored_fields": "_none_"
}
````
2016-08-24 16:40:08 +02:00
Jim Ferenczi
afe99fcdcd Restore reverted change now that alpha4 is out:
Rename `fields` to `stored_fields` and add `docvalue_fields`

`stored_fields` parameter will no longer try to retrieve fields from the _source but will only return stored fields.
`fields` will throw an exception if the user uses it.
Add `docvalue_fields` as an adjunct to `fielddata_fields` which is deprecated. `docvalue_fields` will try to load the value from the docvalue and fallback to fielddata cache if docvalues are not enabled on that field.

Closes 
2016-07-04 10:39:49 +02:00
Jim Ferenczi
eb1e231a63 Revert "Rename fields to stored_fields and add docvalue_fields"
This reverts commit 2f46f53dc8feb78412e6d648751ffe97b1e35119.
2016-06-27 17:20:32 +02:00
Jim Ferenczi
2f46f53dc8 Rename fields to stored_fields and add docvalue_fields
`stored_fields` parameter will no longer try to retrieve fields from the _source but will only return stored fields.
`fields` will throw an exception if the user uses it.
Add `docvalue_fields` as an adjunct to `fielddata_fields` which is deprecated. `docvalue_fields` will try to load the value from the docvalue and fallback to fielddata cache if docvalues are not enabled on that field.

Closes 
2016-06-22 17:38:30 +02:00