ESQL: Generate railroad diagrams for operators (elastic#103143)

This enables the generation of railroad diagrams for unary minus and a bunch of binary operators like `+`, `-`, `%`, and `>=`. Relates to elastic#100558
nik9000 · Dec 8, 2023 · 6e0c031 · 6e0c031
1 parent 2e592a3
commit 6e0c031
Show file tree

Hide file tree

Showing 15 changed files with 186 additions and 58 deletions.
diff --git a/docs/reference/esql/functions/binary.asciidoc b/docs/reference/esql/functions/binary.asciidoc
@@ -9,4 +9,12 @@ These binary comparison operators are supported:
 * less than: `<`
 * less than or equal: `<=`
 * larger than: `>`
-* larger than or equal: `>=`
+* larger than or equal: `>=`
+
+And these mathematical operators are supported:
+
+[.text-center]
+image::esql/functions/signature/add.svg[Embedded,opts=inline]
+
+[.text-center]
+image::esql/functions/signature/sub.svg[Embedded,opts=inline]
diff --git a/docs/reference/esql/functions/operators.asciidoc b/docs/reference/esql/functions/operators.asciidoc
@@ -9,6 +9,7 @@ Boolean operators for comparing against one or multiple expressions.
 
 // tag::op_list[]
 * <<esql-binary-operators>>
+* <<esql-unary-operators>>
 * <<esql-logical-operators>>
 * <<esql-predicates>>
 * <<esql-cidr_match>>
@@ -23,6 +24,7 @@ Boolean operators for comparing against one or multiple expressions.
 // end::op_list[]
 
 include::binary.asciidoc[]
+include::unary.asciidoc[]
 include::logical.asciidoc[]
 include::predicates.asciidoc[]
 include::cidr_match.asciidoc[]

diff --git a/docs/reference/esql/functions/signature/add.svg b/docs/reference/esql/functions/signature/add.svg
diff --git a/docs/reference/esql/functions/signature/div.svg b/docs/reference/esql/functions/signature/div.svg
diff --git a/docs/reference/esql/functions/signature/equals.svg b/docs/reference/esql/functions/signature/equals.svg
diff --git a/docs/reference/esql/functions/signature/greater_than.svg b/docs/reference/esql/functions/signature/greater_than.svg
diff --git a/docs/reference/esql/functions/signature/less_than.svg b/docs/reference/esql/functions/signature/less_than.svg
diff --git a/docs/reference/esql/functions/signature/mod.svg b/docs/reference/esql/functions/signature/mod.svg
diff --git a/docs/reference/esql/functions/signature/mul.svg b/docs/reference/esql/functions/signature/mul.svg
diff --git a/docs/reference/esql/functions/signature/neg.svg b/docs/reference/esql/functions/signature/neg.svg
diff --git a/docs/reference/esql/functions/signature/not_equals.svg b/docs/reference/esql/functions/signature/not_equals.svg
diff --git a/docs/reference/esql/functions/signature/sub.svg b/docs/reference/esql/functions/signature/sub.svg
diff --git a/docs/reference/esql/functions/unary.asciidoc b/docs/reference/esql/functions/unary.asciidoc
@@ -0,0 +1,8 @@
+[discrete]
+[[esql-unary-operators]]
+=== Unary operators
+
+These unary mathematical operators are supported:
+
+[.text-center]
+image::esql/functions/signature/neg.svg[Embedded,opts=inline]