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

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

@@ -0,0 +1,101 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# WITHIN Clause
+You 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
+values within subgroups defined by a visualization's attribute values.
+Subgroup ranking is useful, for example, if you want to rank the top
+sales reps (in terms of amount won) within each sales region.
+
+## Ranking functions without WITHIN
+
+When you use a ranking function without an accompanying WITHIN clause
+(for example, \`SELECT RANK({metric/avg_won})\`), the function sequentially ranks
+all metric values across the rows in a visualization. The output is identical
+to \`RANK(...) WITHIN(ALL IN ALL OTHER DIMENSIONS)\`, as displayed below.
+
+\`\`\`
+SELECT RANK ({metric/amount_won})
+\`\`\`
+
+![RANK without the WITHIN clause](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-without-within.png)
+
+## Ranking functions with WITHIN
+
+When you use ranking functions with an accompanying WITHIN clause, any
+number of parameter formulations are possible, resulting in different
+outputs.
+
+\`\`\`
+WITHIN (attribute1, attribute2, ...)
+\`\`\`
+
+Ranks metric values within one or more subgroups defined by the
+insight\'s attributes.
+
+\`\`\`
+SELECT RANK ({metric/{amount_won}) DESC WITHIN ({attribute/vertical}, {attribute/region})
+\`\`\`
+
+![WITHIN (Region,Vertical)](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within.png )
+
+## WITHIN (ALL ATTRIBUTE)
+
+Ranks metric values within one or more subgroups defined by all visualization
+attributes **other than** the attribute specified in the metric (and any
+other attributes in the same dataset as the attribute specified in the
+metric).
+
+If the ranking metric is a stand-alone metric, then it will rank as
+described in [Rank Variations](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/ranking/rank-variations/).
+
+\`\`\`
+SELECT RANK ({metric/{amount_won}) DESC WITHIN (ALL {attribute/vertical})
+\`\`\`
+
+For example, if Vertical, Region, and Sales Rep attributes are included
+in the visualization, the above metric ranks metric values sequentially by
+Region and Sales Rep, but not by Vertical.
+
+
+![WITHIN (ALL Vertical)](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within-all.png )
+
+Notice that if you remove Vertical from the visualization, the
+ranking of Amount Won remains the same as before because the WITHIN ALL
+clause omits Vertical from the rankings.
+
+Ranking remains the same when the Vertical attribute is removed from the visualization.
+
+![Rank the same](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-the-same.png)
+
+
+## WITHIN (ALL OTHER EXCEPT ATTRIBUTE)
+
+Ranks metric values within one or more subgroups defined by the
+attribute specified in the metric (or any other attributes in the same
+dataset as the attribute specified in the metric), but **overrides** all
+other visualization attributes.
+
+\`\`\`
+SELECT RANK ({metric/{amount_won}) DESC WITHIN (ALL OTHER EXCEPT {attribute/vertical})
+\`\`\`
+
+If Vertical and Region attributes are included in the visualization, the above
+metric ranks Amount Won sequentially by Vertical, but not by Region.
+
+![WITHIN (ALL Vertical), Vertical removed from the visualization](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within-removed.png )
+
+## WITHIN (CURRENT)
+
+Ranks metric values within current visualization's dimensionality, as
+specified by the visualization's attributes, where every row of the visualization is
+handled as a separate group and thus each value is ranked \'1\'. 
+
+\`\`\`
+SELECT RANK ({metric/{amount_won}) DESC WITHIN (CURRENT)
+\`\`\`
+
+![WITHIN (CURRENT)](https://www.gooddata.com/developers/cloud-native/doc/maql/rank-within-current.png )
+
+An exception to the above would occur if you used WITHIN (CURRENT) with
+the PERCENT_RANK function. That combination would return the percentage
+of metric values that are less than the current value, which is
+necessarily zero in a single-value \"group.\"`;

package/esm/docs/en/docs/create-metrics/maql/relational-operators.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Relational Operators\nRelational operators can be used with facts, metrics, or date labels to\ndefine filter conditions on a metric.\n\n## Syntax\n\n```\nSELECT \u2026 WHERE \u2026 (<|>|=|!=|<>|BETWEEN) \u2026\nSELECT metric WHERE fact1 < fact2\nSELECT metric WHERE fact1 < number\nSELECT metric1 WHERE metric2 > number\nSELECT metric WHERE date_label > date_value\nSELECT metric WHERE date1_label < date2_label\nSELECT metric WHERE attribute = attribute_value\nSELECT metric WHERE attribute <> attribute_value\nSELECT metric WHERE label IN (label_value1, label_value2)\nSELECT metric WHERE label NOT IN (label_value1, label_value2)\nSELECT metric WHERE fact BETWEEN number AND number\nSELECT metric WHERE date_label BETWEEN date_value1 AND date_value2\nSELECT metric WHERE fact NOT BETWEEN number AND metric\nSELECT metric WHERE attribute = NULL\nSELECT metric WHERE attribute <> NULL\nSELECT metric WHERE label IN (label_value1, label_value2, NULL)\nSELECT metric WHERE label NOT IN (label_value1, label_value2, NULL)\n```\n\n## Examples\n\n```\nSELECT {metric/number of transactions} WHERE {metric/total_amount} > 10000\nSELECT {metric/number_of_transactions} WHERE {metric/amount} > 6 AND {metric/amount} <= 20\nSELECT {metric/profit} WHERE {label/date_ordered.monthYear} < \"2007-05\"\nSELECT {metric/profit} WHERE {label/date_ordered.year} > \"2007\"\nSELECT {metric/profit} WHERE {label/date_ordered.date} <= \"2010-12-22\"\nSELECT {metric/profit} WHERE {label/date_ordered.week} < {label/date_shipped.week}\nSELECT {metric/payment} WHERE {label/country} = \"US\"\nSELECT {metric/payment} WHERE {label/date_ordered.week} = {label/date_shipped.week}\nSELECT {metric/payment} WHERE {label/country} <> \"US\"\nSELECT {metric/payment} WHERE {label/region} IN (\"America\", \"EU\")\nSELECT {metric/payment} WHERE {label/region} NOT IN (\"America\", \"EU\")\nSELECT {metric/payment} WHERE {label/date.quarter} BETWEEN THIS - 5 AND THIS\nSELECT {metric/payment} WHERE {fact/cost} BETWEEN 100 AND 200\nSELECT {metric/payment} WHERE {fact/cost} BETWEEN 100 AND {metric/highest_cost}\nSELECT {metric/payment} WHERE {label/country} = NULL\nSELECT {metric/payment} WHERE {label/country} <> NULL\nSELECT {metric/payment} WHERE {label/region} IN (\"America\", \"EU\", NULL)\nSELECT {metric/payment} WHERE {label/region} NOT IN (\"America\", \"EU\", NULL)\n```\n>A comparison of attribute values with NULL using MAQL relational operators translates to semantics of ``IS NULL``/ ``IS NOT NULL`` operators in SQL.";
+//# sourceMappingURL=relational-operators.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/relational-operators.d.ts.map

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

package/esm/docs/en/docs/create-metrics/maql/relational-operators.js

@@ -0,0 +1,50 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Relational Operators
+Relational operators can be used with facts, metrics, or date labels to
+define filter conditions on a metric.
+
+## Syntax
+
+\`\`\`
+SELECT … WHERE … (<|>|=|!=|<>|BETWEEN) …
+SELECT metric WHERE fact1 < fact2
+SELECT metric WHERE fact1 < number
+SELECT metric1 WHERE metric2 > number
+SELECT metric WHERE date_label > date_value
+SELECT metric WHERE date1_label < date2_label
+SELECT metric WHERE attribute = attribute_value
+SELECT metric WHERE attribute <> attribute_value
+SELECT metric WHERE label IN (label_value1, label_value2)
+SELECT metric WHERE label NOT IN (label_value1, label_value2)
+SELECT metric WHERE fact BETWEEN number AND number
+SELECT metric WHERE date_label BETWEEN date_value1 AND date_value2
+SELECT metric WHERE fact NOT BETWEEN number AND metric
+SELECT metric WHERE attribute = NULL
+SELECT metric WHERE attribute <> NULL
+SELECT metric WHERE label IN (label_value1, label_value2, NULL)
+SELECT metric WHERE label NOT IN (label_value1, label_value2, NULL)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT {metric/number of transactions} WHERE {metric/total_amount} > 10000
+SELECT {metric/number_of_transactions} WHERE {metric/amount} > 6 AND {metric/amount} <= 20
+SELECT {metric/profit} WHERE {label/date_ordered.monthYear} < "2007-05"
+SELECT {metric/profit} WHERE {label/date_ordered.year} > "2007"
+SELECT {metric/profit} WHERE {label/date_ordered.date} <= "2010-12-22"
+SELECT {metric/profit} WHERE {label/date_ordered.week} < {label/date_shipped.week}
+SELECT {metric/payment} WHERE {label/country} = "US"
+SELECT {metric/payment} WHERE {label/date_ordered.week} = {label/date_shipped.week}
+SELECT {metric/payment} WHERE {label/country} <> "US"
+SELECT {metric/payment} WHERE {label/region} IN ("America", "EU")
+SELECT {metric/payment} WHERE {label/region} NOT IN ("America", "EU")
+SELECT {metric/payment} WHERE {label/date.quarter} BETWEEN THIS - 5 AND THIS
+SELECT {metric/payment} WHERE {fact/cost} BETWEEN 100 AND 200
+SELECT {metric/payment} WHERE {fact/cost} BETWEEN 100 AND {metric/highest_cost}
+SELECT {metric/payment} WHERE {label/country} = NULL
+SELECT {metric/payment} WHERE {label/country} <> NULL
+SELECT {metric/payment} WHERE {label/region} IN ("America", "EU", NULL)
+SELECT {metric/payment} WHERE {label/region} NOT IN ("America", "EU", NULL)
+\`\`\`
+>A comparison of attribute values with NULL using MAQL relational operators translates to semantics of \`\`IS NULL\`\`/ \`\`IS NOT NULL\`\` operators in SQL.`;

package/esm/docs/en/docs/create-metrics/maql/runing-totals/rolling-window.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Rolling Window\nUse the ROWS BETWEEN keyword to specify a rolling window over which\nrunning total functions (for example RUNAVG) are computed.\n\nRunning total functions such as RUNSUM, RUNAVG, RUNMIN and RUNMAX can be\nspecified with rolling window or a shifted boundary. An example could be\na moving average used with time series data to smooth out short-term\nfluctuations and highlight longer-term trends or cycles.\n\nROWS BETWEEN does not currently support the COUNT or APPROXIMATE_COUNT function.\n\n## Syntax\n\n```\nSELECT (RUNNING TOTAL)(...) ROWS BETWEEN (...) AND (...)\nSELECT RUNAVG (...) ROWS BETWEEN (\u2026) AND (\u2026)\n```\n\n## Examples\n\n**In the context of Date**\n\nDefine a moving average\n\n```\nSELECT RUNAVG (Revenue) ROWS BETWEEN 5 PRECEDING AND CURRENT ROW\n```\n\nReturn Year-to-Date (YTD) for Revenue:\n\n```\nSELECT RUNSUM (Revenue) WITHIN Year (Opp. Close) ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW\n```\n\nDefine five days preceding and the current date:\n\n```\n SELECT RUNAVG({metric}) ROWS BETWEEN 5 PRECEDING AND CURRENT ROW\n```\n\n```\nSELECT RUNAVG({metric}) ROWS BETWEEN 5 PRECEDING AND 1 PRECEDING\nSELECT RUNAVG({metric}) ROWS BETWEEN 5 PRECEDING AND 1 FOLLOWING\n```\n\nDisplay year to date - the same result as without specifying ROWS BETWEEN statement:\n\n```\nSELECT RUNSUM({metric/m}) WITHIN {attribute/year} ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW\n```\n\nDefine year to yesterday:\n\n```\nSELECT RUNSUM({metric}/m) WITHIN {attribute/year} ROWS BETWEEN UNBOUNDED PRECEDING AND 1 PRECEDING ROW\n```\n\n**In the context of Month**\n\nDefine the last twelve months:\n\n```\nSELECT RUNSUM({metric/m}) ROWS BETWEEN 13 PRECEDING AND 1 PRECEDING\n```\n\nDefine everything before the current month:\n\n```\n SELECT RUNAVG({metric/m}) WITHIN {attribute/year} ROWS BETWEEN UNBOUNDED PRECEDING AND 1 PRECEDING\n```";
+//# sourceMappingURL=rolling-window.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/runing-totals/rolling-window.d.ts.map

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

package/esm/docs/en/docs/create-metrics/maql/runing-totals/rolling-window.js

@@ -0,0 +1,71 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Rolling Window
+Use the ROWS BETWEEN keyword to specify a rolling window over which
+running total functions (for example RUNAVG) are computed.
+
+Running total functions such as RUNSUM, RUNAVG, RUNMIN and RUNMAX can be
+specified with rolling window or a shifted boundary. An example could be
+a moving average used with time series data to smooth out short-term
+fluctuations and highlight longer-term trends or cycles.
+
+ROWS BETWEEN does not currently support the COUNT or APPROXIMATE_COUNT function.
+
+## Syntax
+
+\`\`\`
+SELECT (RUNNING TOTAL)(...) ROWS BETWEEN (...) AND (...)
+SELECT RUNAVG (...) ROWS BETWEEN (…) AND (…)
+\`\`\`
+
+## Examples
+
+**In the context of Date**
+
+Define a moving average
+
+\`\`\`
+SELECT RUNAVG (Revenue) ROWS BETWEEN 5 PRECEDING AND CURRENT ROW
+\`\`\`
+
+Return Year-to-Date (YTD) for Revenue:
+
+\`\`\`
+SELECT RUNSUM (Revenue) WITHIN Year (Opp. Close) ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
+\`\`\`
+
+Define five days preceding and the current date:
+
+\`\`\`
+ SELECT RUNAVG({metric}) ROWS BETWEEN 5 PRECEDING AND CURRENT ROW
+\`\`\`
+
+\`\`\`
+SELECT RUNAVG({metric}) ROWS BETWEEN 5 PRECEDING AND 1 PRECEDING
+SELECT RUNAVG({metric}) ROWS BETWEEN 5 PRECEDING AND 1 FOLLOWING
+\`\`\`
+
+Display year to date - the same result as without specifying ROWS BETWEEN statement:
+
+\`\`\`
+SELECT RUNSUM({metric/m}) WITHIN {attribute/year} ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
+\`\`\`
+
+Define year to yesterday:
+
+\`\`\`
+SELECT RUNSUM({metric}/m) WITHIN {attribute/year} ROWS BETWEEN UNBOUNDED PRECEDING AND 1 PRECEDING ROW
+\`\`\`
+
+**In the context of Month**
+
+Define the last twelve months:
+
+\`\`\`
+SELECT RUNSUM({metric/m}) ROWS BETWEEN 13 PRECEDING AND 1 PRECEDING
+\`\`\`
+
+Define everything before the current month:
+
+\`\`\`
+ SELECT RUNAVG({metric/m}) WITHIN {attribute/year} ROWS BETWEEN UNBOUNDED PRECEDING AND 1 PRECEDING
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/runing-totals/running-total-statistical-functions.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Running Total Statistical Functions\nRunning Total Statistical Functions calculate the standard deviation or\nvariance using all values up to the current date for a fact or metric.\nFunctions are available for standard deviation, variance, and versions\nof those functions for populations. See [Standard Deviation Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/standard-deviation-functions/) and [Variance Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/variance-functions/).\n\nSuppose you are tracking daily production for your enterprise throughout\nthe month in a simple visualization tracking daily Units. You can use the\nRUNAVG and RUNSTDEV statistical functions to track the reliability of\nestimates as the month begins to close:\n\n\n| Date      |   Units  | Running Avg Daily Units |  Running StDev |\n| ------------ | ------- | ------------------------- | --------------- |\n| 06/02/2014|  50| 50.00|  (blank value) |\n| 06/03/2014|  60| 55.00|  7.07 |\n| 06/04/2014|  70| 60.00|  10.00 |\n| 06/05/2014|  50| 57.50|  9.57 |\n| 06/06/2014|  60| 58.00|  8.37 |\n| 06/09/2014|  80| 61.67|  11.69 |\n| 06/10/2014|  50| 60.00|  11.55 |\n| 06/11/2014|  70| 61.25|  11.26 |\n| 06/12/2014|  60| 61.11|  10.54 |\n| 06/13/2014|  80| 63.00|  11.60 |\n\n\nRunning total metrics can be broken down by two or more date attributes\nfrom the same date dimension. Non-date attributes are not supported.\n\n## Syntax\n\n```\nSELECT RUNSTDEV(...)\nSELECT RUNSTDEVP(...)\nSELECT RUNVAR(...)\nSELECT RUNVARP(...)\nSELECT RUNSTDEV(...) WITHIN (...)\n```\n\nThe value for WITHIN must be a date attribute.\n\n```\nSELECT RUNSTDEV(...) WITHIN (ALL OTHER)\n```\n\n## Examples\n\n```\nSELECT RUNVAR({fact/sales})\nSELECT RUNSTDEVP({metric/leads}) WHERE {label/date_ordered.year} = THIS\nSELECT RUNVARP({metric/returns}) WHERE {metric/amount} > 500000\nSELECT RUNSTDEV({metric/opportunities}) WITHIN ({label/date_ordered.quarter_year})\n```";
+//# sourceMappingURL=running-total-statistical-functions.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/runing-totals/running-total-statistical-functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"running-total-statistical-functions.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/runing-totals/running-total-statistical-functions.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,s/DAoDb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/runing-totals/running-total-statistical-functions.js

@@ -0,0 +1,54 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Running Total Statistical Functions
+Running Total Statistical Functions calculate the standard deviation or
+variance using all values up to the current date for a fact or metric.
+Functions are available for standard deviation, variance, and versions
+of those functions for populations. See [Standard Deviation Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/standard-deviation-functions/) and [Variance Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/variance-functions/).
+
+Suppose you are tracking daily production for your enterprise throughout
+the month in a simple visualization tracking daily Units. You can use the
+RUNAVG and RUNSTDEV statistical functions to track the reliability of
+estimates as the month begins to close:
+
+
+| Date      |   Units  | Running Avg Daily Units |  Running StDev |
+| ------------ | ------- | ------------------------- | --------------- |
+| 06/02/2014|  50| 50.00|  (blank value) |
+| 06/03/2014|  60| 55.00|  7.07 |
+| 06/04/2014|  70| 60.00|  10.00 |
+| 06/05/2014|  50| 57.50|  9.57 |
+| 06/06/2014|  60| 58.00|  8.37 |
+| 06/09/2014|  80| 61.67|  11.69 |
+| 06/10/2014|  50| 60.00|  11.55 |
+| 06/11/2014|  70| 61.25|  11.26 |
+| 06/12/2014|  60| 61.11|  10.54 |
+| 06/13/2014|  80| 63.00|  11.60 |
+
+
+Running total metrics can be broken down by two or more date attributes
+from the same date dimension. Non-date attributes are not supported.
+
+## Syntax
+
+\`\`\`
+SELECT RUNSTDEV(...)
+SELECT RUNSTDEVP(...)
+SELECT RUNVAR(...)
+SELECT RUNVARP(...)
+SELECT RUNSTDEV(...) WITHIN (...)
+\`\`\`
+
+The value for WITHIN must be a date attribute.
+
+\`\`\`
+SELECT RUNSTDEV(...) WITHIN (ALL OTHER)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT RUNVAR({fact/sales})
+SELECT RUNSTDEVP({metric/leads}) WHERE {label/date_ordered.year} = THIS
+SELECT RUNVARP({metric/returns}) WHERE {metric/amount} > 500000
+SELECT RUNSTDEV({metric/opportunities}) WITHIN ({label/date_ordered.quarter_year})
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/runing-totals/running-totals-for-core-functions.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Running Totals for Core Functions\nRunning Totals for Core Functions take the running sum, average,\nminimum, or maximum of a project fact or metric. In a table broken down\nby a date attribute, the running total value on any given day would be\ncalculated by aggregating values from all prior days along with that of\nthe current day.\n\nRunning total metrics can be broken down by two or more date attributes\nfrom the same date dimension. Non-date attributes are not supported.\n\n## Syntax\n\n```\nSELECT RUNSUM(...)\nSELECT RUNAVG(...)\nSELECT RUNMIN(...)\nSELECT RUNMAX(...)\nSELECT RUNSUM(...) WITHIN (...)\n```\n\nThe value for WITHIN must be a date attribute.\n\n```\nSELECT RUNSUM(...) WITHIN (ALL OTHER)\n```\n\n## Examples\n\n```\nSELECT RUNSUM({fact/sales})\nSELECT RUNSUM({fact/sales}) WITHIN({label/date.week})\nSELECT RUNSUM({fact/sales}) WITHIN({label/date.week}) BY {label/date}, {attribute/region}\nSELECT RUNMIN({fact/probability}) WHERE {label/date.year} = THIS AND {metric/amount} > 500000\nSELECT RUNMAX({fact/opportunity}) BY {label/date.quarter_year}\nSELECT RUNMAX({fact/sales}) WITHIN ({label/date.year}) WITHOUT PARENT FILTER\n```";
+//# sourceMappingURL=running-totals-for-core-functions.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/runing-totals/running-totals-for-core-functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"running-totals-for-core-functions.d.ts","sourceRoot":"","sources":["../../../../../../../src/docs/en/docs/create-metrics/maql/runing-totals/running-totals-for-core-functions.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,6oCAmCb,CAAC"}

package/esm/docs/en/docs/create-metrics/maql/runing-totals/running-totals-for-core-functions.js

@@ -0,0 +1,37 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Running Totals for Core Functions
+Running Totals for Core Functions take the running sum, average,
+minimum, or maximum of a project fact or metric. In a table broken down
+by a date attribute, the running total value on any given day would be
+calculated by aggregating values from all prior days along with that of
+the current day.
+
+Running total metrics can be broken down by two or more date attributes
+from the same date dimension. Non-date attributes are not supported.
+
+## Syntax
+
+\`\`\`
+SELECT RUNSUM(...)
+SELECT RUNAVG(...)
+SELECT RUNMIN(...)
+SELECT RUNMAX(...)
+SELECT RUNSUM(...) WITHIN (...)
+\`\`\`
+
+The value for WITHIN must be a date attribute.
+
+\`\`\`
+SELECT RUNSUM(...) WITHIN (ALL OTHER)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT RUNSUM({fact/sales})
+SELECT RUNSUM({fact/sales}) WITHIN({label/date.week})
+SELECT RUNSUM({fact/sales}) WITHIN({label/date.week}) BY {label/date}, {attribute/region}
+SELECT RUNMIN({fact/probability}) WHERE {label/date.year} = THIS AND {metric/amount} > 500000
+SELECT RUNMAX({fact/opportunity}) BY {label/date.quarter_year}
+SELECT RUNMAX({fact/sales}) WITHIN ({label/date.year}) WITHOUT PARENT FILTER
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/statistic/correl.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# CORREL\nCorrelation indicates the degree of association between two sets of\nvalues. The CORREL function returns correlation coefficient that varies\nbetween -1 and 1.\n\n-   A value of 1 indicates that as X increases, Y always increases.\n-   A value of -1 indicates that as X increases, Y always decreases.\n-   A value of 0 indicates that there is no correlation; values for X\n    cannot be used as predictors for values of Y.\n\nCorrelation coefficient is measured by calculating the covariance of the\ntwo sets of values, which measures how they vary with each other. This\nmeasure is then divided by the product of the standard deviations of\neach set of values. See [Covariance Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/covariance-functions/) and [Standard Deviation Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/standard-deviation-functions/).\n\nCorrelation coefficient is a component calculation of the Least-Squares\nmethod of linear regression. See [Least-Squares Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/least-squares-functions/).\n\nCORREL function has the form `CORREL (numeric1,numeric2)` where\n*numeric1* and *numeric2* are facts or metrics.\n\n![Equation - Correlation Coefficient](https://www.gooddata.com/developers/cloud-native/doc/maql/correl.png)\n\nWhen this equation is broken down into its component parts, it becomes\nthe following:\n\n![Equation - Correlation Coefficient decomposed](https://www.gooddata.com/developers/cloud-native/doc/maql/correl-coef.png)\n\nFor CORREL to work, metrics and facts must be associated with the same\ndataset or the same level of granularity.\n\n## Syntax\n\n```\nSELECT CORREL(\u2026)\nSELECT CORREL(metric1, metric2)\nSELECT CORREL(metric1, fact2)\nSELECT CORREL(fact1, fact2)\n```\n\n## Examples\n\n```\nSELECT CORREL({metric/production_volume}, {metric/rate_of_defects})\nSELECT CORREL({metric/gross_tonnage}, {metric/gross_profit})\n```";
+//# sourceMappingURL=correl.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/statistic/correl.d.ts.map

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

package/esm/docs/en/docs/create-metrics/maql/statistic/correl.js

@@ -0,0 +1,47 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# CORREL
+Correlation indicates the degree of association between two sets of
+values. The CORREL function returns correlation coefficient that varies
+between -1 and 1.
+
+-   A value of 1 indicates that as X increases, Y always increases.
+-   A value of -1 indicates that as X increases, Y always decreases.
+-   A value of 0 indicates that there is no correlation; values for X
+    cannot be used as predictors for values of Y.
+
+Correlation coefficient is measured by calculating the covariance of the
+two sets of values, which measures how they vary with each other. This
+measure is then divided by the product of the standard deviations of
+each set of values. See [Covariance Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/covariance-functions/) and [Standard Deviation Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/standard-deviation-functions/).
+
+Correlation coefficient is a component calculation of the Least-Squares
+method of linear regression. See [Least-Squares Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/least-squares-functions/).
+
+CORREL function has the form \`CORREL (numeric1,numeric2)\` where
+*numeric1* and *numeric2* are facts or metrics.
+
+![Equation - Correlation Coefficient](https://www.gooddata.com/developers/cloud-native/doc/maql/correl.png)
+
+When this equation is broken down into its component parts, it becomes
+the following:
+
+![Equation - Correlation Coefficient decomposed](https://www.gooddata.com/developers/cloud-native/doc/maql/correl-coef.png)
+
+For CORREL to work, metrics and facts must be associated with the same
+dataset or the same level of granularity.
+
+## Syntax
+
+\`\`\`
+SELECT CORREL(…)
+SELECT CORREL(metric1, metric2)
+SELECT CORREL(metric1, fact2)
+SELECT CORREL(fact1, fact2)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT CORREL({metric/production_volume}, {metric/rate_of_defects})
+SELECT CORREL({metric/gross_tonnage}, {metric/gross_profit})
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/statistic/covariance-functions.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Covariance Functions\nCovariance functions return the statistical covariance - how much two\nsets of values change together based on a sample of the population\n(COVAR), or based on a biased population (COVARP).\n\nCovariance measures how two sets of values vary together. This\nelementary function is used as a building block for some of the\ntwo-dimensional statistical functions used in linear regression, as it\ndescribes collectively how the two sets of values vary around their mean\nvalues.\n\n-   `COVAR (*numeric1*, *numeric2*)`\n\n    ![Equation -Covariance](https://www.gooddata.com/developers/cloud-native/doc/maql/covar.png)\n\n    -   where *numeric1* and *numeric2* are facts or metrics\n    -   Computes the product of variance from mean for each value of *x* and *y*. These values are summed and then divided by *n*.\n    -   Use for sets of values that are only a sample of the total (biased) population.\n\n-   `COVARP (*numeric1*, *numeric2*)`\n\n    ![Equation - Covariance for Populations](https://www.gooddata.com/developers/cloud-native/doc/maql/covarp.png)\n\n    -   where *numeric1* and *numeric2* are facts or metrics\n    -   Use COVARP for calculating covariances when the numeric values are the entire population of values.\n    -   Use for sets of values that include the entire (unbiased) population, use COVARP.\n\n## Syntax\n\n```\nSELECT COVAR(\u2026)\nSELECT COVAR(metric1, metric2)\nSELECT COVAR(fact1, metric2)\nSELECT COVAR(fact1, fact2)\nSELECT COVARP(metric1, metric2)\nSELECT COVARP(fact1, metric2)\nSELECT COVARP(fact1, fact2)\n```\n\n## Examples\n\n```\nSELECT COVAR({metric/total_cost_of_inputs}, {metric/gross_margin})\nSELECT COVARP({fact/height}, {fact/height})\n```";
+//# sourceMappingURL=covariance-functions.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/statistic/covariance-functions.d.ts.map

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

package/esm/docs/en/docs/create-metrics/maql/statistic/covariance-functions.js

@@ -0,0 +1,46 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Covariance Functions
+Covariance functions return the statistical covariance - how much two
+sets of values change together based on a sample of the population
+(COVAR), or based on a biased population (COVARP).
+
+Covariance measures how two sets of values vary together. This
+elementary function is used as a building block for some of the
+two-dimensional statistical functions used in linear regression, as it
+describes collectively how the two sets of values vary around their mean
+values.
+
+-   \`COVAR (*numeric1*, *numeric2*)\`
+
+    ![Equation -Covariance](https://www.gooddata.com/developers/cloud-native/doc/maql/covar.png)
+
+    -   where *numeric1* and *numeric2* are facts or metrics
+    -   Computes the product of variance from mean for each value of *x* and *y*. These values are summed and then divided by *n*.
+    -   Use for sets of values that are only a sample of the total (biased) population.
+
+-   \`COVARP (*numeric1*, *numeric2*)\`
+
+    ![Equation - Covariance for Populations](https://www.gooddata.com/developers/cloud-native/doc/maql/covarp.png)
+
+    -   where *numeric1* and *numeric2* are facts or metrics
+    -   Use COVARP for calculating covariances when the numeric values are the entire population of values.
+    -   Use for sets of values that include the entire (unbiased) population, use COVARP.
+
+## Syntax
+
+\`\`\`
+SELECT COVAR(…)
+SELECT COVAR(metric1, metric2)
+SELECT COVAR(fact1, metric2)
+SELECT COVAR(fact1, fact2)
+SELECT COVARP(metric1, metric2)
+SELECT COVARP(fact1, metric2)
+SELECT COVARP(fact1, fact2)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT COVAR({metric/total_cost_of_inputs}, {metric/gross_margin})
+SELECT COVARP({fact/height}, {fact/height})
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/statistic/forecast.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# FORECAST - Adding a Trend Line\nFORECAST functions returns linear regression estimates for up to 10\nfuture periods based on existing data. Second parameter is the number of\nperiods; the default is 3.\n\nUse the FORECAST function to add a trend line to a visualization. A trend\nline uses linear regression to predict future periods based on the existing\ndata. For example, you could use a trend line to predict future sales\nbased on your historical data. Forecast visualizations must have one date/time\nattribute on the X axis, and no other attributes.\n\n![forecast function](https://www.gooddata.com/developers/cloud-native/doc/maql/forecast.png)\n\n## Syntax\n\n```\nSELECT FORECAST(... [, number of periods])\n```\n\nOptionally, you can specify a number of periods to forecast.\n\n**Format:** number\n\n**Default:** 3\n\nAll visualization filters are applied to the metric that you FORECAST except\nfor date and time filters. To apply a date or time filter to the visualization,\nadd it directly to the metric. For example:\n\n```\nSELECT FORECAST((SELECT COUNT({attribute/activity}) WHERE {label/date.year} = \"2012\"), 6)\n```\n\n## Examples\n\n```\nSELECT FORECAST(SUM({fact/quantity}) , 6)\n```\n\nSuppose you create a forecast for the totals of `Deal Size` fact sliced\nby the `Month (Sale Closed)` attribute. Use the following metric to\ncompute the next three months based on all historical data:\n\n```\nSELECT FORECAST(SUM({metric/deal_size}))\n```\n\nThe following metric predicts Deal Size for the next six months:\n\n```\nSELECT FORECAST(SUM({metric/deal_size}), 6)\n```\n\nThe following metric predicts Deal Size for the next two months using data from\nthe previous year:\n\n```\nSELECT FORECAST((SELECT SUM({metric/deal_size}) WHERE {label/date.year} = PREVIOUS), 2)\n```\n\nThe following metric predicts Deal Size for the next two months using data from\nthe previous and current years:\n\n```\nSELECT FORECAST((SELECT SUM({metric/deal_size}) WHERE {label/date.year} = PREVIOUS OR {label/date.year} = THIS), 2)\n```\n\nThe following metric predicts Deal Size for the next four months using data from\nthe last twelve months:\n\n```\nSELECT FORECAST((SELECT SUM({metric/deal_size}) WHERE {label/date.month_year} >= THIS-12), 4)\n```";
+//# sourceMappingURL=forecast.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/statistic/forecast.d.ts.map

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

package/esm/docs/en/docs/create-metrics/maql/statistic/forecast.js

@@ -0,0 +1,74 @@
+// (C) 2022-2026 GoodData Corporation
+export const content = `# FORECAST - Adding a Trend Line
+FORECAST functions returns linear regression estimates for up to 10
+future periods based on existing data. Second parameter is the number of
+periods; the default is 3.
+
+Use the FORECAST function to add a trend line to a visualization. A trend
+line uses linear regression to predict future periods based on the existing
+data. For example, you could use a trend line to predict future sales
+based on your historical data. Forecast visualizations must have one date/time
+attribute on the X axis, and no other attributes.
+
+![forecast function](https://www.gooddata.com/developers/cloud-native/doc/maql/forecast.png)
+
+## Syntax
+
+\`\`\`
+SELECT FORECAST(... [, number of periods])
+\`\`\`
+
+Optionally, you can specify a number of periods to forecast.
+
+**Format:** number
+
+**Default:** 3
+
+All visualization filters are applied to the metric that you FORECAST except
+for date and time filters. To apply a date or time filter to the visualization,
+add it directly to the metric. For example:
+
+\`\`\`
+SELECT FORECAST((SELECT COUNT({attribute/activity}) WHERE {label/date.year} = "2012"), 6)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT FORECAST(SUM({fact/quantity}) , 6)
+\`\`\`
+
+Suppose you create a forecast for the totals of \`Deal Size\` fact sliced
+by the \`Month (Sale Closed)\` attribute. Use the following metric to
+compute the next three months based on all historical data:
+
+\`\`\`
+SELECT FORECAST(SUM({metric/deal_size}))
+\`\`\`
+
+The following metric predicts Deal Size for the next six months:
+
+\`\`\`
+SELECT FORECAST(SUM({metric/deal_size}), 6)
+\`\`\`
+
+The following metric predicts Deal Size for the next two months using data from
+the previous year:
+
+\`\`\`
+SELECT FORECAST((SELECT SUM({metric/deal_size}) WHERE {label/date.year} = PREVIOUS), 2)
+\`\`\`
+
+The following metric predicts Deal Size for the next two months using data from
+the previous and current years:
+
+\`\`\`
+SELECT FORECAST((SELECT SUM({metric/deal_size}) WHERE {label/date.year} = PREVIOUS OR {label/date.year} = THIS), 2)
+\`\`\`
+
+The following metric predicts Deal Size for the next four months using data from
+the last twelve months:
+
+\`\`\`
+SELECT FORECAST((SELECT SUM({metric/deal_size}) WHERE {label/date.month_year} >= THIS-12), 4)
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/statistic/least-squares-functions.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Least-Squares Functions\nThe **least-squares method** of linear regression attempts to fit a\nlinear regression trend line as closely as possible. This line has the\nsmallest possible value for the sum of the squares of the errors between\nthe predicted value of the line and the actual two-dimensional data\npoints.\n\nIn the following diagram, the least-squares linear regression plots a\nline through the set of points that minimizes the sum of the squares of\nthe error factors.\n\n![Least-Squares linear regression diagram](https://www.gooddata.com/developers/cloud-native/doc/maql/least-squares-linear-regression.png)\n\nThe actual data points are calculated using the following equation:\n\n![Least-squares data points](https://www.gooddata.com/developers/cloud-native/doc/maql/least-squares-data-points.png)\n\nUse the R-squared function (RSQ) that returns square of the correlation\ncoefficient to measure how well the linear regression expresses the\nvariability of the Y values around their mean.\n\n-   `RSQ (*numeric1*, *numeric2*)`\n    -   where *numeric1* and *numeric2* are facts or metrics\n    -   Computes the R-squared value for the two sets of numeric values.\n        Also known as the **coefficient of determination**, R-squared\n        ranges between 0 and 1, with a value of 1 indicating that the\n        model explains all variability in the dependent variables data.\n\n        R-squared does not determine if there is bias in the estimates.\n\n## Syntax\n\n```\nSELECT RSQ(metric1, metric2)\nSELECT RSQ(fact1, metric2)\nSELECT RSQ(fact1, fact2)\n```\n\n## Examples\n\n```\nSELECT RSQ({metric/count_of_defects}, {metric/production_volume})\n```";
+//# sourceMappingURL=least-squares-functions.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/statistic/least-squares-functions.d.ts.map

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

package/esm/docs/en/docs/create-metrics/maql/statistic/least-squares-functions.js

@@ -0,0 +1,44 @@
+// (C) 2021-2026 GoodData Corporation
+export const content = `# Least-Squares Functions
+The **least-squares method** of linear regression attempts to fit a
+linear regression trend line as closely as possible. This line has the
+smallest possible value for the sum of the squares of the errors between
+the predicted value of the line and the actual two-dimensional data
+points.
+
+In the following diagram, the least-squares linear regression plots a
+line through the set of points that minimizes the sum of the squares of
+the error factors.
+
+![Least-Squares linear regression diagram](https://www.gooddata.com/developers/cloud-native/doc/maql/least-squares-linear-regression.png)
+
+The actual data points are calculated using the following equation:
+
+![Least-squares data points](https://www.gooddata.com/developers/cloud-native/doc/maql/least-squares-data-points.png)
+
+Use the R-squared function (RSQ) that returns square of the correlation
+coefficient to measure how well the linear regression expresses the
+variability of the Y values around their mean.
+
+-   \`RSQ (*numeric1*, *numeric2*)\`
+    -   where *numeric1* and *numeric2* are facts or metrics
+    -   Computes the R-squared value for the two sets of numeric values.
+        Also known as the **coefficient of determination**, R-squared
+        ranges between 0 and 1, with a value of 1 indicating that the
+        model explains all variability in the dependent variables data.
+
+        R-squared does not determine if there is bias in the estimates.
+
+## Syntax
+
+\`\`\`
+SELECT RSQ(metric1, metric2)
+SELECT RSQ(fact1, metric2)
+SELECT RSQ(fact1, fact2)
+\`\`\`
+
+## Examples
+
+\`\`\`
+SELECT RSQ({metric/count_of_defects}, {metric/production_volume})
+\`\`\``;

package/esm/docs/en/docs/create-metrics/maql/statistic/standard-deviation-functions.d.ts

@@ -0,0 +1,2 @@
+export declare const content = "# Standard Deviation Functions\nStandard deviation function return the statistical standard deviation of\nall values in the set based on a sample of the population (STDEV), or\nbased on a biased population (STDEVP).\n\nStandard deviation is useful for measuring variance within a data set\nand, in application, confidence in statistical results. For example, in\nfinance, standard deviation can measure the potential deviation from\nexpected return rate, measuring the volatility of the investment.\nDepending on the number of values in the sample set, you should use\neither of the following metrics.\n\n-   `STDEV (*numeric*)`, also known as the **corrected standard deviation**\n\n    ![Equation - Standard Deviation](https://www.gooddata.com/developers/cloud-native/doc/maql/stdev.png)\n    -   where *numeric* is a fact or metric\n    -   Computes the sum of squared differences from the mean for *n*\n        values divided by a sample size factor. If the input values are\n        a sample of the total (biased) population, the divisor is *(n -\n        1)* sample size, which is used in the STDEV function.\n\n    -   This value is the **variance**. See [Variance Functions](https://www.gooddata.com/developers/cloud-native/doc/hosted/create-metrics/maql/statistic/variance-functions/). The square root of the above value represents the standard deviation.\n\n        If individual values are used as inputs, STDEV, generates a null\n        value. In these cases, use STDEVP instead.\n\n-   `STDEVP (*numeric*)`, also known as the **uncorrected standard deviation**.\n\n    ![Equation - Standard Deviation for Populations](https://www.gooddata.com/developers/cloud-native/doc/maql/stdevp.png )\n\n    -   where *numeric* is a fact or metric\n    -   Computes square root of the sum of squared differences from the mean for *n* values divided by *n*\n    -   Use STDEVP for calculating standard deviations if the input set\n        contains the entire (unbiased) population of values. The\n        deviation for a single value is zero.\n\n## Syntax\n\n```\nSELECT STDEV(\u2026)\nSELECT STDEV(metric)\nSELECT STDEVP(fact)\n```\n\n## Examples\n\n```\nSELECT STDEV({metric/internal_rate_of_return})\nSELECT STDEVP({metric/gross_weight})\n```\n\n## Using Standard Deviation\n\nYou can use standard deviation to create ranges as other metrics.\nSuppose you have a standard deviation metric (StDev Transaction Amt):\n\n### Example 1: +1 Std.\n\n```\nSELECT {metric/avg_transaction_amt} + {metric/stdev_transaction_amt}\n```\n\n### Example 2: +2 Std.\n\n```\nSELECT {metric/avg_transaction_amt} + ({metric/stdev_transaction_amt} * 2)\n```\n\n### Example 3: -1 Std.\n\n```\nSELECT {metric/avg_transaction_amt} + ({metric/stdev_transaction_amt} * -1)\n```\n\n### Example 4: -2 Std.\n\n```\nSELECT {metric/avg_transaction_amt} + ({metric/stdev_transaction_amt} * -2)\n```\n\n### Sample Chart\n\nUsing the examples above, you can create a combo chart that shows all\nindividual transactions (X axis) and where they fall within bands of\n+2/-2 standard deviations (Y axis).\n\n![Transaction amounts compared to standard deviations](https://www.gooddata.com/developers/cloud-native/doc/maql/stdev-transaction-accounts.png)";
+//# sourceMappingURL=standard-deviation-functions.d.ts.map

package/esm/docs/en/docs/create-metrics/maql/statistic/standard-deviation-functions.d.ts.map

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