diff --git a/docs/reference/sql/functions/aggs.asciidoc b/docs/reference/sql/functions/aggs.asciidoc index cc0f06cb3bb5e..2beef2c65ea71 100644 --- a/docs/reference/sql/functions/aggs.asciidoc +++ b/docs/reference/sql/functions/aggs.asciidoc @@ -16,7 +16,7 @@ Functions for computing a _single_ result from a set of input values. .Synopsis: [source, sql] -------------------------------------------------- -AVG(numeric_field<1>) +AVG(numeric_field) <1> -------------------------------------------------- *Input*: @@ -40,7 +40,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggAvg] .Synopsis: [source, sql] -------------------------------------------------- -COUNT(expression<1>) +COUNT(expression) <1> -------------------------------------------------- *Input*: @@ -70,7 +70,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountStar] .Synopsis: [source, sql] -------------------------------------------------- -COUNT(ALL field_name<1>) +COUNT(ALL field_name) <1> -------------------------------------------------- *Input*: @@ -95,7 +95,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountAll] .Synopsis: [source, sql] -------------------------------------------------- -COUNT(DISTINCT field_name<1>) +COUNT(DISTINCT field_name) <1> -------------------------------------------------- *Input*: @@ -119,7 +119,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountDistinct] .Synopsis: [source, sql] ---------------------------------------------- -FIRST(field_name<1>[, ordering_field_name]<2>) +FIRST( + field_name <1> + [, ordering_field_name]) <2> ---------------------------------------------- *Input*: @@ -214,7 +216,9 @@ the field is also <>. .Synopsis: [source, sql] -------------------------------------------------- -LAST(field_name<1>[, ordering_field_name]<2>) +LAST( + field_name <1> + [, ordering_field_name]) <2> -------------------------------------------------- *Input*: @@ -309,7 +313,7 @@ the field is also <>. .Synopsis: [source, sql] -------------------------------------------------- -MAX(field_name<1>) +MAX(field_name) <1> -------------------------------------------------- *Input*: @@ -337,7 +341,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggMax] .Synopsis: [source, sql] -------------------------------------------------- -MIN(field_name<1>) +MIN(field_name) <1> -------------------------------------------------- *Input*: @@ -365,7 +369,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggMin] .Synopsis: [source, sql] -------------------------------------------------- -SUM(field_name<1>) +SUM(field_name) <1> -------------------------------------------------- *Input*: @@ -393,7 +397,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggSum] .Synopsis: [source, sql] -------------------------------------------------- -KURTOSIS(field_name<1>) +KURTOSIS(field_name) <1> -------------------------------------------------- *Input*: @@ -417,7 +421,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggKurtosis] .Synopsis: [source, sql] -------------------------------------------------- -MAD(field_name<1>) +MAD(field_name) <1> -------------------------------------------------- *Input*: @@ -441,7 +445,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggMad] .Synopsis: [source, sql] -------------------------------------------------- -PERCENTILE(field_name<1>, numeric_exp<2>) +PERCENTILE( + field_name, <1> + numeric_exp) <2> -------------------------------------------------- *Input*: @@ -467,7 +473,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggPercentile] .Synopsis: [source, sql] -------------------------------------------------- -PERCENTILE_RANK(field_name<1>, numeric_exp<2>) +PERCENTILE_RANK( + field_name, <1> + numeric_exp) <2> -------------------------------------------------- *Input*: @@ -493,7 +501,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggPercentileRank] .Synopsis: [source, sql] -------------------------------------------------- -SKEWNESS(field_name<1>) +SKEWNESS(field_name) <1> -------------------------------------------------- *Input*: @@ -517,7 +525,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggSkewness] .Synopsis: [source, sql] -------------------------------------------------- -STDDEV_POP(field_name<1>) +STDDEV_POP(field_name) <1> -------------------------------------------------- *Input*: @@ -541,7 +549,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggStddevPop] .Synopsis: [source, sql] -------------------------------------------------- -SUM_OF_SQUARES(field_name<1>) +SUM_OF_SQUARES(field_name) <1> -------------------------------------------------- *Input*: @@ -565,7 +573,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[aggSumOfSquares] .Synopsis: [source, sql] -------------------------------------------------- -VAR_POP(field_name<1>) +VAR_POP(field_name) <1> -------------------------------------------------- *Input*: diff --git a/docs/reference/sql/functions/date-time.asciidoc b/docs/reference/sql/functions/date-time.asciidoc index 782ea15f62741..d9d5e7bcf14e5 100644 --- a/docs/reference/sql/functions/date-time.asciidoc +++ b/docs/reference/sql/functions/date-time.asciidoc @@ -146,7 +146,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[filterToday] [source, sql] -------------------------------------------------- CURRENT_TIME -CURRENT_TIME([precision <1>]) +CURRENT_TIME([precision]) <1> CURTIME -------------------------------------------------- @@ -203,7 +203,7 @@ function as the maximum number of second fractional digits returned is 3 (millis [source, sql] -------------------------------------------------- CURRENT_TIMESTAMP -CURRENT_TIMESTAMP([precision <1>]) +CURRENT_TIMESTAMP([precision]) <1> -------------------------------------------------- *Input*: @@ -254,7 +254,7 @@ function as the maximum number of second fractional digits returned is 3 (millis .Synopsis: [source, sql] -------------------------------------------------- -DAY_OF_MONTH(datetime_exp<1>) +DAY_OF_MONTH(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -278,7 +278,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfMonth] .Synopsis: [source, sql] -------------------------------------------------- -DAY_OF_WEEK(datetime_exp<1>) +DAY_OF_WEEK(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -302,7 +302,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfWeek] .Synopsis: [source, sql] -------------------------------------------------- -DAY_OF_YEAR(datetime_exp<1>) +DAY_OF_YEAR(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -326,7 +326,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[dayOfYear] .Synopsis: [source, sql] -------------------------------------------------- -DAY_NAME(datetime_exp<1>) +DAY_NAME(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -350,7 +350,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[dayName] .Synopsis: [source, sql] -------------------------------------------------- -HOUR_OF_DAY(datetime_exp<1>) +HOUR_OF_DAY(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -374,7 +374,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[hourOfDay] .Synopsis: [source, sql] -------------------------------------------------- -ISO_DAY_OF_WEEK(datetime_exp<1>) +ISO_DAY_OF_WEEK(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -399,7 +399,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[isoDayOfWeek] .Synopsis: [source, sql] -------------------------------------------------- -ISO_WEEK_OF_YEAR(datetime_exp<1>) +ISO_WEEK_OF_YEAR(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -424,7 +424,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[isoWeekOfYear] .Synopsis: [source, sql] -------------------------------------------------- -MINUTE_OF_DAY(datetime_exp<1>) +MINUTE_OF_DAY(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -448,7 +448,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[minuteOfDay] .Synopsis: [source, sql] -------------------------------------------------- -MINUTE_OF_HOUR(datetime_exp<1>) +MINUTE_OF_HOUR(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -472,7 +472,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[minuteOfHour] .Synopsis: [source, sql] -------------------------------------------------- -MONTH(datetime_exp<1>) +MONTH(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -496,7 +496,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[monthOfYear] .Synopsis: [source, sql] -------------------------------------------------- -MONTH_NAME(datetime_exp<1>) +MONTH_NAME(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -552,7 +552,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[filterNow] .Synopsis: [source, sql] -------------------------------------------------- -SECOND_OF_MINUTE(datetime_exp<1>) +SECOND_OF_MINUTE(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -576,7 +576,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[secondOfMinute] .Synopsis: [source, sql] -------------------------------------------------- -QUARTER(datetime_exp<1>) +QUARTER(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -632,7 +632,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[filterToday] .Synopsis: [source, sql] -------------------------------------------------- -WEEK_OF_YEAR(datetime_exp<1>) +WEEK_OF_YEAR(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -656,7 +656,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[weekOfYear] .Synopsis: [source, sql] -------------------------------------------------- -YEAR(datetime_exp<1>) +YEAR(datetime_exp) <1> -------------------------------------------------- *Input*: @@ -680,7 +680,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[year] .Synopsis: [source, sql] -------------------------------------------------- -EXTRACT(datetime_function<1> FROM datetime_exp<2>) +EXTRACT( + datetime_function <1> + FROM datetime_exp) <2> -------------------------------------------------- *Input*: diff --git a/docs/reference/sql/functions/grouping.asciidoc b/docs/reference/sql/functions/grouping.asciidoc index 742f072dbd039..0a498a1aacef0 100644 --- a/docs/reference/sql/functions/grouping.asciidoc +++ b/docs/reference/sql/functions/grouping.asciidoc @@ -12,8 +12,13 @@ as part of the <>. .Synopsis: [source, sql] ---- -HISTOGRAM(numeric_exp<1>, numeric_interval<2>) -HISTOGRAM(date_exp<3>, date_time_interval<4>) +HISTOGRAM( + numeric_exp, <1> + numeric_interval) <2> + +HISTOGRAM( + date_exp, <3> + date_time_interval) <4> ---- *Input*: diff --git a/docs/reference/sql/functions/like-rlike.asciidoc b/docs/reference/sql/functions/like-rlike.asciidoc index c38f62ae7d7c1..73212bc113542 100644 --- a/docs/reference/sql/functions/like-rlike.asciidoc +++ b/docs/reference/sql/functions/like-rlike.asciidoc @@ -20,7 +20,8 @@ or has an exact sub-field, it will use it as is, or it will automatically use th .Synopsis: [source, sql] -------------------------------------------------- -expression<1> LIKE constant_exp<2> +expression <1> +LIKE constant_exp <2> -------------------------------------------------- <1> typically a field, or a constant expression @@ -59,7 +60,8 @@ IMPORTANT: Even though `LIKE` is a valid option when searching or filtering in { .Synopsis: [source, sql] -------------------------------------------------- -expression<1> RLIKE constant_exp<2> +expression <1> +RLIKE constant_exp <2> -------------------------------------------------- <1> typically a field, or a constant expression diff --git a/docs/reference/sql/functions/math.asciidoc b/docs/reference/sql/functions/math.asciidoc index f77b6975604d2..ebef8a305bcc6 100644 --- a/docs/reference/sql/functions/math.asciidoc +++ b/docs/reference/sql/functions/math.asciidoc @@ -16,7 +16,7 @@ to be numeric. .Synopsis: [source, sql] -------------------------------------------------- -ABS(numeric_exp<1>) +ABS(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -40,7 +40,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[abs] .Synopsis: [source, sql] -------------------------------------------------- -CBRT(numeric_exp<1>) +CBRT(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -64,7 +64,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineCbrtWithNegativeValue] .Synopsis: [source, sql] -------------------------------------------------- -CEIL(numeric_exp<1>) +CEIL(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -110,7 +110,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathEulersNumber] .Synopsis: [source, sql] -------------------------------------------------- -EXP(numeric_exp<1>) +EXP(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -134,7 +134,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathExpInline] .Synopsis: [source, sql] -------------------------------------------------- -EXPM1(numeric_exp<1>) +EXPM1(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -158,7 +158,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathExpm1Inline] .Synopsis: [source, sql] -------------------------------------------------- -FLOOR(numeric_exp<1>) +FLOOR(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -182,7 +182,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineFloor] .Synopsis: [source, sql] -------------------------------------------------- -LOG(numeric_exp<1>) +LOG(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -206,7 +206,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineLog] .Synopsis: [source, sql] -------------------------------------------------- -LOG10(numeric_exp<1>) +LOG10(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -252,7 +252,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathPINumber] .Synopsis: [source, sql] -------------------------------------------------- -POWER(numeric_exp<1>, integer_exp<2>) +POWER( + numeric_exp, <1> + integer_exp) <2> -------------------------------------------------- *Input*: @@ -282,7 +284,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlinePowerNegative] .Synopsis: [source, sql] -------------------------------------------------- -RANDOM(seed<1>) +RANDOM(seed) <1> -------------------------------------------------- *Input*: @@ -306,7 +308,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathRandom] .Synopsis: [source, sql] ---- -ROUND(numeric_exp<1>[, integer_exp<2>]) +ROUND( + numeric_exp <1> + [, integer_exp]) <2> ---- *Input*: @@ -337,7 +341,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathRoundWithNegativeParameter] .Synopsis: [source, sql] -------------------------------------------------- -SIGN(numeric_exp<1>) +SIGN(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -362,7 +366,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineSign] .Synopsis: [source, sql] -------------------------------------------------- -SQRT(numeric_exp<1>) +SQRT(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -386,7 +390,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineSqrt] .Synopsis: [source, sql] ---- -TRUNCATE(numeric_exp<1>[, integer_exp<2>]) +TRUNCATE( + numeric_exp <1> + [, integer_exp]) <2> ---- *Input*: @@ -421,7 +427,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathTruncateWithNegativeParameter .Synopsis: [source, sql] -------------------------------------------------- -ACOS(numeric_exp<1>) +ACOS(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -445,7 +451,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineAcos] .Synopsis: [source, sql] -------------------------------------------------- -ASIN(numeric_exp<1>) +ASIN(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -469,7 +475,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineAsin] .Synopsis: [source, sql] -------------------------------------------------- -ATAN(numeric_exp<1>) +ATAN(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -493,7 +499,9 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineAtan] .Synopsis: [source, sql] -------------------------------------------------- -ATAN2(ordinate<1>, abscisa<2>) +ATAN2( + ordinate, <1> + abscisa) <2> -------------------------------------------------- *Input*: @@ -518,7 +526,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineAtan2] .Synopsis: [source, sql] -------------------------------------------------- -COS(numeric_exp<1>) +COS(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -542,7 +550,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineCosine] .Synopsis: [source, sql] -------------------------------------------------- -COSH(numeric_exp<1>) +COSH(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -566,7 +574,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineCosh] .Synopsis: [source, sql] -------------------------------------------------- -COT(numeric_exp<1>) +COT(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -590,7 +598,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineCotangent] .Synopsis: [source, sql] -------------------------------------------------- -DEGREES(numeric_exp<1>) +DEGREES(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -615,7 +623,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineDegrees] .Synopsis: [source, sql] -------------------------------------------------- -RADIANS(numeric_exp<1>) +RADIANS(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -640,7 +648,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineRadians] .Synopsis: [source, sql] -------------------------------------------------- -SIN(numeric_exp<1>) +SIN(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -664,7 +672,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineSine] .Synopsis: [source, sql] -------------------------------------------------- -SINH(numeric_exp<1>) +SINH(numeric_exp) <1> -------------------------------------------------- *Input*: @@ -688,7 +696,7 @@ include-tagged::{sql-specs}/docs/docs.csv-spec[mathInlineSinh] .Synopsis: [source, sql] -------------------------------------------------- -TAN(numeric_exp<1>) +TAN(numeric_exp) <1> -------------------------------------------------- *Input*: diff --git a/docs/reference/sql/functions/search.asciidoc b/docs/reference/sql/functions/search.asciidoc index 0534271caa91f..6990f6669d69c 100644 --- a/docs/reference/sql/functions/search.asciidoc +++ b/docs/reference/sql/functions/search.asciidoc @@ -14,7 +14,10 @@ such as `0` or `NULL`. .Synopsis: [source, sql] -------------------------------------------------- -MATCH(field_exp<1>, constant_exp<2>[, options]<3>) +MATCH( + field_exp, <1> + constant_exp <2> + [, options]) <3> -------------------------------------------------- *Input*: @@ -75,7 +78,9 @@ NOTE: The allowed optional parameters for a multi-field `MATCH()` variant (for t .Synopsis: [source, sql] -------------------------------------------------- -QUERY(constant_exp<1>[, options]<2>) +QUERY( + constant_exp <1> + [, options]) <2> -------------------------------------------------- *Input*: