mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
[DOCS] Reorder index APIs alphabetically (#46981)
This commit is contained in:
parent
650c0c695e
commit
7583c07fa8
13 changed files with 86 additions and 71 deletions
|
@ -5,12 +5,12 @@
|
||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Indices Exists API
|
=== Index Exists API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Indices Exists Request
|
==== Index Exists Request
|
||||||
|
|
||||||
The high-level REST client uses a +{request}+ for Indices Exists API. The index name (or indices' names) are required.
|
The high-level REST client uses a +{request}+ for Index Exists API. The index name (or indices' names) are required.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -20,7 +20,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
|
|
||||||
[[java-rest-high-indices-exists-optional-args]]
|
[[java-rest-high-indices-exists-optional-args]]
|
||||||
==== Optional arguments
|
==== Optional arguments
|
||||||
Indices Exists API also accepts following optional arguments, through a +{request}+:
|
Index exists API also accepts following optional arguments, through a +{request}+:
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Returns information about ongoing and completed index shard recoveries, similar
|
Returns information about ongoing and completed index shard recoveries, similar
|
||||||
to the <<indices-recovery, indices recovery>> API.
|
to the <<indices-recovery, index recovery>> API.
|
||||||
|
|
||||||
|
|
||||||
[[cat-recovery-api-request]]
|
[[cat-recovery-api-request]]
|
||||||
|
@ -21,7 +21,7 @@ to the <<indices-recovery, indices recovery>> API.
|
||||||
|
|
||||||
The cat recovery API returns information about index shard recoveries, both
|
The cat recovery API returns information about index shard recoveries, both
|
||||||
ongoing and completed. It is a more compact view of the JSON
|
ongoing and completed. It is a more compact view of the JSON
|
||||||
<<indices-recovery,indices recovery>> API.
|
<<indices-recovery,index recovery>> API.
|
||||||
|
|
||||||
A recovery event occurs anytime an index shard moves to a different node in the
|
A recovery event occurs anytime an index shard moves to a different node in the
|
||||||
cluster. This can happen during a snapshot recovery, a change in replication
|
cluster. This can happen during a snapshot recovery, a change in replication
|
||||||
|
|
|
@ -71,75 +71,75 @@ index settings, aliases, mappings, and index templates.
|
||||||
* <<indices-synced-flush-api>>
|
* <<indices-synced-flush-api>>
|
||||||
* <<indices-forcemerge>>
|
* <<indices-forcemerge>>
|
||||||
|
|
||||||
|
|
||||||
|
include::indices/add-alias.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/analyze.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/clearcache.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/clone-index.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/close.asciidoc[]
|
||||||
|
|
||||||
include::indices/create-index.asciidoc[]
|
include::indices/create-index.asciidoc[]
|
||||||
|
|
||||||
include::indices/delete-index.asciidoc[]
|
include::indices/delete-index.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/delete-alias.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/delete-index-template.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/flush.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/forcemerge.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/apis/freeze.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/get-field-mapping.asciidoc[]
|
||||||
|
|
||||||
include::indices/get-index.asciidoc[]
|
include::indices/get-index.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/get-alias.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/get-settings.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/get-index-template.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/get-mapping.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/alias-exists.asciidoc[]
|
||||||
|
|
||||||
include::indices/indices-exists.asciidoc[]
|
include::indices/indices-exists.asciidoc[]
|
||||||
|
|
||||||
include::indices/close.asciidoc[]
|
include::indices/recovery.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/segments.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/shard-stores.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/stats.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/template-exists.asciidoc[]
|
||||||
|
|
||||||
include::indices/open-close.asciidoc[]
|
include::indices/open-close.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/templates.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/put-mapping.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/refresh.asciidoc[]
|
||||||
|
|
||||||
|
include::indices/rollover-index.asciidoc[]
|
||||||
|
|
||||||
include::indices/shrink-index.asciidoc[]
|
include::indices/shrink-index.asciidoc[]
|
||||||
|
|
||||||
include::indices/split-index.asciidoc[]
|
include::indices/split-index.asciidoc[]
|
||||||
|
|
||||||
include::indices/clone-index.asciidoc[]
|
include::indices/synced-flush.asciidoc[]
|
||||||
|
|
||||||
include::indices/rollover-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/apis/freeze.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/apis/unfreeze.asciidoc[]
|
include::indices/apis/unfreeze.asciidoc[]
|
||||||
|
|
||||||
include::indices/put-mapping.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-mapping.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-field-mapping.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/add-alias.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-alias.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-alias.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/alias-exists.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/aliases.asciidoc[]
|
include::indices/aliases.asciidoc[]
|
||||||
|
|
||||||
include::indices/update-settings.asciidoc[]
|
include::indices/update-settings.asciidoc[]
|
||||||
|
|
||||||
include::indices/get-settings.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/analyze.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/templates.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-index-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-index-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/template-exists.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/stats.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/segments.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/recovery.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/shard-stores.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/clearcache.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/flush.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/synced-flush.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/refresh.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/forcemerge.asciidoc[]
|
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[indices-clearcache]]
|
[[indices-clearcache]]
|
||||||
=== Clear Cache
|
=== Clear cache API
|
||||||
|
++++
|
||||||
|
<titleabbrev>Clear cache</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The clear cache API allows to clear either all caches or specific cached
|
The clear cache API allows to clear either all caches or specific cached
|
||||||
associated with one or more indices.
|
associated with one or more indices.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-delete-template]]
|
[[indices-delete-template]]
|
||||||
=== Delete index template API
|
=== Delete index template API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Delete template index</titleabbrev>
|
<titleabbrev>Delete index template</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Deletes an existing index.
|
Deletes an existing index.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-get-template]]
|
[[indices-get-template]]
|
||||||
=== Get index template API
|
=== Get index template API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Get template index</titleabbrev>
|
<titleabbrev>Get index template</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Returns information about one or more index templates.
|
Returns information about one or more index templates.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-exists]]
|
[[indices-exists]]
|
||||||
=== Indices exists API
|
=== Index exists API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Indices exists</titleabbrev>
|
<titleabbrev>Index exists</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Checks if an index exists.
|
Checks if an index exists.
|
||||||
|
|
|
@ -1,7 +1,10 @@
|
||||||
[[indices-recovery]]
|
[[indices-recovery]]
|
||||||
=== Indices Recovery
|
=== Index recovery API
|
||||||
|
++++
|
||||||
|
<titleabbrev>Index recovery</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The indices recovery API provides insight into on-going index shard recoveries.
|
The index recovery API provides insight into on-going index shard recoveries.
|
||||||
Recovery status may be reported for specific indices, or cluster-wide.
|
Recovery status may be reported for specific indices, or cluster-wide.
|
||||||
|
|
||||||
For example, the following command would show recovery information for the indices "index1" and "index2".
|
For example, the following command would show recovery information for the indices "index1" and "index2".
|
||||||
|
@ -18,7 +21,7 @@ To see cluster-wide recovery status simply leave out the index names.
|
||||||
|
|
||||||
Here we create a repository and snapshot index1 in
|
Here we create a repository and snapshot index1 in
|
||||||
order to restore it right after and prints out the
|
order to restore it right after and prints out the
|
||||||
indices recovery result.
|
index recovery result.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[indices-shards-stores]]
|
[[indices-shards-stores]]
|
||||||
=== Indices Shard Stores
|
=== Index shard stores API
|
||||||
|
++++
|
||||||
|
<titleabbrev>Index shard stores</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
Provides store information for shard copies of indices.
|
Provides store information for shard copies of indices.
|
||||||
Store information reports on which nodes shard copies exist, the shard
|
Store information reports on which nodes shard copies exist, the shard
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[indices-shrink-index]]
|
[[indices-shrink-index]]
|
||||||
=== Shrink Index
|
=== Shrink index API
|
||||||
|
++++
|
||||||
|
<titleabbrev>Shrink index</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The shrink index API allows you to shrink an existing index into a new index
|
The shrink index API allows you to shrink an existing index into a new index
|
||||||
with fewer primary shards. The requested number of primary shards in the target index
|
with fewer primary shards. The requested number of primary shards in the target index
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
[[indices-split-index]]
|
[[indices-split-index]]
|
||||||
=== Split Index
|
=== Split index API
|
||||||
|
++++
|
||||||
|
<titleabbrev>Split index</titleabbrev>
|
||||||
|
++++
|
||||||
|
|
||||||
The split index API allows you to split an existing index into a new index,
|
The split index API allows you to split an existing index into a new index,
|
||||||
where each original primary shard is split into two or more primary shards in
|
where each original primary shard is split into two or more primary shards in
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[[recovery]]
|
[[recovery]]
|
||||||
=== Indices Recovery
|
=== Index recovery
|
||||||
|
|
||||||
Peer recovery syncs data from a primary shard to a new or
|
Peer recovery syncs data from a primary shard to a new or
|
||||||
existing shard copy.
|
existing shard copy.
|
||||||
|
|
|
@ -773,7 +773,7 @@ creates the required number of replicas at this moment cluster switches to the `
|
||||||
are created, the cluster switches to the `green` states.
|
are created, the cluster switches to the `green` states.
|
||||||
|
|
||||||
The cluster health operation provides only a high level status of the restore process. It's possible to get more
|
The cluster health operation provides only a high level status of the restore process. It's possible to get more
|
||||||
detailed insight into the current state of the recovery process by using <<indices-recovery, indices recovery>> and
|
detailed insight into the current state of the recovery process by using <<indices-recovery, index recovery>> and
|
||||||
<<cat-recovery, cat recovery>> APIs.
|
<<cat-recovery, cat recovery>> APIs.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue