@gooddata/sdk-maql-language-server 0.0.0-stage → 11.65.0-alpha.3

package/esm/docs/en/docs/create-metrics/maql/math/greatest.js

@@ -0,0 +1,13 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# GREATEST
+The GREATEST function identifies the highest value from a selection of
+facts or metrics within one row.
+
+## Syntax
+
+\`\`\`
+SELECT GREATEST(…, …, …)
+SELECT GREATEST(fact, fact)
+SELECT GREATEST(metric, metric)
+SELECT GREATEST(fact, metric, metric, fact)
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/least.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# LEAST\nThe LEAST function identifies the lowest value from a selection of facts\nor metrics within one row.\n\n## Syntax\n\n```\nSELECT LEAST(\u2026, \u2026, \u2026)\nSELECT LEAST(fact, fact)\nSELECT LEAST(metric, metric)\nSELECT LEAST(fact, metric, metric, fact)\n```";
+//# sourceMappingURL=least.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/least.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"least.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/least.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,mRAWb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/least.js

@@ -0,0 +1,13 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# LEAST
+The LEAST function identifies the lowest value from a selection of facts
+or metrics within one row.
+
+## Syntax
+
+\`\`\`
+SELECT LEAST(…, …, …)
+SELECT LEAST(fact, fact)
+SELECT LEAST(metric, metric)
+SELECT LEAST(fact, metric, metric, fact)
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/ln.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# LN\nThe LN function returns the natural logarithm of a number with base e,\nthe constant equal to 2.71828182845904. The LN function returns NULL if\nnumber is less than or equal to 0.\n\nThe LN function has the following format:\n\n```\nLN(n)\n```\n\n-   where *n* is greater than 0\n\nA natural logarithm LN(n) is the inverse of the EXP( ) function and\ntakes as arguments any numeric data, including metrics, metrics\nexpressions, and constants.\n\n## Syntax\n\n```\n SELECT LN(\u2026)\nSELECT LN(number)\n```\n\n## Examples\n\n```\nSELECT LN(10)\nSELECT LN(1/12)\nSELECT LN(1.5)\nSELECT LN(SUM({fact/amount}))\n```";
+//# sourceMappingURL=ln.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/ln.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ln.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/ln.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,gnBA+Bb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/ln.js

@@ -0,0 +1,33 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# LN
+The LN function returns the natural logarithm of a number with base e,
+the constant equal to 2.71828182845904. The LN function returns NULL if
+number is less than or equal to 0.
+
+The LN function has the following format:
+
+\`\`\`
+LN(n)
+\`\`\`
+
+-   where *n* is greater than 0
+
+A natural logarithm LN(n) is the inverse of the EXP( ) function and
+takes as arguments any numeric data, including metrics, metrics
+expressions, and constants.
+
+## Syntax
+
+\`\`\`
+ SELECT LN(…)
+SELECT LN(number)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT LN(10)
+SELECT LN(1/12)
+SELECT LN(1.5)
+SELECT LN(SUM({fact/amount}))
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/log.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# LOG\nThe LOG function returns the logarithm of a number for the given base\nspecified in second parameter of the LOG function. If the base value is\nomitted, base 10 is used.\n\nThe LOG function has the following format:\n\n```\nLOG(n,b)\n```\n\n-   *n* is any positive value\n-   *b* is base, *b* is any positive value other than 0 or 1\n\n## Syntax\n\n```\nSELECT LOG(\u2026)  \nSELECT SQRT(number, base)\n```\n\n## Examples\n\n```\nSELECT LOG(10, 1/12)\nSELECT LOG(SUM({fact/amount}), 2)\nSELECT LOG({metric/amount_max} * 400, {metric/amount_Max})\n```";
+//# sourceMappingURL=log.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/log.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,kjBA2Bb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/log.js

@@ -0,0 +1,29 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# LOG
+The LOG function returns the logarithm of a number for the given base
+specified in second parameter of the LOG function. If the base value is
+omitted, base 10 is used.
+
+The LOG function has the following format:
+
+\`\`\`
+LOG(n,b)
+\`\`\`
+
+-   *n* is any positive value
+-   *b* is base, *b* is any positive value other than 0 or 1
+
+## Syntax
+
+\`\`\`
+SELECT LOG(…)  
+SELECT SQRT(number, base)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT LOG(10, 1/12)
+SELECT LOG(SUM({fact/amount}), 2)
+SELECT LOG({metric/amount_max} * 400, {metric/amount_Max})
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/power.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# POWER\nThe POWER function returns a number raised to the base specified as the\nsecond parameter of the POWER function (e.g., Interest rate, Revenue).\nComplex and undefined results are replaced with NULL.\n\nThe POWER function has the following format:\n\n```\nPOWER(n, b)\n```\n\nThe base *n* and the exponent *b* accept any numeric data, including\nmetrics, metric expressions, and constants.\n\nFor fractional exponent (b) values, using fractions (for example, 1/2)\nrather than decimals (for example, 0.5) improves performance.\n\n## Syntax\n\n```\nPOWER(\u2026,\u2026)\nPOWER(number, power)\n```\n\n## Examples\n\n```\nSELECT POWER(10, 1/12)\nSELECT POWER(SUM({fact/amount}), 2)\nSELECT POWER(1, SUM({fact/amount}))\nSELECT POWER({metric/total_amount} * (1/2), {metric/total_amount})\n```";
+//# sourceMappingURL=power.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/power.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"power.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/power.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,iyBA+Bb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/power.js

@@ -0,0 +1,33 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# POWER
+The POWER function returns a number raised to the base specified as the
+second parameter of the POWER function (e.g., Interest rate, Revenue).
+Complex and undefined results are replaced with NULL.
+
+The POWER function has the following format:
+
+\`\`\`
+POWER(n, b)
+\`\`\`
+
+The base *n* and the exponent *b* accept any numeric data, including
+metrics, metric expressions, and constants.
+
+For fractional exponent (b) values, using fractions (for example, 1/2)
+rather than decimals (for example, 0.5) improves performance.
+
+## Syntax
+
+\`\`\`
+POWER(…,…)
+POWER(number, power)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT POWER(10, 1/12)
+SELECT POWER(SUM({fact/amount}), 2)
+SELECT POWER(1, SUM({fact/amount}))
+SELECT POWER({metric/total_amount} * (1/2), {metric/total_amount})
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/round.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# ROUND\nThe ROUND() function rounds a fact or metric to the number of decimal\nplaces specified in the second parameter. If the second parameter is not\nspecified, then the function rounds to the nearest integer.\n\nThe input value is rounded to an integer (by default) or to a defined\nnumber of decimal points. This function allows metric builds to retain\nexact levels of precision throughout a set of calculations.\n\n-   The first input value can be any constant, fact, metric, or metric\n    expression.\n-   The optional second parameter defines the number of decimal points\n    to which the function applies rounding. This parameter should be an\n    integer, although real numbers are supported for input.\n\n## Syntax\n\n```\nSELECT ROUND(\u2026)\nROUND(fact)\nROUND(metric)\nROUND(metric_expression)\nROUND(input, number_of_decimal_places)\n```\n\n## Examples\n\n```\nSELECT ROUND(12.2) = 12\nSELECT ROUND(12.7) = 13\nSELECT ROUND(12.257,2) = 12.26\nSELECT ROUND (12.257,-1) = 10\n```";
+//# sourceMappingURL=round.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/round.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"round.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/round.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,0+BAgCb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/round.js

@@ -0,0 +1,34 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# ROUND
+The ROUND() function rounds a fact or metric to the number of decimal
+places specified in the second parameter. If the second parameter is not
+specified, then the function rounds to the nearest integer.
+
+The input value is rounded to an integer (by default) or to a defined
+number of decimal points. This function allows metric builds to retain
+exact levels of precision throughout a set of calculations.
+
+-   The first input value can be any constant, fact, metric, or metric
+    expression.
+-   The optional second parameter defines the number of decimal points
+    to which the function applies rounding. This parameter should be an
+    integer, although real numbers are supported for input.
+
+## Syntax
+
+\`\`\`
+SELECT ROUND(…)
+ROUND(fact)
+ROUND(metric)
+ROUND(metric_expression)
+ROUND(input, number_of_decimal_places)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT ROUND(12.2) = 12
+SELECT ROUND(12.7) = 13
+SELECT ROUND(12.257,2) = 12.26
+SELECT ROUND (12.257,-1) = 10
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/sign.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# SIGN\nThe signum (SIGN) function returns a number or metric input as one of\nthe following three values:\n\n-   -1 if the number is negative\n-   0 if the number is zero\n-   1 if the number is positive\n\nThe SIGN function follows the rule: \n\n```\nSIGN(number_input) = (number_input)/(abs(number_input))\n```\n\n## Syntax\n\n```\nSELECT SIGN(\u2026)\nSELECT SIGN(number)\nSELECT SIGN(metric)\n```\n\n## Examples\n\n```\nSELECT SIGN(-3) returns the value -1\nSELECT SIGN(3) returns the value 1\nSELECT SIGN(0) returns the value 0\n```";
+//# sourceMappingURL=sign.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/sign.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/sign.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,+hBA4Bb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/sign.js

@@ -0,0 +1,30 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# SIGN
+The signum (SIGN) function returns a number or metric input as one of
+the following three values:
+
+-   -1 if the number is negative
+-   0 if the number is zero
+-   1 if the number is positive
+
+The SIGN function follows the rule: 
+
+\`\`\`
+SIGN(number_input) = (number_input)/(abs(number_input))
+\`\`\`
+
+## Syntax
+
+\`\`\`
+SELECT SIGN(…)
+SELECT SIGN(number)
+SELECT SIGN(metric)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT SIGN(-3) returns the value -1
+SELECT SIGN(3) returns the value 1
+SELECT SIGN(0) returns the value 0
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/math/sqrt.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# SQRT\nThe square root function (SQRT) returns a square root of a number (e.g.,\nRevenue). If the number is negative, SQRT returns NULL.\n\n## Syntax\n\n```\nSELECT SQRT(\u2026)\nSELECT SQRT(constant)\nSELECT SQRT(metric)\n```\n\n## Examples\n\n```\nSELECT SQRT(25)\n```\n\nreturns the value \"5\"\n\n```\nSELECT SQRT(33.6)\n```\n\nreturns the value \"5.796550698\"\n\n```\nSELECT SQRT(SELECT SUM({fact/sales}))\n```\n\nreturns the square root of a Total Sales metric.";
+//# sourceMappingURL=sqrt.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/sqrt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqrt.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/sqrt.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,0dA8B6B,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/sqrt.js

@@ -0,0 +1,32 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# SQRT
+The square root function (SQRT) returns a square root of a number (e.g.,
+Revenue). If the number is negative, SQRT returns NULL.
+
+## Syntax
+
+\`\`\`
+SELECT SQRT(…)
+SELECT SQRT(constant)
+SELECT SQRT(metric)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT SQRT(25)
+\`\`\`
+
+returns the value \"5\"
+
+\`\`\`
+SELECT SQRT(33.6)
+\`\`\`
+
+returns the value \"5.796550698\"
+
+\`\`\`
+SELECT SQRT(SELECT SUM({fact/sales}))
+\`\`\`
+
+returns the square root of a Total Sales metric.`;

