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

46 lines
1.3 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[indices-get-settings]]
[DOCS] Remove heading offsets for REST APIs (#44568) 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.
2019-07-19 14:35:36 -04:00
=== Get Settings
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
The get settings API allows to retrieve settings of index/indices:
[source,js]
--------------------------------------------------
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160
2016-09-01 13:05:22 -04:00
GET /twitter/_settings
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
--------------------------------------------------
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160
2016-09-01 13:05:22 -04:00
// CONSOLE
// TEST[setup:twitter]
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
[float]
[DOCS] Remove heading offsets for REST APIs (#44568) 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.
2019-07-19 14:35:36 -04:00
==== Multiple Indices and Types
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
The get settings API can be used to get settings for more than one index
with a single call. General usage of the API follows the
following syntax: `host:port/{index}/_settings` where
`{index}` can stand for comma-separated list of index names and aliases. To
get settings for all indices you can use `_all` for `{index}`.
Wildcard expressions are also supported. The following are some examples:
[source,js]
--------------------------------------------------
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160
2016-09-01 13:05:22 -04:00
GET /twitter,kimchy/_settings
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160
2016-09-01 13:05:22 -04:00
GET /_all/_settings
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160
2016-09-01 13:05:22 -04:00
GET /log_2013_*/_settings
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
--------------------------------------------------
Add CONSOLE to a few snippets in reference docs This allows them to be run in Console and adds them to the list of docs that are automatically tested as part of the build. Relates to #18160
2016-09-01 13:05:22 -04:00
// CONSOLE
// TEST[setup:twitter]
// TEST[s/^/PUT kimchy\nPUT log_2013_01_01\n/]
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
[float]
[DOCS] Remove heading offsets for REST APIs (#44568) 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.
2019-07-19 14:35:36 -04:00
==== Filtering settings by name
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
Update get-settings.asciidoc Fixed docs for filtering index settings in get-settings API Closes #13872
2015-10-02 10:43:53 -04:00
The settings that are returned can be filtered with wildcard matching
as follows:
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
[source,js]
--------------------------------------------------
CONSOLEify some more Indices APIs (#24375) * CONSOLEify doc testing for some more Indices APIs Related to #18160
2017-05-01 13:56:39 -04:00
GET /log_2013_-*/_settings/index.number_*
Changed get index settings api to use new internal get index settings api instead of relying on the cluster state api. The new internal get index settings api is more efficient when it comes to sending the index settings from the master to the client via the Also the get index settings support now all the indices options. Closes #4620
2014-01-05 17:06:02 -05:00
--------------------------------------------------
CONSOLEify some more Indices APIs (#24375) * CONSOLEify doc testing for some more Indices APIs Related to #18160
2017-05-01 13:56:39 -04:00
// CONSOLE
// TEST[continued]