honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/painless/painless-contexts/painless-reindex-context.as...

69 lines
2.1 KiB
Plaintext
Raw Normal View History

Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
[[painless-reindex-context]]
=== Reindex context
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
Use a Painless script in a {ref}/docs-reindex.html[reindex] operation to
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
add, modify, or delete fields within each document in an original index as its
reindexed into a target index.
*Variables*
`params` (`Map`, read-only)::
User-defined parameters passed in as part of the query.
[DOCS] Fixed typos (_op => op) in Painless context docs (#50301)
2020-01-08 11:50:03 -05:00
`ctx['op']` (`String`)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The name of the operation.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-routing-field.html[`ctx['_routing']`] (`String`)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The value used to select a shard for document storage.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-index-field.html[`ctx['_index']`] (`String`)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The name of the index.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-type-field.html[`ctx['_type']`] (`String`)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The type of document within an index.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-id-field.html[`ctx['_id']`] (`int`, read-only)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The unique document id.
`ctx['_version']` (`int`)::
The current version of the document.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-source-field.html[`ctx['_source']`] (`Map`)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Contains extracted JSON in a `Map` and `List` structure for the fields
existing in a stored document.
*Side Effects*
[DOCS] Fixed typos (_op => op) in Painless context docs (#50301)
2020-01-08 11:50:03 -05:00
`ctx['op']`::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Use the default of `index` to update a document. Set to `none` to
specify no operation or `delete` to delete the current document from
the index.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-routing-field.html[`ctx['_routing']`]::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Modify this to change the routing value for the current document.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-index-field.html[`ctx['_index']`]::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Modify this to change the destination index for the current document.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-type-field.html[`ctx['_type']`]::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Modify this to change the type for the current document.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-id-field.html[`ctx['_id']`]::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Modify this to change the id for the current document.
`ctx['_version']` (`int`)::
Modify this to modify the version for the current document.
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{ref}/mapping-source-field.html[`ctx['_source']`]::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
Modify the values in the `Map/List` structure to add, modify, or delete
the fields of a document.
*Return*
`void`::
No expected return value.
*API*
[DOCS] Fixed typos (_op => op) in Painless context docs (#50301)
2020-01-08 11:50:03 -05:00
The standard <<painless-api-reference, Painless API>> is available.