OpenSearch/docs/reference/cat/fielddata.asciidoc

[[cat-fielddata]]
== cat fielddata

`fielddata` shows how much heap memory is currently being used by fielddata 
on every data node in the cluster.

[source,sh]
--------------------------------------------------
% curl '192.168.56.10:9200/_cat/fielddata?v'
id                     host    ip            node    field size
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body  159.8kb
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE text  225.7kb
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body  159.8kb
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA text  275.3kb
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body  109.2kb
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG text  175.3kb
--------------------------------------------------

Fields can be specified either as a query parameter, or in the URL path:

[source,sh]
--------------------------------------------------
% curl '192.168.56.10:9200/_cat/fielddata?v&fields=body'
id                     host    ip            node    field size
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body  159.8kb
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body  159.8kb
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body  109.2kb

% curl '192.168.56.10:9200/_cat/fielddata/body,text?v'
id                     host    ip            node    field size
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body  159.8kb
bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE text  225.7kb
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body  159.8kb
H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA text  275.3kb
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body  109.2kb
I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG text  175.3kb
--------------------------------------------------

The output shows the individual fielddata for the`body` and `text` fields, one row per field per node.
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00			`[[cat-fielddata]]`
[DOCS] Renamed the "cat" chapters to be more searchable 2014-05-16 15:43:35 -04:00			`== cat fielddata`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00
Filtered out non data-nodes in relevant cat api Closes #9214 Closes #9287 2015-02-06 01:31:17 -05:00			`fielddata` shows how much heap memory is currently being used by fielddata
			`on every data node in the cluster.`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00
Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting 2015-07-14 12:14:09 -04:00			`[source,sh]`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00			`--------------------------------------------------`
			`% curl '192.168.56.10:9200/_cat/fielddata?v'`
[DOC] Remove obsolete node names from documentation Funny node names have been removed in #19456 and replaced by UUID. This commit removes these obsolete node names and replace them by real UUIDs in the documentation. closes #20065 2016-09-16 08:32:03 -04:00			`id host ip node field size`
			`bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body 159.8kb`
			`bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE text 225.7kb`
			`H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body 159.8kb`
			`H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA text 275.3kb`
			`I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body 109.2kb`
			`I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG text 175.3kb`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00			`--------------------------------------------------`

			`Fields can be specified either as a query parameter, or in the URL path:`

Docs: Use "js" instead of "json" and "sh" instead of "shell" for source highlighting 2015-07-14 12:14:09 -04:00			`[source,sh]`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00			`--------------------------------------------------`
			`% curl '192.168.56.10:9200/_cat/fielddata?v&fields=body'`
[DOC] Remove obsolete node names from documentation Funny node names have been removed in #19456 and replaced by UUID. This commit removes these obsolete node names and replace them by real UUIDs in the documentation. closes #20065 2016-09-16 08:32:03 -04:00			`id host ip node field size`
			`bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body 159.8kb`
			`H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body 159.8kb`
			`I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body 109.2kb`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00
			`% curl '192.168.56.10:9200/_cat/fielddata/body,text?v'`
[DOC] Remove obsolete node names from documentation Funny node names have been removed in #19456 and replaced by UUID. This commit removes these obsolete node names and replace them by real UUIDs in the documentation. closes #20065 2016-09-16 08:32:03 -04:00			`id host ip node field size`
			`bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE body 159.8kb`
			`bGG90GEiSGeezlbrcugAYQ myhost1 10.20.100.200 bGG90GE text 225.7kb`
			`H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA body 159.8kb`
			`H5dfFeANQaCL6xC8VxjAwg myhost2 10.20.100.201 H5dfFeA text 275.3kb`
			`I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG body 109.2kb`
			`I8hydUG3R0q1AJ-HUEvkSQ myhost3 10.20.100.202 I8hydUG text 175.3kb`
Add /_cat/fielddata to display fielddata usage Closes #4593 2014-05-05 10:23:00 -04:00			`--------------------------------------------------`

Row-centric output for _cat/fielddata 2016-04-20 12:10:01 -04:00			The output shows the individual fielddata for the`body` and `text` fields, one row per field per node.