Skip to content

Commit c8094fd

Browse files
debadairdebadair
committed
[DOCS] Adding Painless doc to the version branches.
1 parent e2a593b commit c8094fd

File tree

346 files changed

+9512
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

346 files changed

+9512
-0
lines changed

‎docs/painless/index.asciidoc‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
[[painless]]
2+
= Painless Scripting Language
3+
4+
:ref: https://www.elastic.co/guide/en/elasticsearch/reference
5+
6+
include::../Versions.asciidoc[]
7+
8+
include::painless-getting-started.asciidoc[]
9+
10+
// include::painless-examples.asciidoc[]
11+
12+
// include::painless-design.asciidoc[]
13+
14+
include::painless-lang-spec.asciidoc[]
15+
16+
include::painless-syntax.asciidoc[]
17+
18+
include::painless-api-reference.asciidoc[]
19+
20+
////
21+
Proposed Outline (WIP)
22+
Getting Started with Painless
23+
Accessing Doc Values
24+
Updating Fields
25+
Working with Dates
26+
Using Regular Expressions
27+
Debugging Painless Scripts
28+
29+
Example Scripts
30+
Using Painless in Script Fields
31+
Using Painless in Watches
32+
Using Painless in Function Score Queries
33+
Using Painless in Script Queries
34+
Using Painless When Updating Docs
35+
Using Painless When Reindexing
36+
37+
How Painless Works
38+
Painless Architecture
39+
Dispatching Functions
40+
41+
Painless Language Specification
42+
Painless API
43+
////
44+
45+
Painless API Reference

‎docs/painless/painless-api-reference.asciidoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
["appendix",id="painless-api-reference"]
2+
= Painless API Reference
3+
4+
Painless has a strict whitelist for methods and
5+
classes to make sure that all painless scripts are secure and fast. Most of
6+
these methods are exposed directly from the JRE while others are part of
7+
Elasticsearch or Painless itself. Below is a list of all available methods
8+
grouped under the classes on which you can call them. Clicking on the method
9+
name takes you to the documentation for the method.
10+
11+
NOTE: Methods defined in the JRE also have a `(java 9)` link which can be used
12+
to see the method's documentation in Java 9 while clicking on the method's name
13+
goes to the Java 8 documentation. Usually these aren't different but it is
14+
worth going to the version that matches the version of Java you are using to
15+
run Elasticsearch just in case.
16+
17+
include::painless-api-reference/index.asciidoc[]

‎docs/painless/painless-api-reference/AbstractChronology.asciidoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractChronology]]++AbstractChronology++::
7+
* Inherits methods from ++<<painless-api-reference-Chronology,Chronology>>++

‎docs/painless/painless-api-reference/AbstractCollection.asciidoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractCollection]]++AbstractCollection++::
7+
* Inherits methods from ++<<painless-api-reference-Collection,Collection>>++, ++<<painless-api-reference-Iterable,Iterable>>++, ++<<painless-api-reference-Object,Object>>++

‎docs/painless/painless-api-reference/AbstractList.asciidoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractList]]++AbstractList++::
7+
* Inherits methods from ++<<painless-api-reference-Collection,Collection>>++, ++<<painless-api-reference-Iterable,Iterable>>++, ++<<painless-api-reference-List,List>>++, ++<<painless-api-reference-Object,Object>>++

‎docs/painless/painless-api-reference/AbstractMap.SimpleEntry.asciidoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractMap-SimpleEntry]]++AbstractMap.SimpleEntry++::
7+
* ++[[painless-api-reference-AbstractMap-SimpleEntry-AbstractMap.SimpleEntry-1]]link:{java8-javadoc}/java/util/AbstractMap$SimpleEntry.html#AbstractMap.SimpleEntry%2Djava.util.Map$Entry%2D[AbstractMap.SimpleEntry](<<painless-api-reference-Map-Entry,Map.Entry>>)++ (link:{java9-javadoc}/java/util/AbstractMap$SimpleEntry.html#AbstractMap.SimpleEntry%2Djava.util.Map$Entry%2D[java 9])
8+
* ++[[painless-api-reference-AbstractMap-SimpleEntry-AbstractMap.SimpleEntry-2]]link:{java8-javadoc}/java/util/AbstractMap$SimpleEntry.html#AbstractMap.SimpleEntry%2Djava.lang.Object%2Djava.lang.Object%2D[AbstractMap.SimpleEntry](def, def)++ (link:{java9-javadoc}/java/util/AbstractMap$SimpleEntry.html#AbstractMap.SimpleEntry%2Djava.lang.Object%2Djava.lang.Object%2D[java 9])
9+
* Inherits methods from ++<<painless-api-reference-Map-Entry,Map.Entry>>++, ++<<painless-api-reference-Object,Object>>++

‎docs/painless/painless-api-reference/AbstractMap.SimpleImmutableEntry.asciidoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractMap-SimpleImmutableEntry]]++AbstractMap.SimpleImmutableEntry++::
7+
* ++[[painless-api-reference-AbstractMap-SimpleImmutableEntry-AbstractMap.SimpleImmutableEntry-1]]link:{java8-javadoc}/java/util/AbstractMap$SimpleImmutableEntry.html#AbstractMap.SimpleImmutableEntry%2Djava.util.Map$Entry%2D[AbstractMap.SimpleImmutableEntry](<<painless-api-reference-Map-Entry,Map.Entry>>)++ (link:{java9-javadoc}/java/util/AbstractMap$SimpleImmutableEntry.html#AbstractMap.SimpleImmutableEntry%2Djava.util.Map$Entry%2D[java 9])
8+
* ++[[painless-api-reference-AbstractMap-SimpleImmutableEntry-AbstractMap.SimpleImmutableEntry-2]]link:{java8-javadoc}/java/util/AbstractMap$SimpleImmutableEntry.html#AbstractMap.SimpleImmutableEntry%2Djava.lang.Object%2Djava.lang.Object%2D[AbstractMap.SimpleImmutableEntry](def, def)++ (link:{java9-javadoc}/java/util/AbstractMap$SimpleImmutableEntry.html#AbstractMap.SimpleImmutableEntry%2Djava.lang.Object%2Djava.lang.Object%2D[java 9])
9+
* Inherits methods from ++<<painless-api-reference-Map-Entry,Map.Entry>>++, ++<<painless-api-reference-Object,Object>>++

‎docs/painless/painless-api-reference/AbstractMap.asciidoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractMap]]++AbstractMap++::
7+
* Inherits methods from ++<<painless-api-reference-Map,Map>>++, ++<<painless-api-reference-Object,Object>>++

‎docs/painless/painless-api-reference/AbstractQueue.asciidoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractQueue]]++AbstractQueue++::
7+
* Inherits methods from ++<<painless-api-reference-Collection,Collection>>++, ++<<painless-api-reference-Iterable,Iterable>>++, ++<<painless-api-reference-Object,Object>>++, ++<<painless-api-reference-Queue,Queue>>++

‎docs/painless/painless-api-reference/AbstractSequentialList.asciidoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
////
2+
Automatically generated by PainlessDocGenerator. Do not edit.
3+
Rebuild by running `gradle generatePainlessApi`.
4+
////
5+
6+
[[painless-api-reference-AbstractSequentialList]]++AbstractSequentialList++::
7+
* Inherits methods from ++<<painless-api-reference-Collection,Collection>>++, ++<<painless-api-reference-Iterable,Iterable>>++, ++<<painless-api-reference-List,List>>++, ++<<painless-api-reference-Object,Object>>++

0 commit comments

Comments
 (0)