Skip to content

Conversation

consulthys
Copy link
Contributor

Fixes #119919

This PR amends the verbiage used around stored scripts:

  • compilation time of stored script is not reduced in comparison to inline scripts
  • stored scripts do not necessarily run faster than inline scripts
  • stored scripts facilitate collaboration and allow different people to focus on their own part (script vs query)

The changes are done in two different places

@consulthys consulthys added >docs General docs changes :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache backport Team:Docs Meta label for docs team labels Jan 10, 2025
@consulthys consulthys self-assigned this Jan 10, 2025
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

@consulthys please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine elasticsearchmachine added the external-contributor Pull request authored by a developer outside the Elasticsearch team label Jan 10, 2025
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a couple of rewording suggestions, let me know what you think.

@leemthompo leemthompo added the auto-backport Automatically create backport pull requests when merged label Jan 10, 2025
@consulthys
Copy link
Contributor Author

Thank you @leemthompo looks great to me 👍

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the docs!

@consulthys consulthys enabled auto-merge (squash) January 10, 2025 15:50
@consulthys consulthys merged commit 1e608dc into main Jan 10, 2025
5 of 6 checks passed
@consulthys consulthys deleted the fix-stored-script-doc branch January 10, 2025 16:13
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jan 10, 2025
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jan 10, 2025
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)
leemthompo added a commit to leemthompo/elasticsearch that referenced this pull request Jan 10, 2025
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)
elasticsearchmachine pushed a commit that referenced this pull request Jan 10, 2025
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)

Co-authored-by: Valentin Crettaz <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 10, 2025
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)

Co-authored-by: Valentin Crettaz <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 10, 2025
* Improve/fix documentation on stored scripts

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/scripting/using.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

* Update docs/reference/transform/painless-examples.asciidoc

Co-authored-by: Liam Thompson <[email protected]>

---------

Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 1e608dc)

Co-authored-by: Valentin Crettaz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Automatically create backport pull requests when merged backport :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v7.17.28 v8.16.4 v8.17.2 v8.18.0 v9.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Clarify stored scripts documentation

3 participants