package/esm/docs/en/docs/create-metrics/maql/math/trunc.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# TRUNC\nThe TRUNC functions truncates a number based on the number of decimal\nplaces specified in the second parameter.\n\nBy default, the TRUNC() function allows you to remove all digits to the\nright of the decimal point without applying rounding. If a second\noptional parameter is added to the TRUNC() function, it defines the\nnumber of digits to the right of the decimal point at which truncation\nis applied. Negative values are supported for the second parameter.\n\n-   The first input value can be any constant, fact, metric, or metric\n    expression.\n-   The optional second parameter defines the number of decimal points\n    at which the remaining digits are removed. This parameter should be\n    an integer, although real numbers are supported for input.\n\n## Syntax\n\n```\nSELECT TRUNC(\u2026)\nTRUNC(constant)\nTRUNC(fact)\nTRUNC(metric)\nTRUNC(metric_expression)\nTRUNC(input, number_of_decimal_places)\n```\n\n## Examples\n\n```\nSELECT TRUNC(12.2) = 12\nSELECT TRUNC(12.7) = 12\nSELECT TRUNC(12.257,2) = 12.25\nSELECT TRUNC(1255.257,-2) = 1200\n```";
+//# sourceMappingURL=trunc.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/math/trunc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trunc.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/math/trunc.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,ujCAkCb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/math/trunc.js

@@ -0,0 +1,36 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# TRUNC
+The TRUNC functions truncates a number based on the number of decimal
+places specified in the second parameter.
+
+By default, the TRUNC() function allows you to remove all digits to the
+right of the decimal point without applying rounding. If a second
+optional parameter is added to the TRUNC() function, it defines the
+number of digits to the right of the decimal point at which truncation
+is applied. Negative values are supported for the second parameter.
+
+-   The first input value can be any constant, fact, metric, or metric
+    expression.
+-   The optional second parameter defines the number of decimal points
+    at which the remaining digits are removed. This parameter should be
+    an integer, although real numbers are supported for input.
+
+## Syntax
+
+\`\`\`
+SELECT TRUNC(…)
+TRUNC(constant)
+TRUNC(fact)
+TRUNC(metric)
+TRUNC(metric_expression)
+TRUNC(input, number_of_decimal_places)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT TRUNC(12.2) = 12
+SELECT TRUNC(12.7) = 12
+SELECT TRUNC(12.257,2) = 12.25
+SELECT TRUNC(1255.257,-2) = 1200
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/ranking/percentile.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# PERCENTILE\nThe PERCENTILE( ) function returns the specified percentile out of a set of values. This could be useful for establishing a threshold of\nacceptance, such as for candidates who score above the 90th percentile\non a certification exam, or rewarding sales reps in the top percentile\nwith regard to deals won in the past year.\n\n**Formats:**\n\n```\nPERCENTILE(numeric, k)\n```\n\n-   where *numeric* is a fact or metric\n-   where *k* is a value between 0 and 1 representing the percentile you\n    want returned specified as a decimal. k accepts constants as inputs.\n    Numeric values must be expressed in the following format: 0.xx\n-   For metric expressions, you should compute percentiles using syntax\n    similar to the following:\n\n    ```\n    SELECT PERCENTILE((SELECT SUM([fact]) BY [attribute]),0.25)\n    ```\n\n    ```\n    PERCENTILE(numeric, k%)\n    ```\n\n-   where *numeric* is a fact or metric\n-   where *k%* is a number between 0 and 100 representing the percentile\n    you want returned. k accepts constants as inputs, followed by\n    percent signs as inputs.\n-   For metric expressions, you should compute percentiles using syntax\n    similar to the following: \n\n    ```\n    SELECT PERCENTILE((SELECT SUM([fact]) BY [attribute]),25%)\n    ```\n\n## Syntax\n\n```\nSELECT PERCENTILE(\u2026) [ASC|DESC] [BY(\u2026)]\nSELECT PERCENTILE(metric, decimal)\nSELECT PERCENTILE(metric, percentage)\nSELECT PERCENTILE(fact, decimal)\nSELECT PERCENTILE(fact, percentage)\nSELECT PERCENTILE((SELECT SUM([metric]) BY [attribute]), decimal)\nSELECT PERCENTILE((SELECT SUM([metric]) BY [attribute]), percentage)\n```\n\n## Examples\n\n```\nSELECT PERCENTILE({metric/Amount}, 0.75)\nSELECT PERCENTILE({metric/Amount}, 75%)\n```";
+//# sourceMappingURL=percentile.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/ranking/percentile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"percentile.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/ranking/percentile.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,ouDAuDb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/ranking/percentile.js

@@ -0,0 +1,57 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# PERCENTILE
+The PERCENTILE( ) function returns the specified percentile out of a set of values. This could be useful for establishing a threshold of
+acceptance, such as for candidates who score above the 90th percentile
+on a certification exam, or rewarding sales reps in the top percentile
+with regard to deals won in the past year.
+
+**Formats:**
+
+\`\`\`
+PERCENTILE(numeric, k)
+\`\`\`
+
+-   where *numeric* is a fact or metric
+-   where *k* is a value between 0 and 1 representing the percentile you
+    want returned specified as a decimal. k accepts constants as inputs.
+    Numeric values must be expressed in the following format: 0.xx
+-   For metric expressions, you should compute percentiles using syntax
+    similar to the following:
+
+    \`\`\`
+    SELECT PERCENTILE((SELECT SUM([fact]) BY [attribute]),0.25)
+    \`\`\`
+
+    \`\`\`
+    PERCENTILE(numeric, k%)
+    \`\`\`
+
+-   where *numeric* is a fact or metric
+-   where *k%* is a number between 0 and 100 representing the percentile
+    you want returned. k accepts constants as inputs, followed by
+    percent signs as inputs.
+-   For metric expressions, you should compute percentiles using syntax
+    similar to the following: 
+
+    \`\`\`
+    SELECT PERCENTILE((SELECT SUM([fact]) BY [attribute]),25%)
+    \`\`\`
+
+## Syntax
+
+\`\`\`
+SELECT PERCENTILE(…) [ASC|DESC] [BY(…)]
+SELECT PERCENTILE(metric, decimal)
+SELECT PERCENTILE(metric, percentage)
+SELECT PERCENTILE(fact, decimal)
+SELECT PERCENTILE(fact, percentage)
+SELECT PERCENTILE((SELECT SUM([metric]) BY [attribute]), decimal)
+SELECT PERCENTILE((SELECT SUM([metric]) BY [attribute]), percentage)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT PERCENTILE({metric/Amount}, 0.75)
+SELECT PERCENTILE({metric/Amount}, 75%)
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/ranking/rank-variations.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Rank Variations\nMAQL includes the following ranking functions that sequentially rank all values in a visualization.\n\n\nThe following ranking functions differ from the TOP(n) and\nBOTTOM(n) filters which filter only for a specified number of top or\nbottom values (such as the top five or bottom five sales reps).\n\n\n| Function | Definition                                   |\n|--------------|------------------------------------------------------|\n| RANK         | Assigns a rank to each value in a set of values, leaving gaps between rows of duplicate values (ties) within the set. If any values within a set are the same (tied), the next rank following the tie is  skipped, resulting in **non-consecutive ranking**.   |\n| DENSE_RANK   | Assigns a rank to each value in a set of values, leaving no gaps between rows of duplicate values (ties) within the set. If any values within a set are the same (tied), the next rank following the tie is not skipped and the **ranking remains           consecutive**.                                       |\n| ROW_NUMBER   | Assigns a unique row number, starting from 1, to  every row within a set of values, regardless of duplicate values (ties) within the set.  |\n| PERCENT_RANK | In a set of values, calculates the number of values that are less than the current value, minus 1, divided by the total number of values in the set, minus 1. The first value in any set has a PERCENT_RANK of zero. *  (relative rank of the current value - 1) / (number of values in the set - 1)*   |\n| CUME_DIST    | In a set of values, calculates the number of values that are less than or equal to the current value  (inclusive), divided by the total number of values in the set (cumulative distribution). ( *relative rank of the current value) / (number of values in the set* |\n\nFor more information about the WITHIN clause used in the following\nexamples, see [WITHIN Clause](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/within-clause/).\n\n## RANK and DENSE_RANK\n\nThough similar, the RANK and DENSE_RANK functions differ in the way each\nranks the first row that follows rows of duplicate values.\n\nIn the following illustration, see how the output of RANK skips ranks\n(leaves a gap), whereas DENSE_RANK does not skip ranks (leaves no gap).\n\n![Comparison of RANK and DENSE_RANK](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-dense-rank.png)\n\n-   **RANK** identifies Crystal Powers as the fourth-highest ranking\n    Sales Rep in terms of number of wins in Telecom, Midwest.\n\n    ```\n    SELECT RANK ({metric/no_of_wins}) DESC WITHIN({attribute/region}, {attribute/vertical})\n    ```\n\n-   **DENSE_RANK** identifies Crystal Powers as the Sales Rep with the\n    second-highest number of wins in Telecom, Midwest.\n\n    ```\n    SELECT DENSE_RANK ({metric/no_of_wins}) DESC WITHIN({attribute/region}, {attribute/vertical})\n    ```\n\n## ROW_NUMBER\n\nThe ROW_NUMBER function assigns a unique number to every row in a set,\nregardless of duplicate values within the set.\n\n```\nSELECT ROW_NUMBER({metric/no_of_wins}) DESC WITHIN ({attribute/region}, {attribute/vertical})\n```\n\nThe following illustration shows how ROW_NUMBER can be used with the\nWITHIN clause (see [WITHIN Clause](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/within-clause/) to\nreturn unique row numbers for several subgroups in a visualization. The\npresence of duplicate values (ties) in the Number of Wins column has no\neffect on ROW_NUMBER. \n\n![ROW_NUMBER](https://www.gooddata.com/developers/cloud-native/doc/maql/row-numbers.png)\n\n## CUME_DIST and PERCENT_RANK\n\nThe CUME_DIST and PERCENT_RANK functions are very similar.\n\nThe following statements clarify how they differ.\n\n-   **CUME_DIST** (cumulative distribution) returns a number greater\n    than 0 and up to and including 1 which represents the relative\n    position of the value in the specified row within a group\n    of *N* rows. In the following figure, the CUME_DIST calculation\n    shows that 75% of sales reps in Financial, Midwest have Number of\n    Wins that are less than or equal to those of Franklin Vic.\n\n    ```\n    SELECT CUME_DIST ({metric/no_of_wins}) WITHIN({attribute/region}, {attribute/vertical})\n    ```\n\n-   **PERCENT_RANK** returns a number from 0 to 1 (inclusive) which\n    represents the relative position of the specified row, minus 1,\n    within a group of *N* rows, minus 1. In the following figure, the\n    PERCENT_RANK calculation shows that Franklin Vic is at the 67%\n    percentile in terms of total Number of Wins in his group.\n\n    ```\n    SELECT PERCENT_RANK ({metric/no_of_wins}) WITHIN({attribute/region}, {attribute/vertical})\n    ```\n\n![Comparison of CUME_DIST and PERCENT_RANK](https://www.gooddata.com/developers/cloud-native/doc/maql/cume-dist-percent-rank.png)";
+//# sourceMappingURL=rank-variations.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/ranking/rank-variations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rank-variations.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/ranking/rank-variations.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,i0JAwF8G,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/ranking/rank-variations.js

@@ -0,0 +1,90 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Rank Variations
+MAQL includes the following ranking functions that sequentially rank all values in a visualization.
+
+
+The following ranking functions differ from the TOP(n) and
+BOTTOM(n) filters which filter only for a specified number of top or
+bottom values (such as the top five or bottom five sales reps).
+
+
+| Function | Definition                                   |
+|--------------|------------------------------------------------------|
+| RANK         | Assigns a rank to each value in a set of values, leaving gaps between rows of duplicate values (ties) within the set. If any values within a set are the same (tied), the next rank following the tie is  skipped, resulting in **non-consecutive ranking**.   |
+| DENSE_RANK   | Assigns a rank to each value in a set of values, leaving no gaps between rows of duplicate values (ties) within the set. If any values within a set are the same (tied), the next rank following the tie is not skipped and the **ranking remains           consecutive**.                                       |
+| ROW_NUMBER   | Assigns a unique row number, starting from 1, to  every row within a set of values, regardless of duplicate values (ties) within the set.  |
+| PERCENT_RANK | In a set of values, calculates the number of values that are less than the current value, minus 1, divided by the total number of values in the set, minus 1. The first value in any set has a PERCENT_RANK of zero. *\  (relative rank of the current value - 1) / (number of values in the set - 1)*   |
+| CUME_DIST    | In a set of values, calculates the number of values that are less than or equal to the current value  (inclusive), divided by the total number of values in the set (cumulative distribution). (\ *relative rank of the current value) / (number of values in the set* |
+
+For more information about the WITHIN clause used in the following
+examples, see [WITHIN Clause](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/within-clause/).
+
+## RANK and DENSE_RANK
+
+Though similar, the RANK and DENSE_RANK functions differ in the way each
+ranks the first row that follows rows of duplicate values.
+
+In the following illustration, see how the output of RANK skips ranks
+(leaves a gap), whereas DENSE_RANK does not skip ranks (leaves no gap).
+
+![Comparison of RANK and DENSE_RANK](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-dense-rank.png)
+
+-   **RANK** identifies Crystal Powers as the fourth-highest ranking
+    Sales Rep in terms of number of wins in Telecom, Midwest.
+
+    \`\`\`
+    SELECT RANK ({metric/no_of_wins}) DESC WITHIN({attribute/region}, {attribute/vertical})
+    \`\`\`
+
+-   **DENSE_RANK** identifies Crystal Powers as the Sales Rep with the
+    second-highest number of wins in Telecom, Midwest.
+
+    \`\`\`
+    SELECT DENSE_RANK ({metric/no_of_wins}) DESC WITHIN({attribute/region}, {attribute/vertical})
+    \`\`\`
+
+## ROW_NUMBER
+
+The ROW_NUMBER function assigns a unique number to every row in a set,
+regardless of duplicate values within the set.
+
+\`\`\`
+SELECT ROW_NUMBER({metric/no_of_wins}) DESC WITHIN ({attribute/region}, {attribute/vertical})
+\`\`\`
+
+The following illustration shows how ROW_NUMBER can be used with the
+WITHIN clause (see [WITHIN Clause](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/within-clause/) to
+return unique row numbers for several subgroups in a visualization. The
+presence of duplicate values (ties) in the Number of Wins column has no
+effect on ROW_NUMBER. 
+
+![ROW_NUMBER](https://www.gooddata.com/developers/cloud-native/doc/maql/row-numbers.png)
+
+## CUME_DIST and PERCENT_RANK
+
+The CUME_DIST and PERCENT_RANK functions are very similar.
+
+The following statements clarify how they differ.
+
+-   **CUME_DIST** (cumulative distribution) returns a number greater
+    than 0 and up to and including 1 which represents the relative
+    position of the value in the specified row within a group
+    of *N* rows. In the following figure, the CUME_DIST calculation
+    shows that 75% of sales reps in Financial, Midwest have Number of
+    Wins that are less than or equal to those of Franklin Vic.
+
+    \`\`\`
+    SELECT CUME_DIST ({metric/no_of_wins}) WITHIN({attribute/region}, {attribute/vertical})
+    \`\`\`
+
+-   **PERCENT_RANK** returns a number from 0 to 1 (inclusive) which
+    represents the relative position of the specified row, minus 1,
+    within a group of *N* rows, minus 1. In the following figure, the
+    PERCENT_RANK calculation shows that Franklin Vic is at the 67%
+    percentile in terms of total Number of Wins in his group.
+
+    \`\`\`
+    SELECT PERCENT_RANK ({metric/no_of_wins}) WITHIN({attribute/region}, {attribute/vertical})
+    \`\`\`
+
+![Comparison of CUME_DIST and PERCENT_RANK](https://www.gooddata.com/developers/cloud-native/doc/maql/cume-dist-percent-rank.png)`;

package/esm/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-in.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# TOP or BOTTOM(n) IN\nWHERE TOP|BOTTOM IN is a ranking filter. It limits the inputs into a\nmetric's computations to those values that are the top or bottom *n*\nrankings according to the ranking criteria that you specify. This filter\nsupports the percent parameters *n%*.\n\nWhen you are using filters with a percentage (such as `TOP(20%)`), the\nnumber of the selected items is always rounded **up**.\n\nFor example, you want to select 20% of 21 items, and each item has a\ndistinct value of the metric that it is ranked by. The result is going\nto be 5, because 20% of 21 is 4.2, and it gets rounded up to 5.\n\n## Syntax\n\n```\nSELECT \u2026 WHERE TOP(\u2026) IN \u2026 WITHIN \u2026\nSELECT metric1 WHERE TOP(n) IN (SELECT metric2 BY attribute1, attribute2...) WITHIN (...)\n```\n\nHere, `metric1` represents the metric the value of which is actually returned.\nThe value returned depends on which values are included in its\ncomputations. These inputs are determined by the filtering criteria\nstatement that follows the IN keyword in parentheses.\n\nThe attributes that follow BY are those that will be ranked according to their `metric2` values. Whichever attribute values are associated with\n`metric2` values that fall in the TOP(n) or BOTTOM(n) are then included\nin `metric1` computations - determining the final output.\n\nThe syntax for this type of rank filtering requires the SELECT keyword\nbefore the metric following the IN keyword.\n\n## Examples\n\n```\nSELECT {metric/no_of_tickets} WHERE TOP(5) IN (SELECT {metric/no_of_tickets} 2 BY {attribute/assignee}) WITHIN ({attribute/ticket_group}, all other)\n```\n\nThis example returns TOP(#) assignees by EACH group. \n\n```\nSELECT {metric/Amount} WHERE TOP(5) IN (SELECT {metric/avg_won} BY {attribute/product})\n```\n\nMAQL also supports using the OF keyword following the TOP|BOTTOM ranking\nfilter. This changes the way the metric is interpreted by the query\nengine. With OF you can carry out rankings by more than one metric.\nLikewise, the ranking metric is interpreted as a submetric, rather than\na subreport (as is the case for TOP|BOTTOM in conjunction with the IN\nkeyword).\n\nSee also [TOP or BOTTOM(n) OF](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/where-top-or-bottom-of/).";
+//# sourceMappingURL=where-top-or-bottom-in.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-in.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"where-top-or-bottom-in.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-in.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,uwEAmD6H,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-in.js

