mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
[ES|QL] Functions definitions updates (#224993)
## Summary I had to run it manually due to this ES change https://github.com/elastic/elasticsearch/pull/129839
This commit is contained in:
Stratoula Kalafateli
GitHub
parent
726908a913
commit
0404a6d965
6 changed files with 114 additions and 386 deletions
|
|
@ -305,7 +305,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_centroid_agg', {
|
||||
defaultMessage: 'ST_CENTROID_AGG',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -336,7 +336,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_extent_agg', {
|
||||
defaultMessage: 'ST_EXTENT_AGG',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
|
|||
|
|
@ -237,13 +237,9 @@ export const functions = {
|
|||
{
|
||||
defaultMessage: `
|
||||
### IS NOT NULL
|
||||
Use \`IS NOT NULL\` to filter data based on whether the field exists or not.
|
||||
Returns \`false\` if the value is \`NULL\`, \`true\` otherwise.
|
||||
|
||||
\`\`\`esql
|
||||
FROM employees
|
||||
| WHERE is_rehired IS NOT NULL
|
||||
| STATS COUNT(emp_no)
|
||||
\`\`\`
|
||||
Note: If a field is only in some documents it will be \`NULL\` in the documents that did not contain it.
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
|
|
@ -269,12 +265,9 @@ export const functions = {
|
|||
{
|
||||
defaultMessage: `
|
||||
### IS NULL
|
||||
Use \`IS NULL\` to filter data based on whether the field exists or not.
|
||||
Returns \`true\` if the value is \`NULL\`, \`false\` otherwise.
|
||||
|
||||
\`\`\`esql
|
||||
FROM employees
|
||||
| WHERE birth_date IS NULL
|
||||
\`\`\`
|
||||
Note: If a field is only in some documents it will be \`NULL\` in the documents that did not contain it.
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
|
|
@ -386,7 +379,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.match_operator (:)', {
|
||||
defaultMessage: 'MATCH_OPERATOR (:)',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
|
|||
|
|
@ -925,7 +925,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.kql', {
|
||||
defaultMessage: 'KQL',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -1177,7 +1177,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.match', {
|
||||
defaultMessage: 'MATCH',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -1191,17 +1191,6 @@ export const functions = {
|
|||
Use \`MATCH\` to perform a [match query](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query) on the specified field.
|
||||
Using \`MATCH\` is equivalent to using the \`match\` query in the Elasticsearch Query DSL.
|
||||
|
||||
Match can be used on fields from the text family like [text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/text) and [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text),
|
||||
as well as other field types like keyword, boolean, dates, and numeric types.
|
||||
When Match is used on a [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text) field, it will perform a semantic query on the field.
|
||||
|
||||
Match can use [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params) to specify additional options for the match query.
|
||||
All [match query parameters](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query#match-field-params) are supported.
|
||||
|
||||
For a simplified syntax, you can use the [match operator](https://www.elastic.co/docs/reference/query-languages/esql/functions-operators/operators#esql-match-operator) \`:\` operator instead of \`MATCH\`.
|
||||
|
||||
\`MATCH\` returns true if the provided query matches the row.
|
||||
|
||||
\`\`\`esql
|
||||
FROM books
|
||||
| WHERE MATCH(author, "Faulkner")
|
||||
|
|
@ -1220,7 +1209,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.match_phrase', {
|
||||
defaultMessage: 'MATCH_PHRASE',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -1235,15 +1224,6 @@ export const functions = {
|
|||
specified field.
|
||||
Using \`MATCH_PHRASE\` is equivalent to using the \`match_phrase\` query in the Elasticsearch Query DSL.
|
||||
|
||||
MatchPhrase can be used on [text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/text) fields, as well as other field types like keyword, boolean, or date types.
|
||||
MatchPhrase is not supported for [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text) or numeric types.
|
||||
|
||||
MatchPhrase can use [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params) to specify additional options for the
|
||||
match_phrase query.
|
||||
All [\`match_phrase\`](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase) query parameters are supported.
|
||||
|
||||
\`MATCH_PHRASE\` returns true if the provided query matches the row.
|
||||
|
||||
\`\`\`esql
|
||||
FROM books
|
||||
| WHERE MATCH_PHRASE(author, "William Faulkner")
|
||||
|
|
@ -1955,7 +1935,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.qstr', {
|
||||
defaultMessage: 'QSTR',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -2595,7 +2575,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_envelope', {
|
||||
defaultMessage: 'ST_ENVELOPE',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -2614,320 +2594,6 @@ export const functions = {
|
|||
| EVAL envelope = ST_ENVELOPE(city_boundary)
|
||||
| KEEP abbrev, airport, envelope
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geohash', {
|
||||
defaultMessage: 'ST_GEOHASH',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geohash.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOHASH
|
||||
Calculates the \`geohash\` of the supplied geo_point at the specified precision.
|
||||
The result is long encoded. Use [ST_GEOHASH_TO_STRING](#esql-st_geohash_to_string) to convert the result to a string.
|
||||
|
||||
These functions are related to the [\`geo_grid\` query](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-grid-query)
|
||||
and the [\`geohash_grid\` aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation).
|
||||
|
||||
\`\`\`esql
|
||||
FROM airports
|
||||
| EVAL geohash = ST_GEOHASH(location, 1)
|
||||
| STATS
|
||||
count = COUNT(*),
|
||||
centroid = ST_CENTROID_AGG(location)
|
||||
BY geohash
|
||||
| WHERE count >= 10
|
||||
| EVAL geohashString = ST_GEOHASH_TO_STRING(geohash)
|
||||
| KEEP count, centroid, geohashString
|
||||
| SORT count DESC, geohashString ASC
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geohash_to_long', {
|
||||
defaultMessage: 'ST_GEOHASH_TO_LONG',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geohash_to_long.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOHASH TO LONG
|
||||
Converts an input value representing a geohash grid-ID in string format into a long.
|
||||
|
||||
\`\`\`esql
|
||||
ROW geohash = "u3bu"
|
||||
| EVAL geohashLong = ST_GEOHASH_TO_LONG(geohash)
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geohash_to_string', {
|
||||
defaultMessage: 'ST_GEOHASH_TO_STRING',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geohash_to_string.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOHASH TO STRING
|
||||
Converts an input value representing a geohash grid-ID in long format into a string.
|
||||
|
||||
\`\`\`esql
|
||||
ROW geohash = TO_LONG(13686180)
|
||||
| EVAL geohashString = ST_GEOHASH_TO_STRING(geohash)
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geohex', {
|
||||
defaultMessage: 'ST_GEOHEX',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geohex.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOHEX
|
||||
Calculates the \`geohex\`, the H3 cell-id, of the supplied geo_point at the specified precision.
|
||||
The result is long encoded. Use [ST_GEOHEX_TO_STRING](#esql-st_geohex_to_string) to convert the result to a string.
|
||||
|
||||
These functions are related to the [\`geo_grid\` query](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-grid-query)
|
||||
and the [\`geohex_grid\` aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation).
|
||||
|
||||
\`\`\`esql
|
||||
FROM airports
|
||||
| EVAL geohex = ST_GEOHEX(location, 1)
|
||||
| STATS
|
||||
count = COUNT(*),
|
||||
centroid = ST_CENTROID_AGG(location)
|
||||
BY geohex
|
||||
| WHERE count >= 10
|
||||
| EVAL geohexString = ST_GEOHEX_TO_STRING(geohex)
|
||||
| KEEP count, centroid, geohexString
|
||||
| SORT count DESC, geohexString ASC
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geohex_to_long', {
|
||||
defaultMessage: 'ST_GEOHEX_TO_LONG',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geohex_to_long.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOHEX TO LONG
|
||||
Converts an input value representing a geohex grid-ID in string format into a long.
|
||||
|
||||
\`\`\`esql
|
||||
ROW geohex = "841f059ffffffff"
|
||||
| EVAL geohexLong = ST_GEOHEX_TO_LONG(geohex)
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geohex_to_string', {
|
||||
defaultMessage: 'ST_GEOHEX_TO_STRING',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geohex_to_string.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOHEX TO STRING
|
||||
Converts an input value representing a Geohex grid-ID in long format into a string.
|
||||
|
||||
\`\`\`esql
|
||||
ROW geohex = 595020895127339007
|
||||
| EVAL geohexString = ST_GEOHEX_TO_STRING(geohex)
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geotile', {
|
||||
defaultMessage: 'ST_GEOTILE',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geotile.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOTILE
|
||||
Calculates the \`geotile\` of the supplied geo_point at the specified precision.
|
||||
The result is long encoded. Use [ST_GEOTILE_TO_STRING](#esql-st_geotile_to_string) to convert the result to a string.
|
||||
|
||||
These functions are related to the [\`geo_grid\` query](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-grid-query)
|
||||
and the [\`geotile_grid\` aggregation](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation).
|
||||
|
||||
\`\`\`esql
|
||||
FROM airports
|
||||
| EVAL geotile = ST_GEOTILE(location, 2)
|
||||
| STATS
|
||||
count = COUNT(*),
|
||||
centroid = ST_CENTROID_AGG(location)
|
||||
BY geotile
|
||||
| EVAL geotileString = ST_GEOTILE_TO_STRING(geotile)
|
||||
| SORT count DESC, geotileString ASC
|
||||
| KEEP count, centroid, geotileString
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geotile_to_long', {
|
||||
defaultMessage: 'ST_GEOTILE_TO_LONG',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geotile_to_long.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOTILE TO LONG
|
||||
Converts an input value representing a geotile grid-ID in string format into a long.
|
||||
|
||||
\`\`\`esql
|
||||
ROW geotile = "4/8/5"
|
||||
| EVAL geotileLong = ST_GEOTILE_TO_LONG(geotile)
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.st_geotile_to_string', {
|
||||
defaultMessage: 'ST_GEOTILE_TO_STRING',
|
||||
}),
|
||||
preview: false,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.st_geotile_to_string.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### ST GEOTILE TO STRING
|
||||
Converts an input value representing a geotile grid-ID in long format into a string.
|
||||
|
||||
\`\`\`esql
|
||||
ROW geotile = 1152921508901814277
|
||||
| EVAL geotileString = ST_GEOTILE_TO_STRING(geotile)
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
|
|
@ -3039,7 +2705,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_xmax', {
|
||||
defaultMessage: 'ST_XMAX',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -3074,7 +2740,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_xmin', {
|
||||
defaultMessage: 'ST_XMIN',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -3138,7 +2804,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_ymax', {
|
||||
defaultMessage: 'ST_YMAX',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -3173,7 +2839,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.st_ymin', {
|
||||
defaultMessage: 'ST_YMIN',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
@ -3971,7 +3637,7 @@ export const functions = {
|
|||
label: i18n.translate('languageDocumentation.documentationESQL.to_unsigned_long', {
|
||||
defaultMessage: 'TO_UNSIGNED_LONG',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
|
|
|
|||
|
|
@ -1529,7 +1529,7 @@ const stCentroidAggDefinition: FunctionDefinition = {
|
|||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.st_centroid_agg', {
|
||||
defaultMessage: 'Calculate the spatial centroid over a field with spatial point geometry type.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -1566,7 +1566,7 @@ const stExtentAggDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Calculate the spatial extent over a field with geometry type. Returns a bounding box for all values of the field.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -2061,7 +2061,7 @@ const isNotNullDefinition: FunctionDefinition = {
|
|||
type: FunctionDefinitionTypes.OPERATOR,
|
||||
name: 'is not null',
|
||||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.is_not_null', {
|
||||
defaultMessage: 'Use `IS NOT NULL` to filter data based on whether the field exists or not.',
|
||||
defaultMessage: 'Returns `false` if the value is `NULL`, `true` otherwise.',
|
||||
}),
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
|
|
@ -2096,6 +2096,36 @@ const isNotNullDefinition: FunctionDefinition = {
|
|||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
name: 'left',
|
||||
type: 'counter_double',
|
||||
optional: false,
|
||||
},
|
||||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
name: 'left',
|
||||
type: 'counter_integer',
|
||||
optional: false,
|
||||
},
|
||||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
name: 'left',
|
||||
type: 'counter_long',
|
||||
optional: false,
|
||||
},
|
||||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
|
|
@ -2226,7 +2256,7 @@ const isNotNullDefinition: FunctionDefinition = {
|
|||
Location.COMPLETION,
|
||||
],
|
||||
validate: undefined,
|
||||
examples: ['FROM employees\n| WHERE is_rehired IS NOT NULL\n| STATS COUNT(emp_no)'],
|
||||
examples: [],
|
||||
};
|
||||
|
||||
// Do not edit this manually... generated by scripts/generate_function_definitions.ts
|
||||
|
|
@ -2234,7 +2264,7 @@ const isNullDefinition: FunctionDefinition = {
|
|||
type: FunctionDefinitionTypes.OPERATOR,
|
||||
name: 'is null',
|
||||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.is_null', {
|
||||
defaultMessage: 'Use `IS NULL` to filter data based on whether the field exists or not.',
|
||||
defaultMessage: 'Returns `true` if the value is `NULL`, `false` otherwise.',
|
||||
}),
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
|
|
@ -2269,6 +2299,36 @@ const isNullDefinition: FunctionDefinition = {
|
|||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
name: 'left',
|
||||
type: 'counter_double',
|
||||
optional: false,
|
||||
},
|
||||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
name: 'left',
|
||||
type: 'counter_integer',
|
||||
optional: false,
|
||||
},
|
||||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
name: 'left',
|
||||
type: 'counter_long',
|
||||
optional: false,
|
||||
},
|
||||
],
|
||||
returnType: 'boolean',
|
||||
},
|
||||
{
|
||||
params: [
|
||||
{
|
||||
|
|
@ -2399,7 +2459,7 @@ const isNullDefinition: FunctionDefinition = {
|
|||
Location.COMPLETION,
|
||||
],
|
||||
validate: undefined,
|
||||
examples: ['FROM employees\n| WHERE birth_date IS NULL'],
|
||||
examples: [],
|
||||
};
|
||||
|
||||
// Do not edit this manually... generated by scripts/generate_function_definitions.ts
|
||||
|
|
@ -3233,7 +3293,7 @@ const matchOperatorDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Use the match operator (`:`) to perform a match query on the specified field.\nUsing `:` is equivalent to using the `match` query in the Elasticsearch Query DSL.\n\nThe match operator is equivalent to the match function.\n\nFor using the function syntax, or adding match query parameters, you can use the\nmatch function.\n\n`:` returns true if the provided query matches the row.',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -2979,7 +2979,7 @@ const kqlDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Performs a KQL query. Returns true if the provided KQL query string matches the row.',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -3995,9 +3995,9 @@ const matchDefinition: FunctionDefinition = {
|
|||
name: 'match',
|
||||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.match', {
|
||||
defaultMessage:
|
||||
'Use `MATCH` to perform a match query on the specified field.\nUsing `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.\n\nMatch can be used on fields from the text family like text and semantic_text,\nas well as other field types like keyword, boolean, dates, and numeric types.\nWhen Match is used on a semantic_text field, it will perform a semantic query on the field.\n\nMatch can use function named parameters to specify additional options for the match query.\nAll match query parameters are supported.\n\nFor a simplified syntax, you can use the match operator `:` operator instead of `MATCH`.\n\n`MATCH` returns true if the provided query matches the row.',
|
||||
'Use `MATCH` to perform a match query on the specified field.\nUsing `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -4740,9 +4740,9 @@ const matchPhraseDefinition: FunctionDefinition = {
|
|||
name: 'match_phrase',
|
||||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.match_phrase', {
|
||||
defaultMessage:
|
||||
'Use `MATCH_PHRASE` to perform a `match_phrase` on the\nspecified field.\nUsing `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.\n\nMatchPhrase can be used on text fields, as well as other field types like keyword, boolean, or date types.\nMatchPhrase is not supported for semantic_text or numeric types.\n\nMatchPhrase can use function named parameters to specify additional options for the\nmatch_phrase query.\nAll `match_phrase` query parameters are supported.\n\n`MATCH_PHRASE` returns true if the provided query matches the row.',
|
||||
'Use `MATCH_PHRASE` to perform a `match_phrase` on the\nspecified field.\nUsing `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -8476,7 +8476,7 @@ const qstrDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Performs a query string query. Returns true if the provided query string matches the row.',
|
||||
}),
|
||||
preview: true,
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10294,7 +10294,7 @@ const stEnvelopeDefinition: FunctionDefinition = {
|
|||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.st_envelope', {
|
||||
defaultMessage: 'Determines the minimum bounding box of the supplied geometry.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10362,7 +10362,8 @@ const stGeohashDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Calculates the `geohash` of the supplied geo_point at the specified precision.\nThe result is long encoded. Use ST_GEOHASH_TO_STRING to convert the result to a string.\n\nThese functions are related to the `geo_grid` query\nand the `geohash_grid` aggregation.',
|
||||
}),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10428,7 +10429,8 @@ const stGeohashToLongDefinition: FunctionDefinition = {
|
|||
'Converts an input value representing a geohash grid-ID in string format into a long.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10477,7 +10479,8 @@ const stGeohashToStringDefinition: FunctionDefinition = {
|
|||
'Converts an input value representing a geohash grid-ID in long format into a string.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10525,7 +10528,8 @@ const stGeohexDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Calculates the `geohex`, the H3 cell-id, of the supplied geo_point at the specified precision.\nThe result is long encoded. Use ST_GEOHEX_TO_STRING to convert the result to a string.\n\nThese functions are related to the `geo_grid` query\nand the `geohex_grid` aggregation.',
|
||||
}),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10593,7 +10597,8 @@ const stGeohexToLongDefinition: FunctionDefinition = {
|
|||
'Converts an input value representing a geohex grid-ID in string format into a long.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10642,7 +10647,8 @@ const stGeohexToStringDefinition: FunctionDefinition = {
|
|||
'Converts an input value representing a Geohex grid-ID in long format into a string.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10688,7 +10694,8 @@ const stGeotileDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Calculates the `geotile` of the supplied geo_point at the specified precision.\nThe result is long encoded. Use ST_GEOTILE_TO_STRING to convert the result to a string.\n\nThese functions are related to the `geo_grid` query\nand the `geotile_grid` aggregation.',
|
||||
}),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10754,7 +10761,8 @@ const stGeotileToLongDefinition: FunctionDefinition = {
|
|||
'Converts an input value representing a geotile grid-ID in string format into a long.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -10803,7 +10811,8 @@ const stGeotileToStringDefinition: FunctionDefinition = {
|
|||
'Converts an input value representing a geotile grid-ID in long format into a string.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -11195,7 +11204,7 @@ const stXmaxDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Extracts the maximum value of the `x` coordinates from the supplied geometry.\nIf the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the maximum `longitude` value.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -11263,7 +11272,7 @@ const stXminDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Extracts the minimum value of the `x` coordinates from the supplied geometry.\nIf the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the minimum `longitude` value.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -11379,7 +11388,7 @@ const stYmaxDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Extracts the maximum value of the `y` coordinates from the supplied geometry.\nIf the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the maximum `latitude` value.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -11447,7 +11456,7 @@ const stYminDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Extracts the minimum value of the `y` coordinates from the supplied geometry.\nIf the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the minimum `latitude` value.',
|
||||
}),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
{
|
||||
|
|
@ -13469,7 +13478,7 @@ const toUnsignedLongDefinition: FunctionDefinition = {
|
|||
'Converts an input value to an unsigned long value. If the input parameter is of a date type,\nits value will be interpreted as milliseconds since the Unix epoch, converted to unsigned long.\nBoolean `true` will be converted to unsigned long `1`, `false` to `0`.',
|
||||
}
|
||||
),
|
||||
preview: false,
|
||||
preview: true,
|
||||
alias: ['to_ul', 'to_ulong'],
|
||||
signatures: [
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue