From 5971b3a119ba192762d2ee9ff6a72a0d4e86d3f1 Mon Sep 17 00:00:00 2001 From: Duologic Date: Tue, 10 Dec 2024 11:11:31 +0100 Subject: [PATCH] run make generate again --- docs/API/alerting/contactPoint.md | 23 +- docs/API/alerting/notificationPolicy/index.md | 32 +- docs/API/alerting/ruleGroup/rule/data.md | 11 +- docs/API/librarypanel/index.md | 7 +- .../model/fieldConfig/defaults/links.md | 146 +++++ docs/API/query/athena.md | 256 +++++++++ docs/API/query/azureMonitor/index.md | 28 + docs/API/query/bigquery/index.md | 507 ++++++++++++++++++ docs/API/query/bigquery/sql/columns/index.md | 57 ++ .../query/bigquery/sql/columns/parameters.md | 29 + docs/API/query/bigquery/sql/groupBy.md | 70 +++ docs/API/query/cloudWatch/index.md | 84 +++ docs/API/query/elasticsearch/index.md | 30 +- .../query/expr/TypeClassicConditions/index.md | 23 +- docs/API/query/expr/TypeMath.md | 23 +- docs/API/query/expr/TypeReduce.md | 23 +- docs/API/query/expr/TypeResample.md | 23 +- docs/API/query/expr/TypeSql.md | 23 +- docs/API/query/expr/TypeThreshold/index.md | 23 +- docs/API/query/googleCloudMonitoring.md | 28 + docs/API/query/grafanaPyroscope.md | 30 +- docs/API/query/index.md | 2 + docs/API/query/loki.md | 30 +- docs/API/query/parca.md | 30 +- docs/API/query/prometheus.md | 30 +- docs/API/query/tempo/index.md | 30 +- docs/API/query/testData/index.md | 16 +- .../clean/alerting/contactPoint.libsonnet | 14 +- .../alerting/notificationPolicy.libsonnet | 22 +- .../clean/alerting/ruleGroup.libsonnet | 10 +- gen/grafonnet-v11.2.0/dashboard.libsonnet | 12 + .../docs/alerting/contactPoint.md | 23 +- .../docs/alerting/notificationPolicy/index.md | 32 +- .../docs/alerting/ruleGroup/rule/data.md | 11 +- .../docs/librarypanel/index.md | 7 +- .../model/fieldConfig/defaults/links.md | 146 +++++ gen/grafonnet-v11.2.0/docs/query/athena.md | 256 +++++++++ .../docs/query/azureMonitor/index.md | 28 + .../docs/query/bigquery/index.md | 507 ++++++++++++++++++ .../docs/query/bigquery/sql/columns/index.md | 57 ++ .../query/bigquery/sql/columns/parameters.md | 29 + .../docs/query/bigquery/sql/groupBy.md | 70 +++ .../docs/query/cloudWatch/index.md | 84 +++ .../docs/query/elasticsearch/index.md | 30 +- .../query/expr/TypeClassicConditions/index.md | 23 +- .../docs/query/expr/TypeMath.md | 23 +- .../docs/query/expr/TypeReduce.md | 23 +- .../docs/query/expr/TypeResample.md | 23 +- .../docs/query/expr/TypeSql.md | 23 +- .../docs/query/expr/TypeThreshold/index.md | 23 +- .../docs/query/googleCloudMonitoring.md | 28 + .../docs/query/grafanaPyroscope.md | 30 +- gen/grafonnet-v11.2.0/docs/query/index.md | 2 + gen/grafonnet-v11.2.0/docs/query/loki.md | 30 +- gen/grafonnet-v11.2.0/docs/query/parca.md | 30 +- .../docs/query/prometheus.md | 30 +- .../docs/query/tempo/index.md | 30 +- .../docs/query/testData/index.md | 16 +- gen/grafonnet-v11.2.0/librarypanel.libsonnet | 58 +- gen/grafonnet-v11.2.0/query.libsonnet | 2 + gen/grafonnet-v11.2.0/query/athena.libsonnet | 100 ++++ .../query/azureMonitor.libsonnet | 19 +- .../query/bigquery.libsonnet | 303 +++++++++++ .../query/cloudWatch.libsonnet | 57 +- .../query/elasticsearch.libsonnet | 19 +- gen/grafonnet-v11.2.0/query/expr.libsonnet | 108 ++-- .../query/googleCloudMonitoring.libsonnet | 19 +- .../query/grafanaPyroscope.libsonnet | 19 +- gen/grafonnet-v11.2.0/query/loki.libsonnet | 19 +- gen/grafonnet-v11.2.0/query/parca.libsonnet | 19 +- .../query/prometheus.libsonnet | 19 +- gen/grafonnet-v11.2.0/query/tempo.libsonnet | 19 +- .../query/testData.libsonnet | 14 +- generator/jsonnetfile.lock.json | 14 +- generator/query.libsonnet | 10 + 75 files changed, 3646 insertions(+), 458 deletions(-) create mode 100644 docs/API/librarypanel/model/fieldConfig/defaults/links.md create mode 100644 docs/API/query/athena.md create mode 100644 docs/API/query/bigquery/index.md create mode 100644 docs/API/query/bigquery/sql/columns/index.md create mode 100644 docs/API/query/bigquery/sql/columns/parameters.md create mode 100644 docs/API/query/bigquery/sql/groupBy.md create mode 100644 gen/grafonnet-v11.2.0/docs/librarypanel/model/fieldConfig/defaults/links.md create mode 100644 gen/grafonnet-v11.2.0/docs/query/athena.md create mode 100644 gen/grafonnet-v11.2.0/docs/query/bigquery/index.md create mode 100644 gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/index.md create mode 100644 gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/parameters.md create mode 100644 gen/grafonnet-v11.2.0/docs/query/bigquery/sql/groupBy.md create mode 100644 gen/grafonnet-v11.2.0/query/athena.libsonnet create mode 100644 gen/grafonnet-v11.2.0/query/bigquery.libsonnet diff --git a/docs/API/alerting/contactPoint.md b/docs/API/alerting/contactPoint.md index 65083ce7..b796b0c1 100644 --- a/docs/API/alerting/contactPoint.md +++ b/docs/API/alerting/contactPoint.md @@ -28,8 +28,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withName ```jsonnet @@ -40,8 +39,8 @@ PARAMETERS: * **value** (`string`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. +Name is used as grouping key in the UI. Contact points with the +same name will be grouped in the UI. ### fn withProvenance ```jsonnet @@ -52,8 +51,7 @@ PARAMETERS: * **value** (`string`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withSettings ```jsonnet @@ -64,8 +62,7 @@ PARAMETERS: * **value** (`object`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withSettingsMixin ```jsonnet @@ -76,8 +73,7 @@ PARAMETERS: * **value** (`object`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withType ```jsonnet @@ -89,8 +85,7 @@ PARAMETERS: * **value** (`string`) - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withUid ```jsonnet @@ -101,5 +96,5 @@ PARAMETERS: * **value** (`string`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. \ No newline at end of file +UID is the unique identifier of the contact point. The UID can be +set by the user. \ No newline at end of file diff --git a/docs/API/alerting/notificationPolicy/index.md b/docs/API/alerting/notificationPolicy/index.md index 00072439..cb4aa0a9 100644 --- a/docs/API/alerting/notificationPolicy/index.md +++ b/docs/API/alerting/notificationPolicy/index.md @@ -34,8 +34,7 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withContinue ```jsonnet @@ -47,8 +46,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupBy ```jsonnet @@ -59,8 +57,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupByMixin ```jsonnet @@ -71,8 +68,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupInterval ```jsonnet @@ -83,8 +79,7 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupWait ```jsonnet @@ -95,8 +90,7 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withMatchers ```jsonnet @@ -133,8 +127,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withMuteTimeIntervalsMixin ```jsonnet @@ -145,8 +138,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withPolicy ```jsonnet @@ -157,8 +149,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withPolicyMixin ```jsonnet @@ -169,8 +160,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withRepeatInterval ```jsonnet @@ -181,5 +171,3 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. \ No newline at end of file diff --git a/docs/API/alerting/ruleGroup/rule/data.md b/docs/API/alerting/ruleGroup/rule/data.md index abe5cdaa..adeccf04 100644 --- a/docs/API/alerting/ruleGroup/rule/data.md +++ b/docs/API/alerting/ruleGroup/rule/data.md @@ -27,7 +27,7 @@ PARAMETERS: * **value** (`string`) - +Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. ### fn withModel ```jsonnet @@ -38,7 +38,7 @@ PARAMETERS: * **value** (`object`) - +JSON is the raw JSON query and includes the above properties as well as custom properties. ### fn withModelMixin ```jsonnet @@ -49,7 +49,7 @@ PARAMETERS: * **value** (`object`) - +JSON is the raw JSON query and includes the above properties as well as custom properties. ### fn withQueryType ```jsonnet @@ -60,7 +60,8 @@ PARAMETERS: * **value** (`string`) - +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. ### fn withRefId ```jsonnet @@ -71,7 +72,7 @@ PARAMETERS: * **value** (`string`) - +RefID is the unique identifier of the query, set by the frontend call. ### fn withRelativeTimeRange ```jsonnet diff --git a/docs/API/librarypanel/index.md b/docs/API/librarypanel/index.md index 530f12ea..bfff6b40 100644 --- a/docs/API/librarypanel/index.md +++ b/docs/API/librarypanel/index.md @@ -4,6 +4,7 @@ grafonnet.librarypanel ## Subpackages +* [model.fieldConfig.defaults.links](model/fieldConfig/defaults/links.md) * [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md) * [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md) * [model.links](model/links.md) @@ -208,8 +209,7 @@ PARAMETERS: * **value** (`object`) -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; +Dashboard panels are the basic visualization building blocks. ### fn withModelMixin ```jsonnet @@ -220,8 +220,7 @@ PARAMETERS: * **value** (`object`) -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; +Dashboard panels are the basic visualization building blocks. ### fn withName ```jsonnet diff --git a/docs/API/librarypanel/model/fieldConfig/defaults/links.md b/docs/API/librarypanel/model/fieldConfig/defaults/links.md new file mode 100644 index 00000000..fcc060a9 --- /dev/null +++ b/docs/API/librarypanel/model/fieldConfig/defaults/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/docs/API/query/athena.md b/docs/API/query/athena.md new file mode 100644 index 00000000..74b4153e --- /dev/null +++ b/docs/API/query/athena.md @@ -0,0 +1,256 @@ +# athena + +grafonnet.query.athena + +## Index + +* [`fn withColumn(value)`](#fn-withcolumn) +* [`fn withConnectionArgs(value)`](#fn-withconnectionargs) +* [`fn withConnectionArgsMixin(value)`](#fn-withconnectionargsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withQueryID(value)`](#fn-withqueryid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawSQL(value="")`](#fn-withrawsql) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTable(value)`](#fn-withtable) +* [`obj connectionArgs`](#obj-connectionargs) + * [`fn withCatalog(value="__default")`](#fn-connectionargswithcatalog) + * [`fn withDatabase(value="__default")`](#fn-connectionargswithdatabase) + * [`fn withRegion(value="__default")`](#fn-connectionargswithregion) + * [`fn withResultReuseEnabled(value=true)`](#fn-connectionargswithresultreuseenabled) + * [`fn withResultReuseMaxAgeInMinutes(value=60)`](#fn-connectionargswithresultreusemaxageinminutes) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn withColumn + +```jsonnet +withColumn(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withConnectionArgs + +```jsonnet +withConnectionArgs(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConnectionArgsMixin + +```jsonnet +withConnectionArgsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1`, `2` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withQueryID + +```jsonnet +withQueryID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRawSQL + +```jsonnet +withRawSQL(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withTable + +```jsonnet +withTable(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj connectionArgs + + +#### fn connectionArgs.withCatalog + +```jsonnet +connectionArgs.withCatalog(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withDatabase + +```jsonnet +connectionArgs.withDatabase(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withRegion + +```jsonnet +connectionArgs.withRegion(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withResultReuseEnabled + +```jsonnet +connectionArgs.withResultReuseEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn connectionArgs.withResultReuseMaxAgeInMinutes + +```jsonnet +connectionArgs.withResultReuseMaxAgeInMinutes(value=60) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `60` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/azureMonitor/index.md b/docs/API/query/azureMonitor/index.md index ba09be0c..386256b2 100644 --- a/docs/API/query/azureMonitor/index.md +++ b/docs/API/query/azureMonitor/index.md @@ -78,6 +78,9 @@ grafonnet.query.azureMonitor * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) @@ -877,6 +880,31 @@ PARAMETERS: * **value** (`array`) Types of events to filter by. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj grafanaTemplateVariableFn diff --git a/docs/API/query/bigquery/index.md b/docs/API/query/bigquery/index.md new file mode 100644 index 00000000..41482bb0 --- /dev/null +++ b/docs/API/query/bigquery/index.md @@ -0,0 +1,507 @@ +# bigquery + +grafonnet.query.bigquery + +## Subpackages + +* [sql.columns](sql/columns/index.md) +* [sql.groupBy](sql/groupBy.md) + +## Index + +* [`fn withConvertToUTC(value=true)`](#fn-withconverttoutc) +* [`fn withDataset(value)`](#fn-withdataset) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withPartitioned(value=true)`](#fn-withpartitioned) +* [`fn withPartitionedField(value)`](#fn-withpartitionedfield) +* [`fn withProject(value)`](#fn-withproject) +* [`fn withQueryPriority(value)`](#fn-withquerypriority) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawQuery(value=true)`](#fn-withrawquery) +* [`fn withRawSql(value)`](#fn-withrawsql) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSharded(value=true)`](#fn-withsharded) +* [`fn withSql(value)`](#fn-withsql) +* [`fn withSqlMixin(value)`](#fn-withsqlmixin) +* [`fn withTable(value)`](#fn-withtable) +* [`fn withTimeShift(value)`](#fn-withtimeshift) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj sql`](#obj-sql) + * [`fn withColumns(value)`](#fn-sqlwithcolumns) + * [`fn withColumnsMixin(value)`](#fn-sqlwithcolumnsmixin) + * [`fn withFrom(value)`](#fn-sqlwithfrom) + * [`fn withGroupBy(value)`](#fn-sqlwithgroupby) + * [`fn withGroupByMixin(value)`](#fn-sqlwithgroupbymixin) + * [`fn withLimit(value)`](#fn-sqlwithlimit) + * [`fn withOffset(value)`](#fn-sqlwithoffset) + * [`fn withOrderBy(value)`](#fn-sqlwithorderby) + * [`fn withOrderByDirection(value)`](#fn-sqlwithorderbydirection) + * [`fn withOrderByMixin(value)`](#fn-sqlwithorderbymixin) + * [`fn withWhereString(value)`](#fn-sqlwithwherestring) + * [`obj orderBy`](#obj-sqlorderby) + * [`fn withProperty(value)`](#fn-sqlorderbywithproperty) + * [`fn withPropertyMixin(value)`](#fn-sqlorderbywithpropertymixin) + * [`fn withType()`](#fn-sqlorderbywithtype) + * [`obj property`](#obj-sqlorderbyproperty) + * [`fn withName(value)`](#fn-sqlorderbypropertywithname) + * [`fn withType(value)`](#fn-sqlorderbypropertywithtype) + +## Fields + +### fn withConvertToUTC + +```jsonnet +withConvertToUTC(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withDataset + +```jsonnet +withDataset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPartitioned + +```jsonnet +withPartitioned(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withPartitionedField + +```jsonnet +withPartitionedField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withProject + +```jsonnet +withProject(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryPriority + +```jsonnet +withQueryPriority(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"INTERACTIVE"`, `"BATCH"` + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRawQuery + +```jsonnet +withRawQuery(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withRawSql + +```jsonnet +withRawSql(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSharded + +```jsonnet +withSharded(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withSql + +```jsonnet +withSql(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSqlMixin + +```jsonnet +withSqlMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTable + +```jsonnet +withTable(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeShift + +```jsonnet +withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj sql + + +#### fn sql.withColumns + +```jsonnet +sql.withColumns(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withColumnsMixin + +```jsonnet +sql.withColumnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withFrom + +```jsonnet +sql.withFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn sql.withGroupBy + +```jsonnet +sql.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withGroupByMixin + +```jsonnet +sql.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withLimit + +```jsonnet +sql.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn sql.withOffset + +```jsonnet +sql.withOffset(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn sql.withOrderBy + +```jsonnet +sql.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sql.withOrderByDirection + +```jsonnet +sql.withOrderByDirection(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"ASC"`, `"DESC"` + + +#### fn sql.withOrderByMixin + +```jsonnet +sql.withOrderByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sql.withWhereString + +```jsonnet +sql.withWhereString(value) +``` + +PARAMETERS: + +* **value** (`string`) + +whereJsonTree?: _ +#### obj sql.orderBy + + +##### fn sql.orderBy.withProperty + +```jsonnet +sql.orderBy.withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn sql.orderBy.withPropertyMixin + +```jsonnet +sql.orderBy.withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn sql.orderBy.withType + +```jsonnet +sql.orderBy.withType() +``` + + + +##### obj sql.orderBy.property + + +###### fn sql.orderBy.property.withName + +```jsonnet +sql.orderBy.property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn sql.orderBy.property.withType + +```jsonnet +sql.orderBy.property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + diff --git a/docs/API/query/bigquery/sql/columns/index.md b/docs/API/query/bigquery/sql/columns/index.md new file mode 100644 index 00000000..fe30b54e --- /dev/null +++ b/docs/API/query/bigquery/sql/columns/index.md @@ -0,0 +1,57 @@ +# columns + + + +## Subpackages + +* [parameters](parameters.md) + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withParameters(value)`](#fn-withparameters) +* [`fn withParametersMixin(value)`](#fn-withparametersmixin) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withParameters + +```jsonnet +withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withParametersMixin + +```jsonnet +withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/docs/API/query/bigquery/sql/columns/parameters.md b/docs/API/query/bigquery/sql/columns/parameters.md new file mode 100644 index 00000000..d2fb19d9 --- /dev/null +++ b/docs/API/query/bigquery/sql/columns/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/docs/API/query/bigquery/sql/groupBy.md b/docs/API/query/bigquery/sql/groupBy.md new file mode 100644 index 00000000..d189eb5c --- /dev/null +++ b/docs/API/query/bigquery/sql/groupBy.md @@ -0,0 +1,70 @@ +# groupBy + + + +## Index + +* [`fn withProperty(value)`](#fn-withproperty) +* [`fn withPropertyMixin(value)`](#fn-withpropertymixin) +* [`fn withType()`](#fn-withtype) +* [`obj property`](#obj-property) + * [`fn withName(value)`](#fn-propertywithname) + * [`fn withType(value)`](#fn-propertywithtype) + +## Fields + +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPropertyMixin + +```jsonnet +withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType() +``` + + + +### obj property + + +#### fn property.withName + +```jsonnet +property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn property.withType + +```jsonnet +property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + diff --git a/docs/API/query/cloudWatch/index.md b/docs/API/query/cloudWatch/index.md index cc9a1cac..fdf74f86 100644 --- a/docs/API/query/cloudWatch/index.md +++ b/docs/API/query/cloudWatch/index.md @@ -31,6 +31,9 @@ grafonnet.query.cloudWatch * [`fn withStatistic(value)`](#fn-cloudwatchannotationquerywithstatistic) * [`fn withStatistics(value)`](#fn-cloudwatchannotationquerywithstatistics) * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) + * [`obj datasource`](#obj-cloudwatchannotationquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchannotationquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchannotationquerydatasourcewithuid) * [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) @@ -46,6 +49,9 @@ grafonnet.query.cloudWatch * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) + * [`obj datasource`](#obj-cloudwatchlogsquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchlogsquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchlogsquerydatasourcewithuid) * [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) @@ -72,6 +78,9 @@ grafonnet.query.cloudWatch * [`fn withStatistic(value)`](#fn-cloudwatchmetricsquerywithstatistic) * [`fn withStatistics(value)`](#fn-cloudwatchmetricsquerywithstatistics) * [`fn withStatisticsMixin(value)`](#fn-cloudwatchmetricsquerywithstatisticsmixin) + * [`obj datasource`](#obj-cloudwatchmetricsquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchmetricsquerydatasourcewithuid) * [`obj sql`](#obj-cloudwatchmetricsquerysql) * [`fn withFrom(value)`](#fn-cloudwatchmetricsquerysqlwithfrom) * [`fn withFromMixin(value)`](#fn-cloudwatchmetricsquerysqlwithfrommixin) @@ -349,6 +358,31 @@ PARAMETERS: * **value** (`array`) @deprecated use statistic +#### obj CloudWatchAnnotationQuery.datasource + + +##### fn CloudWatchAnnotationQuery.datasource.withType + +```jsonnet +CloudWatchAnnotationQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchAnnotationQuery.datasource.withUid + +```jsonnet +CloudWatchAnnotationQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj CloudWatchLogsQuery @@ -512,6 +546,31 @@ PARAMETERS: * **value** (`array`) Fields to group the results by, this field is automatically populated whenever the query is updated +#### obj CloudWatchLogsQuery.datasource + + +##### fn CloudWatchLogsQuery.datasource.withType + +```jsonnet +CloudWatchLogsQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchLogsQuery.datasource.withUid + +```jsonnet +CloudWatchLogsQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj CloudWatchMetricsQuery @@ -800,6 +859,31 @@ PARAMETERS: * **value** (`array`) @deprecated use statistic +#### obj CloudWatchMetricsQuery.datasource + + +##### fn CloudWatchMetricsQuery.datasource.withType + +```jsonnet +CloudWatchMetricsQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchMetricsQuery.datasource.withUid + +```jsonnet +CloudWatchMetricsQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance #### obj CloudWatchMetricsQuery.sql diff --git a/docs/API/query/elasticsearch/index.md b/docs/API/query/elasticsearch/index.md index a84eb5f7..e1b2ed7a 100644 --- a/docs/API/query/elasticsearch/index.md +++ b/docs/API/query/elasticsearch/index.md @@ -20,6 +20,9 @@ grafonnet.query.elasticsearch * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) * [`fn withTimeField(value)`](#fn-withtimefield) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -147,4 +150,29 @@ PARAMETERS: * **value** (`string`) -Name of time field \ No newline at end of file +Name of time field +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/expr/TypeClassicConditions/index.md b/docs/API/query/expr/TypeClassicConditions/index.md index e2b1f595..7d57ecab 100644 --- a/docs/API/query/expr/TypeClassicConditions/index.md +++ b/docs/API/query/expr/TypeClassicConditions/index.md @@ -23,8 +23,7 @@ grafonnet.query.expr.TypeClassicConditions * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -69,7 +68,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -80,7 +79,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withHide ```jsonnet @@ -203,25 +202,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -232,7 +223,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/docs/API/query/expr/TypeMath.md b/docs/API/query/expr/TypeMath.md index a8b85d20..5cdd6041 100644 --- a/docs/API/query/expr/TypeMath.md +++ b/docs/API/query/expr/TypeMath.md @@ -18,8 +18,7 @@ grafonnet.query.expr.TypeMath * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -42,7 +41,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -53,7 +52,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -187,25 +186,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -216,7 +207,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/docs/API/query/expr/TypeReduce.md b/docs/API/query/expr/TypeReduce.md index fd7c6053..1caafbde 100644 --- a/docs/API/query/expr/TypeReduce.md +++ b/docs/API/query/expr/TypeReduce.md @@ -21,8 +21,7 @@ grafonnet.query.expr.TypeReduce * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -48,7 +47,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -59,7 +58,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -235,25 +234,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -264,7 +255,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/docs/API/query/expr/TypeResample.md b/docs/API/query/expr/TypeResample.md index d68ca1d8..447283f9 100644 --- a/docs/API/query/expr/TypeResample.md +++ b/docs/API/query/expr/TypeResample.md @@ -21,8 +21,7 @@ grafonnet.query.expr.TypeResample * [`fn withUpsampler(value)`](#fn-withupsampler) * [`fn withWindow(value)`](#fn-withwindow) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -45,7 +44,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -56,7 +55,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDownsampler ```jsonnet @@ -237,25 +236,17 @@ The time duration ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -266,7 +257,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/docs/API/query/expr/TypeSql.md b/docs/API/query/expr/TypeSql.md index f0a46396..ac71f3e3 100644 --- a/docs/API/query/expr/TypeSql.md +++ b/docs/API/query/expr/TypeSql.md @@ -18,8 +18,7 @@ grafonnet.query.expr.TypeSql * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -42,7 +41,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -53,7 +52,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -187,25 +186,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -216,7 +207,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/docs/API/query/expr/TypeThreshold/index.md b/docs/API/query/expr/TypeThreshold/index.md index e2e47f1d..9d5783c8 100644 --- a/docs/API/query/expr/TypeThreshold/index.md +++ b/docs/API/query/expr/TypeThreshold/index.md @@ -24,8 +24,7 @@ grafonnet.query.expr.TypeThreshold * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -70,7 +69,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -81,7 +80,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -215,25 +214,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -244,7 +235,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/docs/API/query/googleCloudMonitoring.md b/docs/API/query/googleCloudMonitoring.md index b728940f..bdd9c76d 100644 --- a/docs/API/query/googleCloudMonitoring.md +++ b/docs/API/query/googleCloudMonitoring.md @@ -18,6 +18,9 @@ grafonnet.query.googleCloudMonitoring * [`fn withTimeSeriesListMixin(value)`](#fn-withtimeserieslistmixin) * [`fn withTimeSeriesQuery(value)`](#fn-withtimeseriesquery) * [`fn withTimeSeriesQueryMixin(value)`](#fn-withtimeseriesquerymixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj promQLQuery`](#obj-promqlquery) * [`fn withExpr(value)`](#fn-promqlquerywithexpr) * [`fn withProjectName(value)`](#fn-promqlquerywithprojectname) @@ -216,6 +219,31 @@ PARAMETERS: * **value** (`object`) Time Series sub-query properties. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj promQLQuery diff --git a/docs/API/query/grafanaPyroscope.md b/docs/API/query/grafanaPyroscope.md index c150bba7..a8dd6842 100644 --- a/docs/API/query/grafanaPyroscope.md +++ b/docs/API/query/grafanaPyroscope.md @@ -15,6 +15,9 @@ grafonnet.query.grafanaPyroscope * [`fn withRefId(value)`](#fn-withrefid) * [`fn withSpanSelector(value)`](#fn-withspanselector) * [`fn withSpanSelectorMixin(value)`](#fn-withspanselectormixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -143,4 +146,29 @@ PARAMETERS: * **value** (`array`) -Specifies the query span selectors. \ No newline at end of file +Specifies the query span selectors. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/index.md b/docs/API/query/index.md index 2e381972..2ca95883 100644 --- a/docs/API/query/index.md +++ b/docs/API/query/index.md @@ -4,7 +4,9 @@ grafonnet.query ## Subpackages +* [athena](athena.md) * [azureMonitor](azureMonitor/index.md) +* [bigquery](bigquery/index.md) * [cloudWatch](cloudWatch/index.md) * [elasticsearch](elasticsearch/index.md) * [expr](expr/index.md) diff --git a/docs/API/query/loki.md b/docs/API/query/loki.md index 2ebd28f2..56eb6c7d 100644 --- a/docs/API/query/loki.md +++ b/docs/API/query/loki.md @@ -17,6 +17,9 @@ grafonnet.query.loki * [`fn withRefId(value)`](#fn-withrefid) * [`fn withResolution(value)`](#fn-withresolution) * [`fn withStep(value)`](#fn-withstep) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -170,4 +173,29 @@ PARAMETERS: * **value** (`string`) -Used to set step value for range queries. \ No newline at end of file +Used to set step value for range queries. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/parca.md b/docs/API/query/parca.md index 03c73bfe..87909442 100644 --- a/docs/API/query/parca.md +++ b/docs/API/query/parca.md @@ -10,6 +10,9 @@ grafonnet.query.parca * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -83,4 +86,29 @@ PARAMETERS: A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/prometheus.md b/docs/API/query/prometheus.md index f35381ed..737c7538 100644 --- a/docs/API/query/prometheus.md +++ b/docs/API/query/prometheus.md @@ -18,6 +18,9 @@ grafonnet.query.prometheus * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRange(value=true)`](#fn-withrange) * [`fn withRefId(value)`](#fn-withrefid) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -185,4 +188,29 @@ PARAMETERS: A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/tempo/index.md b/docs/API/query/tempo/index.md index 3ef62e40..182301b2 100644 --- a/docs/API/query/tempo/index.md +++ b/docs/API/query/tempo/index.md @@ -31,6 +31,9 @@ grafonnet.query.tempo * [`fn withSpss(value)`](#fn-withspss) * [`fn withStep(value)`](#fn-withstep) * [`fn withTableType(value)`](#fn-withtabletype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -283,4 +286,29 @@ PARAMETERS: * **value** (`string`) - valid values: `"traces"`, `"spans"`, `"raw"` -The type of the table that is used to display the search results \ No newline at end of file +The type of the table that is used to display the search results +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/docs/API/query/testData/index.md b/docs/API/query/testData/index.md index 913802f1..7f02d6fe 100644 --- a/docs/API/query/testData/index.md +++ b/docs/API/query/testData/index.md @@ -54,7 +54,6 @@ grafonnet.query.testData * [`fn withUsaMixin(value)`](#fn-withusamixin) * [`fn withWithNil(value=true)`](#fn-withwithnil) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj nodes`](#obj-nodes) @@ -650,17 +649,6 @@ PARAMETERS: ### obj datasource -#### fn datasource.withApiVersion - -```jsonnet -datasource.withApiVersion(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The apiserver version #### fn datasource.withType ```jsonnet @@ -671,7 +659,7 @@ PARAMETERS: * **value** (`string`) -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -682,7 +670,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj nodes diff --git a/gen/grafonnet-v11.2.0/clean/alerting/contactPoint.libsonnet b/gen/grafonnet-v11.2.0/clean/alerting/contactPoint.libsonnet index b7678f95..13c81df1 100644 --- a/gen/grafonnet-v11.2.0/clean/alerting/contactPoint.libsonnet +++ b/gen/grafonnet-v11.2.0/clean/alerting/contactPoint.libsonnet @@ -1,31 +1,31 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, - '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, withDisableResolveMessage(value=true): { disableResolveMessage: value, }, - '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name is used as grouping key in the UI. Contact points with the\nsame name will be grouped in the UI.' } }, withName(value): { name: value, }, - '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withProvenance(value): { provenance: value, }, - '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, withSettings(value): { settings: value, }, - '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, withSettingsMixin(value): { settings+: value, }, - '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withType': { 'function': { args: [{ default: null, enums: ['alertmanager', ' dingding', ' discord', ' email', ' googlechat', ' kafka', ' line', ' opsgenie', ' pagerduty', ' pushover', ' sensugo', ' slack', ' teams', ' telegram', ' threema', ' victorops', ' webhook', ' wecom'], name: 'value', type: ['string'] }], help: '' } }, withType(value): { type: value, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'EmbeddedContactPoint is the contact point type that is used\nby grafanas embedded alertmanager implementation.' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID is the unique identifier of the contact point. The UID can be\nset by the user.' } }, withUid(value): { uid: value, }, diff --git a/gen/grafonnet-v11.2.0/clean/alerting/notificationPolicy.libsonnet b/gen/grafonnet-v11.2.0/clean/alerting/notificationPolicy.libsonnet index 618b6a9a..5de952e1 100644 --- a/gen/grafonnet-v11.2.0/clean/alerting/notificationPolicy.libsonnet +++ b/gen/grafonnet-v11.2.0/clean/alerting/notificationPolicy.libsonnet @@ -1,30 +1,30 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, - '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, withContinue(value=true): { continue: value, }, - '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withGroupInterval(value): { group_interval: value, }, - '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withGroupWait(value): { group_wait: value, }, - '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withRepeatInterval(value): { repeat_interval: value, }, - '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withGroupBy(value): { group_by: (if std.isArray(value) then value else [value]), }, - '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withGroupByMixin(value): { group_by+: (if std.isArray(value) @@ -45,32 +45,32 @@ then value else [value]), }, - '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withMuteTimeIntervals(value): { mute_time_intervals: (if std.isArray(value) then value else [value]), }, - '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withMuteTimeIntervalsMixin(value): { mute_time_intervals+: (if std.isArray(value) then value else [value]), }, - '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, withReceiver(value): { receiver: value, }, - '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withRoutes(value): { routes: (if std.isArray(value) then value else [value]), }, - '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withRoutesMixin(value): { routes+: (if std.isArray(value) diff --git a/gen/grafonnet-v11.2.0/clean/alerting/ruleGroup.libsonnet b/gen/grafonnet-v11.2.0/clean/alerting/ruleGroup.libsonnet index f844a0a2..92ddca43 100644 --- a/gen/grafonnet-v11.2.0/clean/alerting/ruleGroup.libsonnet +++ b/gen/grafonnet-v11.2.0/clean/alerting/ruleGroup.libsonnet @@ -98,23 +98,23 @@ data+: { '#': { help: '', name: 'data' }, - '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation." } }, withDatasourceUid(value): { datasourceUid: value, }, - '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, withModel(value): { model: value, }, - '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, withModelMixin(value): { model+: value, }, - '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, withQueryType(value): { queryType: value, }, - '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, withRefId(value): { refId: value, }, diff --git a/gen/grafonnet-v11.2.0/dashboard.libsonnet b/gen/grafonnet-v11.2.0/dashboard.libsonnet index e839a9f3..a3a064f4 100644 --- a/gen/grafonnet-v11.2.0/dashboard.libsonnet +++ b/gen/grafonnet-v11.2.0/dashboard.libsonnet @@ -424,6 +424,18 @@ withAllValue(value): { allValue: value, }, + '#withAuto': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Dynamically calculates interval by dividing time range by the count specified.' } }, + withAuto(value=true): { + auto: value, + }, + '#withAutoCount': { 'function': { args: [{ default: 30, enums: null, name: 'value', type: ['integer'] }], help: 'How many times the current time range should be divided to calculate the value, similar to the Max data points query option.\nFor example, if the current visible time range is 30 minutes, then the auto interval groups the data into 30 one-minute increments.' } }, + withAutoCount(value=30): { + auto_count: value, + }, + '#withAutoMin': { 'function': { args: [{ default: '10s', enums: null, name: 'value', type: ['string'] }], help: 'The minimum threshold below which the step count intervals will not divide the time.' } }, + withAutoMin(value='10s'): { + auto_min: value, + }, '#withCurrent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, withCurrent(value): { current: value, diff --git a/gen/grafonnet-v11.2.0/docs/alerting/contactPoint.md b/gen/grafonnet-v11.2.0/docs/alerting/contactPoint.md index 65083ce7..b796b0c1 100644 --- a/gen/grafonnet-v11.2.0/docs/alerting/contactPoint.md +++ b/gen/grafonnet-v11.2.0/docs/alerting/contactPoint.md @@ -28,8 +28,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withName ```jsonnet @@ -40,8 +39,8 @@ PARAMETERS: * **value** (`string`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. +Name is used as grouping key in the UI. Contact points with the +same name will be grouped in the UI. ### fn withProvenance ```jsonnet @@ -52,8 +51,7 @@ PARAMETERS: * **value** (`string`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withSettings ```jsonnet @@ -64,8 +62,7 @@ PARAMETERS: * **value** (`object`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withSettingsMixin ```jsonnet @@ -76,8 +73,7 @@ PARAMETERS: * **value** (`object`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withType ```jsonnet @@ -89,8 +85,7 @@ PARAMETERS: * **value** (`string`) - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. + ### fn withUid ```jsonnet @@ -101,5 +96,5 @@ PARAMETERS: * **value** (`string`) -EmbeddedContactPoint is the contact point type that is used -by grafanas embedded alertmanager implementation. \ No newline at end of file +UID is the unique identifier of the contact point. The UID can be +set by the user. \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/alerting/notificationPolicy/index.md b/gen/grafonnet-v11.2.0/docs/alerting/notificationPolicy/index.md index 00072439..cb4aa0a9 100644 --- a/gen/grafonnet-v11.2.0/docs/alerting/notificationPolicy/index.md +++ b/gen/grafonnet-v11.2.0/docs/alerting/notificationPolicy/index.md @@ -34,8 +34,7 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withContinue ```jsonnet @@ -47,8 +46,7 @@ PARAMETERS: * **value** (`boolean`) - default value: `true` -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupBy ```jsonnet @@ -59,8 +57,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupByMixin ```jsonnet @@ -71,8 +68,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupInterval ```jsonnet @@ -83,8 +79,7 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withGroupWait ```jsonnet @@ -95,8 +90,7 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withMatchers ```jsonnet @@ -133,8 +127,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withMuteTimeIntervalsMixin ```jsonnet @@ -145,8 +138,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withPolicy ```jsonnet @@ -157,8 +149,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withPolicyMixin ```jsonnet @@ -169,8 +160,7 @@ PARAMETERS: * **value** (`array`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. + ### fn withRepeatInterval ```jsonnet @@ -181,5 +171,3 @@ PARAMETERS: * **value** (`string`) -A Route is a node that contains definitions of how to handle alerts. This is modified -from the upstream alertmanager in that it adds the ObjectMatchers property. \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/alerting/ruleGroup/rule/data.md b/gen/grafonnet-v11.2.0/docs/alerting/ruleGroup/rule/data.md index abe5cdaa..adeccf04 100644 --- a/gen/grafonnet-v11.2.0/docs/alerting/ruleGroup/rule/data.md +++ b/gen/grafonnet-v11.2.0/docs/alerting/ruleGroup/rule/data.md @@ -27,7 +27,7 @@ PARAMETERS: * **value** (`string`) - +Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. ### fn withModel ```jsonnet @@ -38,7 +38,7 @@ PARAMETERS: * **value** (`object`) - +JSON is the raw JSON query and includes the above properties as well as custom properties. ### fn withModelMixin ```jsonnet @@ -49,7 +49,7 @@ PARAMETERS: * **value** (`object`) - +JSON is the raw JSON query and includes the above properties as well as custom properties. ### fn withQueryType ```jsonnet @@ -60,7 +60,8 @@ PARAMETERS: * **value** (`string`) - +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. ### fn withRefId ```jsonnet @@ -71,7 +72,7 @@ PARAMETERS: * **value** (`string`) - +RefID is the unique identifier of the query, set by the frontend call. ### fn withRelativeTimeRange ```jsonnet diff --git a/gen/grafonnet-v11.2.0/docs/librarypanel/index.md b/gen/grafonnet-v11.2.0/docs/librarypanel/index.md index 530f12ea..bfff6b40 100644 --- a/gen/grafonnet-v11.2.0/docs/librarypanel/index.md +++ b/gen/grafonnet-v11.2.0/docs/librarypanel/index.md @@ -4,6 +4,7 @@ grafonnet.librarypanel ## Subpackages +* [model.fieldConfig.defaults.links](model/fieldConfig/defaults/links.md) * [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md) * [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md) * [model.links](model/links.md) @@ -208,8 +209,7 @@ PARAMETERS: * **value** (`object`) -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; +Dashboard panels are the basic visualization building blocks. ### fn withModelMixin ```jsonnet @@ -220,8 +220,7 @@ PARAMETERS: * **value** (`object`) -TODO: should be the same panel schema defined in dashboard -Typescript: Omit; +Dashboard panels are the basic visualization building blocks. ### fn withName ```jsonnet diff --git a/gen/grafonnet-v11.2.0/docs/librarypanel/model/fieldConfig/defaults/links.md b/gen/grafonnet-v11.2.0/docs/librarypanel/model/fieldConfig/defaults/links.md new file mode 100644 index 00000000..fcc060a9 --- /dev/null +++ b/gen/grafonnet-v11.2.0/docs/librarypanel/model/fieldConfig/defaults/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/athena.md b/gen/grafonnet-v11.2.0/docs/query/athena.md new file mode 100644 index 00000000..74b4153e --- /dev/null +++ b/gen/grafonnet-v11.2.0/docs/query/athena.md @@ -0,0 +1,256 @@ +# athena + +grafonnet.query.athena + +## Index + +* [`fn withColumn(value)`](#fn-withcolumn) +* [`fn withConnectionArgs(value)`](#fn-withconnectionargs) +* [`fn withConnectionArgsMixin(value)`](#fn-withconnectionargsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withQueryID(value)`](#fn-withqueryid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawSQL(value="")`](#fn-withrawsql) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTable(value)`](#fn-withtable) +* [`obj connectionArgs`](#obj-connectionargs) + * [`fn withCatalog(value="__default")`](#fn-connectionargswithcatalog) + * [`fn withDatabase(value="__default")`](#fn-connectionargswithdatabase) + * [`fn withRegion(value="__default")`](#fn-connectionargswithregion) + * [`fn withResultReuseEnabled(value=true)`](#fn-connectionargswithresultreuseenabled) + * [`fn withResultReuseMaxAgeInMinutes(value=60)`](#fn-connectionargswithresultreusemaxageinminutes) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn withColumn + +```jsonnet +withColumn(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withConnectionArgs + +```jsonnet +withConnectionArgs(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConnectionArgsMixin + +```jsonnet +withConnectionArgsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1`, `2` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withQueryID + +```jsonnet +withQueryID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRawSQL + +```jsonnet +withRawSQL(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withTable + +```jsonnet +withTable(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj connectionArgs + + +#### fn connectionArgs.withCatalog + +```jsonnet +connectionArgs.withCatalog(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withDatabase + +```jsonnet +connectionArgs.withDatabase(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withRegion + +```jsonnet +connectionArgs.withRegion(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withResultReuseEnabled + +```jsonnet +connectionArgs.withResultReuseEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn connectionArgs.withResultReuseMaxAgeInMinutes + +```jsonnet +connectionArgs.withResultReuseMaxAgeInMinutes(value=60) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `60` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/azureMonitor/index.md b/gen/grafonnet-v11.2.0/docs/query/azureMonitor/index.md index ba09be0c..386256b2 100644 --- a/gen/grafonnet-v11.2.0/docs/query/azureMonitor/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/azureMonitor/index.md @@ -78,6 +78,9 @@ grafonnet.query.azureMonitor * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) @@ -877,6 +880,31 @@ PARAMETERS: * **value** (`array`) Types of events to filter by. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj grafanaTemplateVariableFn diff --git a/gen/grafonnet-v11.2.0/docs/query/bigquery/index.md b/gen/grafonnet-v11.2.0/docs/query/bigquery/index.md new file mode 100644 index 00000000..41482bb0 --- /dev/null +++ b/gen/grafonnet-v11.2.0/docs/query/bigquery/index.md @@ -0,0 +1,507 @@ +# bigquery + +grafonnet.query.bigquery + +## Subpackages + +* [sql.columns](sql/columns/index.md) +* [sql.groupBy](sql/groupBy.md) + +## Index + +* [`fn withConvertToUTC(value=true)`](#fn-withconverttoutc) +* [`fn withDataset(value)`](#fn-withdataset) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withPartitioned(value=true)`](#fn-withpartitioned) +* [`fn withPartitionedField(value)`](#fn-withpartitionedfield) +* [`fn withProject(value)`](#fn-withproject) +* [`fn withQueryPriority(value)`](#fn-withquerypriority) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawQuery(value=true)`](#fn-withrawquery) +* [`fn withRawSql(value)`](#fn-withrawsql) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSharded(value=true)`](#fn-withsharded) +* [`fn withSql(value)`](#fn-withsql) +* [`fn withSqlMixin(value)`](#fn-withsqlmixin) +* [`fn withTable(value)`](#fn-withtable) +* [`fn withTimeShift(value)`](#fn-withtimeshift) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj sql`](#obj-sql) + * [`fn withColumns(value)`](#fn-sqlwithcolumns) + * [`fn withColumnsMixin(value)`](#fn-sqlwithcolumnsmixin) + * [`fn withFrom(value)`](#fn-sqlwithfrom) + * [`fn withGroupBy(value)`](#fn-sqlwithgroupby) + * [`fn withGroupByMixin(value)`](#fn-sqlwithgroupbymixin) + * [`fn withLimit(value)`](#fn-sqlwithlimit) + * [`fn withOffset(value)`](#fn-sqlwithoffset) + * [`fn withOrderBy(value)`](#fn-sqlwithorderby) + * [`fn withOrderByDirection(value)`](#fn-sqlwithorderbydirection) + * [`fn withOrderByMixin(value)`](#fn-sqlwithorderbymixin) + * [`fn withWhereString(value)`](#fn-sqlwithwherestring) + * [`obj orderBy`](#obj-sqlorderby) + * [`fn withProperty(value)`](#fn-sqlorderbywithproperty) + * [`fn withPropertyMixin(value)`](#fn-sqlorderbywithpropertymixin) + * [`fn withType()`](#fn-sqlorderbywithtype) + * [`obj property`](#obj-sqlorderbyproperty) + * [`fn withName(value)`](#fn-sqlorderbypropertywithname) + * [`fn withType(value)`](#fn-sqlorderbypropertywithtype) + +## Fields + +### fn withConvertToUTC + +```jsonnet +withConvertToUTC(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withDataset + +```jsonnet +withDataset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPartitioned + +```jsonnet +withPartitioned(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withPartitionedField + +```jsonnet +withPartitionedField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withProject + +```jsonnet +withProject(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryPriority + +```jsonnet +withQueryPriority(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"INTERACTIVE"`, `"BATCH"` + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRawQuery + +```jsonnet +withRawQuery(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withRawSql + +```jsonnet +withRawSql(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSharded + +```jsonnet +withSharded(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withSql + +```jsonnet +withSql(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSqlMixin + +```jsonnet +withSqlMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTable + +```jsonnet +withTable(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeShift + +```jsonnet +withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj sql + + +#### fn sql.withColumns + +```jsonnet +sql.withColumns(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withColumnsMixin + +```jsonnet +sql.withColumnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withFrom + +```jsonnet +sql.withFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn sql.withGroupBy + +```jsonnet +sql.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withGroupByMixin + +```jsonnet +sql.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withLimit + +```jsonnet +sql.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn sql.withOffset + +```jsonnet +sql.withOffset(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn sql.withOrderBy + +```jsonnet +sql.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sql.withOrderByDirection + +```jsonnet +sql.withOrderByDirection(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"ASC"`, `"DESC"` + + +#### fn sql.withOrderByMixin + +```jsonnet +sql.withOrderByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sql.withWhereString + +```jsonnet +sql.withWhereString(value) +``` + +PARAMETERS: + +* **value** (`string`) + +whereJsonTree?: _ +#### obj sql.orderBy + + +##### fn sql.orderBy.withProperty + +```jsonnet +sql.orderBy.withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn sql.orderBy.withPropertyMixin + +```jsonnet +sql.orderBy.withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn sql.orderBy.withType + +```jsonnet +sql.orderBy.withType() +``` + + + +##### obj sql.orderBy.property + + +###### fn sql.orderBy.property.withName + +```jsonnet +sql.orderBy.property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn sql.orderBy.property.withType + +```jsonnet +sql.orderBy.property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + diff --git a/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/index.md b/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/index.md new file mode 100644 index 00000000..fe30b54e --- /dev/null +++ b/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/index.md @@ -0,0 +1,57 @@ +# columns + + + +## Subpackages + +* [parameters](parameters.md) + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withParameters(value)`](#fn-withparameters) +* [`fn withParametersMixin(value)`](#fn-withparametersmixin) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withParameters + +```jsonnet +withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withParametersMixin + +```jsonnet +withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/parameters.md b/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/parameters.md new file mode 100644 index 00000000..d2fb19d9 --- /dev/null +++ b/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/columns/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/groupBy.md b/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/groupBy.md new file mode 100644 index 00000000..d189eb5c --- /dev/null +++ b/gen/grafonnet-v11.2.0/docs/query/bigquery/sql/groupBy.md @@ -0,0 +1,70 @@ +# groupBy + + + +## Index + +* [`fn withProperty(value)`](#fn-withproperty) +* [`fn withPropertyMixin(value)`](#fn-withpropertymixin) +* [`fn withType()`](#fn-withtype) +* [`obj property`](#obj-property) + * [`fn withName(value)`](#fn-propertywithname) + * [`fn withType(value)`](#fn-propertywithtype) + +## Fields + +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPropertyMixin + +```jsonnet +withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType() +``` + + + +### obj property + + +#### fn property.withName + +```jsonnet +property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn property.withType + +```jsonnet +property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + diff --git a/gen/grafonnet-v11.2.0/docs/query/cloudWatch/index.md b/gen/grafonnet-v11.2.0/docs/query/cloudWatch/index.md index cc9a1cac..fdf74f86 100644 --- a/gen/grafonnet-v11.2.0/docs/query/cloudWatch/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/cloudWatch/index.md @@ -31,6 +31,9 @@ grafonnet.query.cloudWatch * [`fn withStatistic(value)`](#fn-cloudwatchannotationquerywithstatistic) * [`fn withStatistics(value)`](#fn-cloudwatchannotationquerywithstatistics) * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) + * [`obj datasource`](#obj-cloudwatchannotationquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchannotationquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchannotationquerydatasourcewithuid) * [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) @@ -46,6 +49,9 @@ grafonnet.query.cloudWatch * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) + * [`obj datasource`](#obj-cloudwatchlogsquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchlogsquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchlogsquerydatasourcewithuid) * [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) @@ -72,6 +78,9 @@ grafonnet.query.cloudWatch * [`fn withStatistic(value)`](#fn-cloudwatchmetricsquerywithstatistic) * [`fn withStatistics(value)`](#fn-cloudwatchmetricsquerywithstatistics) * [`fn withStatisticsMixin(value)`](#fn-cloudwatchmetricsquerywithstatisticsmixin) + * [`obj datasource`](#obj-cloudwatchmetricsquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchmetricsquerydatasourcewithuid) * [`obj sql`](#obj-cloudwatchmetricsquerysql) * [`fn withFrom(value)`](#fn-cloudwatchmetricsquerysqlwithfrom) * [`fn withFromMixin(value)`](#fn-cloudwatchmetricsquerysqlwithfrommixin) @@ -349,6 +358,31 @@ PARAMETERS: * **value** (`array`) @deprecated use statistic +#### obj CloudWatchAnnotationQuery.datasource + + +##### fn CloudWatchAnnotationQuery.datasource.withType + +```jsonnet +CloudWatchAnnotationQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchAnnotationQuery.datasource.withUid + +```jsonnet +CloudWatchAnnotationQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj CloudWatchLogsQuery @@ -512,6 +546,31 @@ PARAMETERS: * **value** (`array`) Fields to group the results by, this field is automatically populated whenever the query is updated +#### obj CloudWatchLogsQuery.datasource + + +##### fn CloudWatchLogsQuery.datasource.withType + +```jsonnet +CloudWatchLogsQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchLogsQuery.datasource.withUid + +```jsonnet +CloudWatchLogsQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj CloudWatchMetricsQuery @@ -800,6 +859,31 @@ PARAMETERS: * **value** (`array`) @deprecated use statistic +#### obj CloudWatchMetricsQuery.datasource + + +##### fn CloudWatchMetricsQuery.datasource.withType + +```jsonnet +CloudWatchMetricsQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchMetricsQuery.datasource.withUid + +```jsonnet +CloudWatchMetricsQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance #### obj CloudWatchMetricsQuery.sql diff --git a/gen/grafonnet-v11.2.0/docs/query/elasticsearch/index.md b/gen/grafonnet-v11.2.0/docs/query/elasticsearch/index.md index a84eb5f7..e1b2ed7a 100644 --- a/gen/grafonnet-v11.2.0/docs/query/elasticsearch/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/elasticsearch/index.md @@ -20,6 +20,9 @@ grafonnet.query.elasticsearch * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) * [`fn withTimeField(value)`](#fn-withtimefield) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -147,4 +150,29 @@ PARAMETERS: * **value** (`string`) -Name of time field \ No newline at end of file +Name of time field +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/expr/TypeClassicConditions/index.md b/gen/grafonnet-v11.2.0/docs/query/expr/TypeClassicConditions/index.md index e2b1f595..7d57ecab 100644 --- a/gen/grafonnet-v11.2.0/docs/query/expr/TypeClassicConditions/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/expr/TypeClassicConditions/index.md @@ -23,8 +23,7 @@ grafonnet.query.expr.TypeClassicConditions * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -69,7 +68,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -80,7 +79,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withHide ```jsonnet @@ -203,25 +202,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -232,7 +223,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/gen/grafonnet-v11.2.0/docs/query/expr/TypeMath.md b/gen/grafonnet-v11.2.0/docs/query/expr/TypeMath.md index a8b85d20..5cdd6041 100644 --- a/gen/grafonnet-v11.2.0/docs/query/expr/TypeMath.md +++ b/gen/grafonnet-v11.2.0/docs/query/expr/TypeMath.md @@ -18,8 +18,7 @@ grafonnet.query.expr.TypeMath * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -42,7 +41,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -53,7 +52,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -187,25 +186,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -216,7 +207,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/gen/grafonnet-v11.2.0/docs/query/expr/TypeReduce.md b/gen/grafonnet-v11.2.0/docs/query/expr/TypeReduce.md index fd7c6053..1caafbde 100644 --- a/gen/grafonnet-v11.2.0/docs/query/expr/TypeReduce.md +++ b/gen/grafonnet-v11.2.0/docs/query/expr/TypeReduce.md @@ -21,8 +21,7 @@ grafonnet.query.expr.TypeReduce * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -48,7 +47,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -59,7 +58,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -235,25 +234,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -264,7 +255,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/gen/grafonnet-v11.2.0/docs/query/expr/TypeResample.md b/gen/grafonnet-v11.2.0/docs/query/expr/TypeResample.md index d68ca1d8..447283f9 100644 --- a/gen/grafonnet-v11.2.0/docs/query/expr/TypeResample.md +++ b/gen/grafonnet-v11.2.0/docs/query/expr/TypeResample.md @@ -21,8 +21,7 @@ grafonnet.query.expr.TypeResample * [`fn withUpsampler(value)`](#fn-withupsampler) * [`fn withWindow(value)`](#fn-withwindow) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -45,7 +44,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -56,7 +55,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDownsampler ```jsonnet @@ -237,25 +236,17 @@ The time duration ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -266,7 +257,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/gen/grafonnet-v11.2.0/docs/query/expr/TypeSql.md b/gen/grafonnet-v11.2.0/docs/query/expr/TypeSql.md index f0a46396..ac71f3e3 100644 --- a/gen/grafonnet-v11.2.0/docs/query/expr/TypeSql.md +++ b/gen/grafonnet-v11.2.0/docs/query/expr/TypeSql.md @@ -18,8 +18,7 @@ grafonnet.query.expr.TypeSql * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -42,7 +41,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -53,7 +52,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -187,25 +186,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -216,7 +207,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/gen/grafonnet-v11.2.0/docs/query/expr/TypeThreshold/index.md b/gen/grafonnet-v11.2.0/docs/query/expr/TypeThreshold/index.md index e2e47f1d..9d5783c8 100644 --- a/gen/grafonnet-v11.2.0/docs/query/expr/TypeThreshold/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/expr/TypeThreshold/index.md @@ -24,8 +24,7 @@ grafonnet.query.expr.TypeThreshold * [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) * [`fn withType()`](#fn-withtype) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) - * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj resultAssertions`](#obj-resultassertions) * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) @@ -70,7 +69,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withDatasourceMixin ```jsonnet @@ -81,7 +80,7 @@ PARAMETERS: * **value** (`object`) -The datasource +Ref to a DataSource instance ### fn withExpression ```jsonnet @@ -215,25 +214,17 @@ withType() ### obj datasource -#### fn datasource.withApiVersion +#### fn datasource.withType ```jsonnet -datasource.withApiVersion(value) +datasource.withType(value) ``` PARAMETERS: * **value** (`string`) -The apiserver version -#### fn datasource.withType - -```jsonnet -datasource.withType() -``` - - -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -244,7 +235,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj resultAssertions diff --git a/gen/grafonnet-v11.2.0/docs/query/googleCloudMonitoring.md b/gen/grafonnet-v11.2.0/docs/query/googleCloudMonitoring.md index b728940f..bdd9c76d 100644 --- a/gen/grafonnet-v11.2.0/docs/query/googleCloudMonitoring.md +++ b/gen/grafonnet-v11.2.0/docs/query/googleCloudMonitoring.md @@ -18,6 +18,9 @@ grafonnet.query.googleCloudMonitoring * [`fn withTimeSeriesListMixin(value)`](#fn-withtimeserieslistmixin) * [`fn withTimeSeriesQuery(value)`](#fn-withtimeseriesquery) * [`fn withTimeSeriesQueryMixin(value)`](#fn-withtimeseriesquerymixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj promQLQuery`](#obj-promqlquery) * [`fn withExpr(value)`](#fn-promqlquerywithexpr) * [`fn withProjectName(value)`](#fn-promqlquerywithprojectname) @@ -216,6 +219,31 @@ PARAMETERS: * **value** (`object`) Time Series sub-query properties. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance ### obj promQLQuery diff --git a/gen/grafonnet-v11.2.0/docs/query/grafanaPyroscope.md b/gen/grafonnet-v11.2.0/docs/query/grafanaPyroscope.md index c150bba7..a8dd6842 100644 --- a/gen/grafonnet-v11.2.0/docs/query/grafanaPyroscope.md +++ b/gen/grafonnet-v11.2.0/docs/query/grafanaPyroscope.md @@ -15,6 +15,9 @@ grafonnet.query.grafanaPyroscope * [`fn withRefId(value)`](#fn-withrefid) * [`fn withSpanSelector(value)`](#fn-withspanselector) * [`fn withSpanSelectorMixin(value)`](#fn-withspanselectormixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -143,4 +146,29 @@ PARAMETERS: * **value** (`array`) -Specifies the query span selectors. \ No newline at end of file +Specifies the query span selectors. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/index.md b/gen/grafonnet-v11.2.0/docs/query/index.md index 2e381972..2ca95883 100644 --- a/gen/grafonnet-v11.2.0/docs/query/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/index.md @@ -4,7 +4,9 @@ grafonnet.query ## Subpackages +* [athena](athena.md) * [azureMonitor](azureMonitor/index.md) +* [bigquery](bigquery/index.md) * [cloudWatch](cloudWatch/index.md) * [elasticsearch](elasticsearch/index.md) * [expr](expr/index.md) diff --git a/gen/grafonnet-v11.2.0/docs/query/loki.md b/gen/grafonnet-v11.2.0/docs/query/loki.md index 2ebd28f2..56eb6c7d 100644 --- a/gen/grafonnet-v11.2.0/docs/query/loki.md +++ b/gen/grafonnet-v11.2.0/docs/query/loki.md @@ -17,6 +17,9 @@ grafonnet.query.loki * [`fn withRefId(value)`](#fn-withrefid) * [`fn withResolution(value)`](#fn-withresolution) * [`fn withStep(value)`](#fn-withstep) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -170,4 +173,29 @@ PARAMETERS: * **value** (`string`) -Used to set step value for range queries. \ No newline at end of file +Used to set step value for range queries. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/parca.md b/gen/grafonnet-v11.2.0/docs/query/parca.md index 03c73bfe..87909442 100644 --- a/gen/grafonnet-v11.2.0/docs/query/parca.md +++ b/gen/grafonnet-v11.2.0/docs/query/parca.md @@ -10,6 +10,9 @@ grafonnet.query.parca * [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRefId(value)`](#fn-withrefid) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -83,4 +86,29 @@ PARAMETERS: A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/prometheus.md b/gen/grafonnet-v11.2.0/docs/query/prometheus.md index f35381ed..737c7538 100644 --- a/gen/grafonnet-v11.2.0/docs/query/prometheus.md +++ b/gen/grafonnet-v11.2.0/docs/query/prometheus.md @@ -18,6 +18,9 @@ grafonnet.query.prometheus * [`fn withQueryType(value)`](#fn-withquerytype) * [`fn withRange(value=true)`](#fn-withrange) * [`fn withRefId(value)`](#fn-withrefid) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -185,4 +188,29 @@ PARAMETERS: A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. -By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/tempo/index.md b/gen/grafonnet-v11.2.0/docs/query/tempo/index.md index 3ef62e40..182301b2 100644 --- a/gen/grafonnet-v11.2.0/docs/query/tempo/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/tempo/index.md @@ -31,6 +31,9 @@ grafonnet.query.tempo * [`fn withSpss(value)`](#fn-withspss) * [`fn withStep(value)`](#fn-withstep) * [`fn withTableType(value)`](#fn-withtabletype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) ## Fields @@ -283,4 +286,29 @@ PARAMETERS: * **value** (`string`) - valid values: `"traces"`, `"spans"`, `"raw"` -The type of the table that is used to display the search results \ No newline at end of file +The type of the table that is used to display the search results +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/gen/grafonnet-v11.2.0/docs/query/testData/index.md b/gen/grafonnet-v11.2.0/docs/query/testData/index.md index 913802f1..7f02d6fe 100644 --- a/gen/grafonnet-v11.2.0/docs/query/testData/index.md +++ b/gen/grafonnet-v11.2.0/docs/query/testData/index.md @@ -54,7 +54,6 @@ grafonnet.query.testData * [`fn withUsaMixin(value)`](#fn-withusamixin) * [`fn withWithNil(value=true)`](#fn-withwithnil) * [`obj datasource`](#obj-datasource) - * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) * [`fn withType(value)`](#fn-datasourcewithtype) * [`fn withUid(value)`](#fn-datasourcewithuid) * [`obj nodes`](#obj-nodes) @@ -650,17 +649,6 @@ PARAMETERS: ### obj datasource -#### fn datasource.withApiVersion - -```jsonnet -datasource.withApiVersion(value) -``` - -PARAMETERS: - -* **value** (`string`) - -The apiserver version #### fn datasource.withType ```jsonnet @@ -671,7 +659,7 @@ PARAMETERS: * **value** (`string`) -The datasource plugin type +The plugin type-id #### fn datasource.withUid ```jsonnet @@ -682,7 +670,7 @@ PARAMETERS: * **value** (`string`) -Datasource UID (NOTE: name in k8s) +Specific datasource instance ### obj nodes diff --git a/gen/grafonnet-v11.2.0/librarypanel.libsonnet b/gen/grafonnet-v11.2.0/librarypanel.libsonnet index c40b4529..9c5194e8 100644 --- a/gen/grafonnet-v11.2.0/librarypanel.libsonnet +++ b/gen/grafonnet-v11.2.0/librarypanel.libsonnet @@ -128,11 +128,11 @@ }, }, }, - '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Dashboard panels are the basic visualization building blocks.' } }, withModel(value): { model: value, }, - '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Dashboard panels are the basic visualization building blocks.' } }, withModelMixin(value): { model+: value, }, @@ -368,6 +368,60 @@ }, }, }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, all dashboards links will be displayed in a dropdown. If false, all dashboards links will be displayed side by side. Only valid if the type is dashboards' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, withMappings(value): { model+: { diff --git a/gen/grafonnet-v11.2.0/query.libsonnet b/gen/grafonnet-v11.2.0/query.libsonnet index 129a0ea0..fea2747d 100644 --- a/gen/grafonnet-v11.2.0/query.libsonnet +++ b/gen/grafonnet-v11.2.0/query.libsonnet @@ -1,7 +1,9 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query', name: 'query' }, + athena: import 'query/athena.libsonnet', azureMonitor: import 'query/azureMonitor.libsonnet', + bigquery: import 'query/bigquery.libsonnet', cloudWatch: import 'query/cloudWatch.libsonnet', elasticsearch: import 'query/elasticsearch.libsonnet', expr: import 'query/expr.libsonnet', diff --git a/gen/grafonnet-v11.2.0/query/athena.libsonnet b/gen/grafonnet-v11.2.0/query/athena.libsonnet new file mode 100644 index 00000000..3ddc5cd1 --- /dev/null +++ b/gen/grafonnet-v11.2.0/query/athena.libsonnet @@ -0,0 +1,100 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.athena', name: 'athena' }, + '#withColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withColumn(value): { + column: value, + }, + '#withConnectionArgs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConnectionArgs(value): { + connectionArgs: value, + }, + '#withConnectionArgsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConnectionArgsMixin(value): { + connectionArgs+: value, + }, + connectionArgs+: + { + '#withCatalog': { 'function': { args: [{ default: '__default', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCatalog(value='__default'): { + connectionArgs+: { + catalog: value, + }, + }, + '#withDatabase': { 'function': { args: [{ default: '__default', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatabase(value='__default'): { + connectionArgs+: { + database: value, + }, + }, + '#withRegion': { 'function': { args: [{ default: '__default', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value='__default'): { + connectionArgs+: { + region: value, + }, + }, + '#withResultReuseEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withResultReuseEnabled(value=true): { + connectionArgs+: { + resultReuseEnabled: value, + }, + }, + '#withResultReuseMaxAgeInMinutes': { 'function': { args: [{ default: 60, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withResultReuseMaxAgeInMinutes(value=60): { + connectionArgs+: { + resultReuseMaxAgeInMinutes: value, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + format: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withQueryID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryID(value): { + queryID: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawSQL': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawSQL(value=''): { + rawSQL: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withTable': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTable(value): { + table: value, + }, +} diff --git a/gen/grafonnet-v11.2.0/query/azureMonitor.libsonnet b/gen/grafonnet-v11.2.0/query/azureMonitor.libsonnet index 4b8e72e3..dfbdb6ae 100644 --- a/gen/grafonnet-v11.2.0/query/azureMonitor.libsonnet +++ b/gen/grafonnet-v11.2.0/query/azureMonitor.libsonnet @@ -419,14 +419,29 @@ }, }, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withGrafanaTemplateVariableFn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '@deprecated Legacy template variable support.' } }, withGrafanaTemplateVariableFn(value): { grafanaTemplateVariableFn: value, diff --git a/gen/grafonnet-v11.2.0/query/bigquery.libsonnet b/gen/grafonnet-v11.2.0/query/bigquery.libsonnet new file mode 100644 index 00000000..0d69b7a2 --- /dev/null +++ b/gen/grafonnet-v11.2.0/query/bigquery.libsonnet @@ -0,0 +1,303 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.bigquery', name: 'bigquery' }, + '#withConvertToUTC': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withConvertToUTC(value=true): { + convertToUTC: value, + }, + '#withDataset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDataset(value): { + dataset: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + format: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, + withHide(value=true): { + hide: value, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withPartitioned': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPartitioned(value=true): { + partitioned: value, + }, + '#withPartitionedField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPartitionedField(value): { + partitionedField: value, + }, + '#withProject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProject(value): { + project: value, + }, + '#withQueryPriority': { 'function': { args: [{ default: null, enums: ['INTERACTIVE', 'BATCH'], name: 'value', type: ['string'] }], help: '' } }, + withQueryPriority(value): { + queryPriority: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specify the query flavor\nTODO make this required and give it a default' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawQuery': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRawQuery(value=true): { + rawQuery: value, + }, + '#withRawSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawSql(value): { + rawSql: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A->Z; however setting meaningful names may be useful.' } }, + withRefId(value): { + refId: value, + }, + '#withSharded': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSharded(value=true): { + sharded: value, + }, + '#withSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSql(value): { + sql: value, + }, + '#withSqlMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSqlMixin(value): { + sql+: value, + }, + sql+: + { + '#withColumns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withColumns(value): { + sql+: { + columns: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withColumnsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withColumnsMixin(value): { + sql+: { + columns+: + (if std.isArray(value) + then value + else [value]), + }, + }, + columns+: + { + '#': { help: '', name: 'columns' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'function', + }, + }, + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value): { + sql+: { + from: value, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + sql+: { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + sql+: { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + property: value, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + property+: value, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + property+: { + name: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + property+: { + type: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'groupBy', + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value): { + sql+: { + limit: value, + }, + }, + '#withOffset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOffset(value): { + sql+: { + offset: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderBy(value): { + sql+: { + orderBy: value, + }, + }, + '#withOrderByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderByMixin(value): { + sql+: { + orderBy+: value, + }, + }, + orderBy+: + { + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + sql+: { + orderBy+: { + property: value, + }, + }, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + sql+: { + orderBy+: { + property+: value, + }, + }, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + orderBy+: { + property+: { + name: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + orderBy+: { + property+: { + type: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + orderBy+: { + type: 'property', + }, + }, + }, + }, + '#withOrderByDirection': { 'function': { args: [{ default: null, enums: ['ASC', 'DESC'], name: 'value', type: ['string'] }], help: '' } }, + withOrderByDirection(value): { + sql+: { + orderByDirection: value, + }, + }, + '#withWhereString': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'whereJsonTree?: _' } }, + withWhereString(value): { + sql+: { + whereString: value, + }, + }, + }, + '#withTable': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTable(value): { + table: value, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeShift(value): { + timeShift: value, + }, +} diff --git a/gen/grafonnet-v11.2.0/query/cloudWatch.libsonnet b/gen/grafonnet-v11.2.0/query/cloudWatch.libsonnet index 9d71e9dd..de817841 100644 --- a/gen/grafonnet-v11.2.0/query/cloudWatch.libsonnet +++ b/gen/grafonnet-v11.2.0/query/cloudWatch.libsonnet @@ -15,14 +15,29 @@ withAlarmNamePrefix(value): { alarmNamePrefix: value, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, withDimensions(value): { dimensions: value, @@ -92,14 +107,29 @@ }, CloudWatchLogsQuery+: { - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The CloudWatch Logs Insights query to execute' } }, withExpression(value): { expression: value, @@ -201,14 +231,29 @@ withAlias(value): { alias: value, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, withDimensions(value): { dimensions: value, diff --git a/gen/grafonnet-v11.2.0/query/elasticsearch.libsonnet b/gen/grafonnet-v11.2.0/query/elasticsearch.libsonnet index 99171aa3..15b634bb 100644 --- a/gen/grafonnet-v11.2.0/query/elasticsearch.libsonnet +++ b/gen/grafonnet-v11.2.0/query/elasticsearch.libsonnet @@ -279,14 +279,29 @@ }, }, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, diff --git a/gen/grafonnet-v11.2.0/query/expr.libsonnet b/gen/grafonnet-v11.2.0/query/expr.libsonnet index 57ec5b3d..a0738524 100644 --- a/gen/grafonnet-v11.2.0/query/expr.libsonnet +++ b/gen/grafonnet-v11.2.0/query/expr.libsonnet @@ -3,29 +3,23 @@ '#': { help: 'grafonnet.query.expr', name: 'expr' }, TypeMath+: { - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, - withType(): { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { - type: '__expr__', + type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, @@ -127,29 +121,23 @@ }, TypeReduce+: { - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, - withType(): { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { - type: '__expr__', + type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, @@ -278,29 +266,23 @@ }, TypeResample+: { - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, - withType(): { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { - type: '__expr__', + type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, @@ -530,29 +512,23 @@ }, }, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, - withType(): { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { - type: '__expr__', + type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, @@ -746,29 +722,23 @@ }, }, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, - withType(): { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { - type: '__expr__', + type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, @@ -870,29 +840,23 @@ }, TypeSql+: { - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, - withType(): { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { datasource+: { - type: '__expr__', + type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, diff --git a/gen/grafonnet-v11.2.0/query/googleCloudMonitoring.libsonnet b/gen/grafonnet-v11.2.0/query/googleCloudMonitoring.libsonnet index 478a49cd..6135c5bd 100644 --- a/gen/grafonnet-v11.2.0/query/googleCloudMonitoring.libsonnet +++ b/gen/grafonnet-v11.2.0/query/googleCloudMonitoring.libsonnet @@ -5,14 +5,29 @@ withAliasBy(value): { aliasBy: value, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, diff --git a/gen/grafonnet-v11.2.0/query/grafanaPyroscope.libsonnet b/gen/grafonnet-v11.2.0/query/grafanaPyroscope.libsonnet index 67a75664..70c949d1 100644 --- a/gen/grafonnet-v11.2.0/query/grafanaPyroscope.libsonnet +++ b/gen/grafonnet-v11.2.0/query/grafanaPyroscope.libsonnet @@ -1,14 +1,29 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.grafanaPyroscope', name: 'grafanaPyroscope' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, withGroupBy(value): { groupBy: diff --git a/gen/grafonnet-v11.2.0/query/loki.libsonnet b/gen/grafonnet-v11.2.0/query/loki.libsonnet index 2d77f4b5..60f46b0c 100644 --- a/gen/grafonnet-v11.2.0/query/loki.libsonnet +++ b/gen/grafonnet-v11.2.0/query/loki.libsonnet @@ -1,14 +1,29 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.loki', name: 'loki' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, withEditorMode(value): { editorMode: value, diff --git a/gen/grafonnet-v11.2.0/query/parca.libsonnet b/gen/grafonnet-v11.2.0/query/parca.libsonnet index 94f6f231..c2939fd9 100644 --- a/gen/grafonnet-v11.2.0/query/parca.libsonnet +++ b/gen/grafonnet-v11.2.0/query/parca.libsonnet @@ -1,14 +1,29 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.parca', name: 'parca' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.' } }, withHide(value=true): { hide: value, diff --git a/gen/grafonnet-v11.2.0/query/prometheus.libsonnet b/gen/grafonnet-v11.2.0/query/prometheus.libsonnet index 6e2eeaa0..7ebcdf8d 100644 --- a/gen/grafonnet-v11.2.0/query/prometheus.libsonnet +++ b/gen/grafonnet-v11.2.0/query/prometheus.libsonnet @@ -1,14 +1,29 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: 'Specifies which editor is being used to prepare the query. It can be "code" or "builder"' } }, withEditorMode(value): { editorMode: value, diff --git a/gen/grafonnet-v11.2.0/query/tempo.libsonnet b/gen/grafonnet-v11.2.0/query/tempo.libsonnet index 2dfd553c..42cff362 100644 --- a/gen/grafonnet-v11.2.0/query/tempo.libsonnet +++ b/gen/grafonnet-v11.2.0/query/tempo.libsonnet @@ -1,14 +1,29 @@ // This file is generated, do not manually edit. { '#': { help: 'grafonnet.query.tempo', name: 'tempo' }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null" } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, withFilters(value): { filters: diff --git a/gen/grafonnet-v11.2.0/query/testData.libsonnet b/gen/grafonnet-v11.2.0/query/testData.libsonnet index bbd01392..db81210b 100644 --- a/gen/grafonnet-v11.2.0/query/testData.libsonnet +++ b/gen/grafonnet-v11.2.0/query/testData.libsonnet @@ -51,29 +51,23 @@ valuesCSV: value, }, }, - '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasource(value): { datasource: value, }, - '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, withDatasourceMixin(value): { datasource+: value, }, datasource+: { - '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, - withApiVersion(value): { - datasource+: { - apiVersion: value, - }, - }, - '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The datasource plugin type' } }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, withType(value): { datasource+: { type: value, }, }, - '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, withUid(value): { datasource+: { uid: value, diff --git a/generator/jsonnetfile.lock.json b/generator/jsonnetfile.lock.json index b4232746..ae657246 100644 --- a/generator/jsonnetfile.lock.json +++ b/generator/jsonnetfile.lock.json @@ -8,8 +8,8 @@ "subdir": "" } }, - "version": "a771663cb9594cd10b30815933fe55554e6a3755", - "sum": "k/SJ+F+jjdg+dBMKczPEjcYCEuQ6v0BROdXKdXOCi9o=" + "version": "0c82db246c00af8a25ead5240d82db195febee60", + "sum": "zgyJG+0zLt/9OreKeHzJD4NaEltwwMYJ5O5obKBk35I=" }, { "source": { @@ -18,8 +18,8 @@ "subdir": "crdsonnet" } }, - "version": "c352197a5ba95b2e28f5b75d60faeb0cd1c64592", - "sum": "za+MrbUYBEqaYX/wPHpGxvCGV1q8/jtH6qhxd8ODb+U=" + "version": "f2f3c043f329edd4dd59ba89128258a59ee3363e", + "sum": "2nG91akk1UMbxn99gyQ1A29zn/5jiHM+0ovsw+DgCYM=" }, { "source": { @@ -38,9 +38,9 @@ "subdir": "openapi" } }, - "version": "a4c73587770f1a44b3afc3c12a514d49a1d74632", - "sum": "9ndfNQnSlr9DI/VZGDosPxXLsdb7M3erxrBOIpiAfhw=", - "name": "grafana-foundation-sdk-v11.0.0" + "version": "d76b3ba5b04c8b6f83443e84d6fdf1794238de6a", + "sum": "L/mOvgkZAfZqP3L/OIAhwHNjpxw3XVgeXEeSek63aso=", + "name": "grafana-foundation-sdk-v11.2.0" }, { "source": { diff --git a/generator/query.libsonnet b/generator/query.libsonnet index 902a969b..16d6f06e 100644 --- a/generator/query.libsonnet +++ b/generator/query.libsonnet @@ -119,6 +119,16 @@ local utils = import './utils.libsonnet'; '$ref': '#/components/schemas/expr', }, }, + athena: { + dataquery: { + '$ref': '#/components/schemas/Dataquery', + }, + }, + bigquery: { + dataquery: { + '$ref': '#/components/schemas/Dataquery', + }, + }, }, queryIndex(files):