@@ -0,0 +1,53 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# TOP or BOTTOM(n) IN
+WHERE TOP|BOTTOM IN is a ranking filter. It limits the inputs into a
+metric's computations to those values that are the top or bottom *n*
+rankings according to the ranking criteria that you specify. This filter
+supports the percent parameters *n%*.
+
+When you are using filters with a percentage (such as \`TOP(20%)\`), the
+number of the selected items is always rounded **up**.
+
+For example, you want to select 20% of 21 items, and each item has a
+distinct value of the metric that it is ranked by. The result is going
+to be 5, because 20% of 21 is 4.2, and it gets rounded up to 5.
+
+## Syntax
+
+\`\`\`
+SELECT … WHERE TOP(…) IN … WITHIN …
+SELECT metric1 WHERE TOP(n) IN (SELECT metric2 BY attribute1, attribute2...) WITHIN (...)
+\`\`\`
+
+Here, \`metric1\` represents the metric the value of which is actually returned.
+The value returned depends on which values are included in its
+computations. These inputs are determined by the filtering criteria
+statement that follows the IN keyword in parentheses.
+
+The attributes that follow BY are those that will be ranked according to their \`metric2\` values. Whichever attribute values are associated with
+\`metric2\` values that fall in the TOP(n) or BOTTOM(n) are then included
+in \`metric1\` computations - determining the final output.
+
+The syntax for this type of rank filtering requires the SELECT keyword
+before the metric following the IN keyword.
+
+## Examples
+
+\`\`\`
+SELECT {metric/no_of_tickets} WHERE TOP(5) IN (SELECT {metric/no_of_tickets} 2 BY {attribute/assignee}) WITHIN ({attribute/ticket_group}, all other)
+\`\`\`
+
+This example returns TOP(#) assignees by EACH group. 
+
+\`\`\`
+SELECT {metric/Amount} WHERE TOP(5) IN (SELECT {metric/avg_won} BY {attribute/product})
+\`\`\`
+
+MAQL also supports using the OF keyword following the TOP|BOTTOM ranking
+filter. This changes the way the metric is interpreted by the query
+engine. With OF you can carry out rankings by more than one metric.
+Likewise, the ranking metric is interpreted as a submetric, rather than
+a subreport (as is the case for TOP|BOTTOM in conjunction with the IN
+keyword).
+
+See also [TOP or BOTTOM(n) OF](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/where-top-or-bottom-of/).`;

package/esm/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-of.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# TOP or BOTTOM(n) OF\nSimilar to [WHERE TOP or BOTTOM(n) IN](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/where-top-or-bottom-in/), WHERE TOP or\nBOTTOM OF can serve as a filter that limits the values included in the\nmetric's computations. Using the OF keyword (rather than IN) allows\nranking of more than one metric and interprets the ranking metric as a sub-metric.\n\nThis filter supports percent parameters: *n%*.\n\nWhen you are using filters with a percentage (such as `TOP(20%)`), the\nnumber of the selected items is always rounded **up**.\n\nFor example, you want to select 20% of 21 items, and each item has a\ndistinct value of the metric that it is ranked by. The result is going\nto be 5, because 20% of 21 is 4.2, and it gets rounded up to 5.\n\n## Syntax\n\n```\nSELECT \u2026 WHERE TOP(\u2026) OF \u2026 [WITHIN \u2026]\nSELECT  metric1  WHERE [TOP|BOTTOM](n) OF ( metric2 , ...)\nSELECT  metric1  WHERE [TOP|BOTTOM](n) OF ( metric2 , ...) WITHIN ( ... )\n```\n\n## Examples\n\n```\nSELECT {metric/amount}  WHERE TOP(5%) OF ({metric/Amount}) AND {label/product} = \"Explorer\"\n```";
+//# sourceMappingURL=where-top-or-bottom-of.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"where-top-or-bottom-of.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-of.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,4nCA2Bb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/ranking/where-top-or-bottom-of.js

@@ -0,0 +1,29 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# TOP or BOTTOM(n) OF
+Similar to [WHERE TOP or BOTTOM(n) IN](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/where-top-or-bottom-in/), WHERE TOP or
+BOTTOM OF can serve as a filter that limits the values included in the
+metric's computations. Using the OF keyword (rather than IN) allows
+ranking of more than one metric and interprets the ranking metric as a sub-metric.
+
+This filter supports percent parameters: *n%*.
+
+When you are using filters with a percentage (such as \`TOP(20%)\`), the
+number of the selected items is always rounded **up**.
+
+For example, you want to select 20% of 21 items, and each item has a
+distinct value of the metric that it is ranked by. The result is going
+to be 5, because 20% of 21 is 4.2, and it gets rounded up to 5.
+
+## Syntax
+
+\`\`\`
+SELECT … WHERE TOP(…) OF … [WITHIN …]
+SELECT  metric1  WHERE [TOP|BOTTOM](n) OF ( metric2 , ...)
+SELECT  metric1  WHERE [TOP|BOTTOM](n) OF ( metric2 , ...) WITHIN ( ... )
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT {metric/amount}  WHERE TOP(5%) OF ({metric/Amount}) AND {label/product} = "Explorer"
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/ranking/within-clause.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# WITHIN Clause\nYou can add variations of the WITHIN clause to any supported [Rank Variations](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/rank-variations/). This syntax lets you rank\nvalues within subgroups defined by a visualization's attribute values.\nSubgroup ranking is useful, for example, if you want to rank the top\nsales reps (in terms of amount won) within each sales region.\n\n## Ranking functions without WITHIN\n\nWhen you use a ranking function without an accompanying WITHIN clause\n(for example, `SELECT RANK({metric/avg_won})`), the function sequentially ranks\nall metric values across the rows in a visualization. The output is identical\nto `RANK(...) WITHIN(ALL IN ALL OTHER DIMENSIONS)`, as displayed below.\n\n```\nSELECT RANK ({metric/amount_won})\n```\n\n![RANK without the WITHIN clause](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-without-within.png)\n\n## Ranking functions with WITHIN\n\nWhen you use ranking functions with an accompanying WITHIN clause, any\nnumber of parameter formulations are possible, resulting in different\noutputs.\n\n```\nWITHIN (attribute1, attribute2, ...)\n```\n\nRanks metric values within one or more subgroups defined by the\ninsight's attributes.\n\n```\nSELECT RANK ({metric/{amount_won}) DESC WITHIN ({attribute/vertical}, {attribute/region})\n```\n\n![WITHIN (Region,Vertical)](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within.png )\n\n## WITHIN (ALL ATTRIBUTE)\n\nRanks metric values within one or more subgroups defined by all visualization\nattributes **other than** the attribute specified in the metric (and any\nother attributes in the same dataset as the attribute specified in the\nmetric).\n\nIf the ranking metric is a stand-alone metric, then it will rank as\ndescribed in [Rank Variations](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/rank-variations/).\n\n```\nSELECT RANK ({metric/{amount_won}) DESC WITHIN (ALL {attribute/vertical})\n```\n\nFor example, if Vertical, Region, and Sales Rep attributes are included\nin the visualization, the above metric ranks metric values sequentially by\nRegion and Sales Rep, but not by Vertical.\n\n\n![WITHIN (ALL Vertical)](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within-all.png )\n\nNotice that if you remove Vertical from the visualization, the\nranking of Amount Won remains the same as before because the WITHIN ALL\nclause omits Vertical from the rankings.\n\nRanking remains the same when the Vertical attribute is removed from the visualization.\n\n![Rank the same](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-the-same.png)\n\n\n## WITHIN (ALL OTHER EXCEPT ATTRIBUTE)\n\nRanks metric values within one or more subgroups defined by the\nattribute specified in the metric (or any other attributes in the same\ndataset as the attribute specified in the metric), but **overrides** all\nother visualization attributes.\n\n```\nSELECT RANK ({metric/{amount_won}) DESC WITHIN (ALL OTHER EXCEPT {attribute/vertical})\n```\n\nIf Vertical and Region attributes are included in the visualization, the above\nmetric ranks Amount Won sequentially by Vertical, but not by Region.\n\n![WITHIN (ALL Vertical), Vertical removed from the visualization](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within-removed.png )\n\n## WITHIN (CURRENT)\n\nRanks metric values within current visualization's dimensionality, as\nspecified by the visualization's attributes, where every row of the visualization is\nhandled as a separate group and thus each value is ranked '1'. \n\n```\nSELECT RANK ({metric/{amount_won}) DESC WITHIN (CURRENT)\n```\n\n![WITHIN (CURRENT)](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within-current.png )\n\nAn exception to the above would occur if you used WITHIN (CURRENT) with\nthe PERCENT_RANK function. That combination would return the percentage\nof metric values that are less than the current value, which is\nnecessarily zero in a single-value \"group.\"";
+//# sourceMappingURL=within-clause.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/ranking/within-clause.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"within-clause.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/ranking/within-clause.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,2gIAmG0B,CAAC"}