mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
a63f60b776
Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
97 lines
2.7 KiB
Plaintext
97 lines
2.7 KiB
Plaintext
[[cat-fielddata]]
|
|
=== cat fielddata
|
|
|
|
`fielddata` shows how much heap memory is currently being used by fielddata
|
|
on every data node in the cluster.
|
|
|
|
|
|
////
|
|
Hidden setup snippet to build an index with fielddata so our results are real:
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT test
|
|
{
|
|
"mappings": {
|
|
"properties": {
|
|
"body": {
|
|
"type": "text",
|
|
"fielddata":true
|
|
},
|
|
"soul": {
|
|
"type": "text",
|
|
"fielddata":true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
POST test/_doc?refresh
|
|
{
|
|
"body": "some words so there is a little field data",
|
|
"soul": "some more words"
|
|
}
|
|
|
|
# Perform a search to load the field data
|
|
POST test/_search?sort=body,soul
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
////
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cat/fielddata?v
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[continued]
|
|
|
|
Looks like:
|
|
|
|
[source,txt]
|
|
--------------------------------------------------
|
|
id host ip node field size
|
|
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b
|
|
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul 480b
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/544b|480b/\\d+(\\.\\d+)?[tgmk]?b/]
|
|
// TESTRESPONSE[s/Nqk-6in[^ ]*/.+/ s/soul|body/\\w+/ non_json]
|
|
|
|
Fields can be specified either as a query parameter, or in the URL path:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cat/fielddata?v&fields=body
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[continued]
|
|
|
|
Which looks like:
|
|
|
|
[source,txt]
|
|
--------------------------------------------------
|
|
id host ip node field size
|
|
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/544b|480b/\\d+(\\.\\d+)?[tgmk]?b/]
|
|
// TESTRESPONSE[s/Nqk-6in[^ ]*/.+/ non_json]
|
|
|
|
And it accepts a comma delimited list:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cat/fielddata/body,soul?v
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[continued]
|
|
|
|
Which produces the same output as the first snippet:
|
|
|
|
[source,txt]
|
|
--------------------------------------------------
|
|
id host ip node field size
|
|
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in body 544b
|
|
Nqk-6inXQq-OxUfOUI8jNQ 127.0.0.1 127.0.0.1 Nqk-6in soul 480b
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/544b|480b/\\d+(\\.\\d+)?[tgmk]?b/]
|
|
// TESTRESPONSE[s/Nqk-6in[^ ]*/.+/ s/soul|body/\\w+/ non_json]
|
|
|
|
The output shows the individual fielddata for the `body` and `soul` fields, one row per field per node.
|