honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/cat/indices.asciidoc

119 lines
3.9 KiB
Plaintext
Raw Normal View History

First pass at cat docs.
2013-11-14 20:14:39 -05:00
[[cat-indices]]
[DOCS] Renamed the "cat" chapters to be more searchable
2014-05-16 15:43:35 -04:00
== cat indices
First pass at cat docs.
2013-11-14 20:14:39 -05:00
The `indices` command provides a cross-section of each index. This
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
information *spans nodes*. For example:
First pass at cat docs.
2013-11-14 20:14:39 -05:00
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
[source,js]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
GET /_cat/indices/twi*?v&s=index
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
// CONSOLE
// TEST[setup:huge_twitter]
// TEST[s/^/PUT twitter2\n{"settings": {"number_of_replicas": 0}}\n/]
Might respond with:
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
[source,txt]
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
--------------------------------------------------
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size
yellow open twitter u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb
green open twitter2 nYFWZEO7TUiOjLQXBaYJpA 5 0 0 0 260b 260b
--------------------------------------------------
// TESTRESPONSE[s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/]
// TESTRESPONSE[s/u8FNjxh8Rfy_awN11oDKYQ|nYFWZEO7TUiOjLQXBaYJpA/.+/ _cat]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
We can tell quickly how many shards make up an index, the number of
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
docs at the Lucene level, including hidden docs (e.g., from nested types),
deleted docs, primary store size, and total store size (all shards including replicas).
Add some clarification regarding docs.count * Add some clarification regarding docs.count * Some improvements as suggested by @jasontedor
2016-04-07 05:15:32 -04:00
All these exposed metrics come directly from Lucene APIs.
First pass at cat docs.
2013-11-14 20:14:39 -05:00
[DOCS] Update cat/indices to reflect ?pri flag
2014-01-13 15:18:14 -05:00
[float]
[[pri-flag]]
=== Primaries
The index stats by default will show them for all of an index's
shards, including replicas. A `pri` flag can be supplied to enable
the view of relevant stats in the context of only the primaries.
First pass at cat docs.
2013-11-14 20:14:39 -05:00
[float]
[[examples]]
=== Examples
Which indices are yellow?
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
[source,js]
--------------------------------------------------
GET /_cat/indices?v&health=yellow
--------------------------------------------------
// CONSOLE
// TEST[continued]
Which looks like:
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
[source,txt]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size
yellow open twitter u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
// TESTRESPONSE[s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/]
// TESTRESPONSE[s/u8FNjxh8Rfy_awN11oDKYQ/.+/ _cat]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
Fix recurring doc test failures with the cat API. (#21561) This failure is due to the fact that we sort on store size, which is cached. So it might happen that the store size that is taken into account is not the right one, which makes the indices sorted in the wrong order. This changes the doc example to sort on the number of docs instead. Closes #21062
2016-11-15 10:00:44 -05:00
Which index has the largest number of documents?
First pass at cat docs.
2013-11-14 20:14:39 -05:00
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
[source,js]
--------------------------------------------------
Fix recurring doc test failures with the cat API. (#21561) This failure is due to the fact that we sort on store size, which is cached. So it might happen that the store size that is taken into account is not the right one, which makes the indices sorted in the wrong order. This changes the doc example to sort on the number of docs instead. Closes #21062
2016-11-15 10:00:44 -05:00
GET /_cat/indices?v&s=docs.count:desc
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
--------------------------------------------------
// CONSOLE
// TEST[continued]
Which looks like:
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
[source,txt]
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
--------------------------------------------------
health status index uuid pri rep docs.count docs.deleted store.size pri.store.size
yellow open twitter u8FNjxh8Rfy_awN11oDKYQ 1 1 1200 0 88.1kb 88.1kb
green open twitter2 nYFWZEO7TUiOjLQXBaYJpA 5 0 0 0 260b 260b
--------------------------------------------------
// TESTRESPONSE[s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/]
// TESTRESPONSE[s/u8FNjxh8Rfy_awN11oDKYQ|nYFWZEO7TUiOjLQXBaYJpA/.+/ _cat]
How many merge operations have the shards for the `twitter` completed?
[source,js]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
GET /_cat/indices/twitter?pri&v&h=health,index,pri,rep,docs.count,mt
[DOCS] Update cat/indices to reflect ?pri flag
2014-01-13 15:18:14 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
// CONSOLE
// TEST[continued]
[DOCS] Update cat/indices to reflect ?pri flag
2014-01-13 15:18:14 -05:00
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
Might look like:
[DOCS] Update cat/indices to reflect ?pri flag
2014-01-13 15:18:14 -05:00
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
[source,js]
[DOCS] Update cat/indices to reflect ?pri flag
2014-01-13 15:18:14 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
health index pri rep docs.count mt pri.mt
yellow twitter 1 1 1200 16 16
First pass at cat docs.
2013-11-14 20:14:39 -05:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
// TESTRESPONSE[s/16/\\d+/ _cat]
Admin: add total index memory in `_cat/indices` This patch adds to `_cat/indices` information about memory usage per index by adding memory used by FieldData, IdCache, Percolate, Segments (memory, index writer, version map). ``` % curl 'localhost:9200/_cat/indices?v&h=i,tm' i tm wiki 8.1gb test 30.5kb user 1.9mb ``` Closes #7008
2014-09-22 16:03:50 -04:00
How much memory is used per index?
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
[source,js]
--------------------------------------------------
GET /_cat/indices?v&h=i,tm&s=tm:desc
--------------------------------------------------
// CONSOLE
// TEST[continued]
Might look like:
[source,js]
Admin: add total index memory in `_cat/indices` This patch adds to `_cat/indices` information about memory usage per index by adding memory used by FieldData, IdCache, Percolate, Segments (memory, index writer, version map). ``` % curl 'localhost:9200/_cat/indices?v&h=i,tm' i tm wiki 8.1gb test 30.5kb user 1.9mb ``` Closes #7008
2014-09-22 16:03:50 -04:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
i tm
twitter 8.1gb
twitter2 30.5kb
Admin: add total index memory in `_cat/indices` This patch adds to `_cat/indices` information about memory usage per index by adding memory used by FieldData, IdCache, Percolate, Segments (memory, index writer, version map). ``` % curl 'localhost:9200/_cat/indices?v&h=i,tm' i tm wiki 8.1gb test 30.5kb user 1.9mb ``` Closes #7008
2014-09-22 16:03:50 -04:00
--------------------------------------------------
CONSOLEify _cat/indices docs Relates to #18160 Uses the new sorting (#20658) in the `_cat` API to support all use cases natively. We can still resort to piping things through `sort` if we need to, but we don't have to for basic stuff like sorting!
2016-10-11 08:46:59 -04:00
// TESTRESPONSE[s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/]
// TESTRESPONSE[_cat]