Skip to content

Painless help text addition #9180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LeeDr wants to merge 2 commits into from
Closed

Painless help text addition #9180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6da90db
Add note about Painless field requirements
Nov 22, 2016
3496d78
Rearrange note order
Nov 22, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/ui/public/field_editor/field_editor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ <h4>
<i class="fa fa-question-circle text-info"></i> Scripting Help
</h4>

<h5>
Painless:
</h5>
<p>
By default, Kibana scripted fields use <a target="_window" ng-href="{{editor.docLinks.painless}}">Painless <i class="fa-link fa"></i></a>, a simple and secure scripting language designed specifically for use with Elasticsearch. To access values in the document use the following format:
</p>
Expand All @@ -146,6 +149,11 @@ <h4>
Painless is powerful but easy to use. It provides access to many <a target="_window" ng-href="{{editor.docLinks.painlessApi}}">native Java APIs <i class="fa-link fa"></i></a>. Read up on its <a target="_window" ng-href="{{editor.docLinks.painlessSyntax}}">syntax <i class="fa-link fa"></i></a> and you'll be up to speed in no time!
</p>

<p>
Sorting, aggregations, and <strong>access to field values in scripts</strong> require doc values which are supported (and on by default) on almost all field types, with the notable exception of analyzed string fields.
You can check the Fields tab to make sure the fields you want to use in your scripts are aggregatable and not analyzed before using them in a script.
</p>

<p>
Kibana currently imposes one special limitation on the scripts you write. Your scripts must consist of a single expression. Multi-statement scripts with an explicit return statement will not work.
In other words, the above example is a valid script, but something like the following is not.
Expand All @@ -159,6 +167,9 @@ <h4>
</code>
</p>

<h5>
Expression:
</h5>
<p>
Coming from an older version of Kibana? The <a target="_window" ng-href="{{editor.docLinks.luceneExpressions}}">Lucene Expressions <i class="fa-link fa"></i></a> you know and love are still available. Lucene expressions are a lot like JavaScript, but limited to basic arithmetic, bitwise and comparison operations.
</p>
Expand Down