Add CPS note to Painless execute API index parameter#144895
Open
marciw wants to merge 3 commits intoelastic:mainfrom
Open
Add CPS note to Painless execute API index parameter#144895marciw wants to merge 3 commits intoelastic:mainfrom
marciw wants to merge 3 commits intoelastic:mainfrom
Conversation
2 tasks
elasticsearchmachine
added
the
needs:triage
marciw
added
Team:Docs
Collaborator
|
Pinging @elastic/core-docs (Team:Docs) |
marciw
added
>docs
Collaborator
|
Pinging @elastic/developer-docs (:Docs/Dev) |
marciw
requested review from
naj-h,
pawankartik-elastic,
quux00,
shainaraskas and
szabosteve
marciw
added
:Docs/Admin
Collaborator
|
Pinging @elastic/admin-docs (:Docs/Admin) |
shainaraskas
approved these changes
Mar 25, 2026
|
|
||
| `index` | ||
| : (Required, string) Index containing a mapping that’s compatible with the indexed document. You may specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to execute the painless script against the "my_index" index on the "remote1" cluster. This request will be forwarded to the "remote1" cluster if you have [configured a connection](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md) to that remote cluster. | ||
| : (Required, string) Index containing a mapping that’s compatible with the indexed document. You can specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to execute the painless script against the "my_index" index on the "remote1" cluster. This request will be forwarded to the "remote1" cluster if you have [configured a connection](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md) to that remote cluster. |
Contributor
There was a problem hiding this comment.
can you qualify this so the whole thing applies to cps and ccs, or split this so this paragraph is more clearly about CCS?
dedicated paragraphs
Suggested change
| : (Required, string) Index containing a mapping that’s compatible with the indexed document. You can specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to execute the painless script against the "my_index" index on the "remote1" cluster. This request will be forwarded to the "remote1" cluster if you have [configured a connection](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md) to that remote cluster. | |
| : (Required, string) Index containing a mapping that’s compatible with the indexed document. | |
| {applies_to}`stack: ga` When using {{ccs}}, you can specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to execute the painless script against the "my_index" index on the "remote1" cluster or project. This request will be forwarded to the "remote1" cluster if you have [configured a connection](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md) to that remote cluster. |
mixy guy
Suggested change
| : (Required, string) Index containing a mapping that’s compatible with the indexed document. You can specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to execute the painless script against the "my_index" index on the "remote1" cluster. This request will be forwarded to the "remote1" cluster if you have [configured a connection](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md) to that remote cluster. | |
| : (Required, string) Index containing a mapping that’s compatible with the indexed document. When using {{ccs}} or {{cps}}, you can specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to execute the painless script against the "my_index" index on the "remote1" cluster or project. This request will be forwarded to the "remote1" cluster or project if you have configured a connection to that remote cluster, or linked the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to the docs-content PR documenting Painless execute behavior with cross-project search
Screenshot of updated doc (previews are temporarily unavailable):
Details
current page: https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples#properties-of-script
addition:
