mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
2445 lines
No EOL
84 KiB
JSON
2445 lines
No EOL
84 KiB
JSON
{
|
|
"id": "@kbn/esql-utils",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendStatsByToQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "appendStatsByToQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(queryString: string, column: string) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendStatsByToQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "queryString",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendStatsByToQuery.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "column",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendToESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "appendToESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(baseESQLQuery: string, appendedText: string) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendToESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "baseESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendToESQLQuery.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "appendedText",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendWhereClauseToESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "appendWhereClauseToESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(baseESQLQuery: string, field: string, value: unknown, operation: \"+\" | \"-\" | \"is_not_null\" | \"is_null\", fieldType: string | undefined) => string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendWhereClauseToESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "baseESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendWhereClauseToESQLQuery.$2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendWhereClauseToESQLQuery.$3",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "value",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendWhereClauseToESQLQuery.$4",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "operation",
|
|
"description": [],
|
|
"signature": [
|
|
"\"+\" | \"-\" | \"is_not_null\" | \"is_null\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.appendWhereClauseToESQLQuery.$5",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "fieldType",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.extractCategorizeTokens",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "extractCategorizeTokens",
|
|
"description": [
|
|
"\nExtracts \"tokens\" from a regex string (produced by the categorize function) by stripping leading/trailing '.*?'\nand splitting the remainder by '.+?'.\n"
|
|
],
|
|
"signature": [
|
|
"(regexString: string) => string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/extract_categorize_tokens.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.extractCategorizeTokens.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "regexString",
|
|
"description": [
|
|
"The regular expression string."
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/extract_categorize_tokens.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"An array of extracted \"keywords\"."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.fixESQLQueryWithVariables",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "fixESQLQueryWithVariables",
|
|
"description": [],
|
|
"signature": [
|
|
"(queryString: string, esqlVariables?: ",
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[] | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.fixESQLQueryWithVariables.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "queryString",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.fixESQLQueryWithVariables.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "esqlVariables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.formatESQLColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "formatESQLColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"(columns: ",
|
|
{
|
|
"pluginId": "@kbn/es-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsTypesPluginApi",
|
|
"section": "def-common.ESQLColumn",
|
|
"text": "ESQLColumn"
|
|
},
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.formatESQLColumns.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "columns",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsTypesPluginApi",
|
|
"section": "def-common.ESQLColumn",
|
|
"text": "ESQLColumn"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getArgsFromRenameFunction",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getArgsFromRenameFunction",
|
|
"description": [
|
|
"\nExtracts the original and renamed columns from a rename function.\nRENAME original AS renamed Vs RENAME renamed = original"
|
|
],
|
|
"signature": [
|
|
"(renameFunction: ",
|
|
{
|
|
"pluginId": "@kbn/esql-ast",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlAstPluginApi",
|
|
"section": "def-common.ESQLFunction",
|
|
"text": "ESQLFunction"
|
|
},
|
|
"<",
|
|
"FunctionSubtype",
|
|
", string>) => { original: ",
|
|
{
|
|
"pluginId": "@kbn/esql-ast",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlAstPluginApi",
|
|
"section": "def-common.ESQLColumn",
|
|
"text": "ESQLColumn"
|
|
},
|
|
"; renamed: ",
|
|
{
|
|
"pluginId": "@kbn/esql-ast",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlAstPluginApi",
|
|
"section": "def-common.ESQLColumn",
|
|
"text": "ESQLColumn"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getArgsFromRenameFunction.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "renameFunction",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/esql-ast",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlAstPluginApi",
|
|
"section": "def-common.ESQLFunction",
|
|
"text": "ESQLFunction"
|
|
},
|
|
"<",
|
|
"FunctionSubtype",
|
|
", string>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getCategorizeColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getCategorizeColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string) => string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getCategorizeColumns.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLAdHocDataview",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESQLAdHocDataview",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string, dataViewsService: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.DataViewsServicePublic",
|
|
"text": "DataViewsServicePublic"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_adhoc_dataview.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLAdHocDataview.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_adhoc_dataview.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLAdHocDataview.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViewsService",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.DataViewsServicePublic",
|
|
"text": "DataViewsServicePublic"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_adhoc_dataview.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESQLQueryColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n esqlQuery,\n search,\n signal,\n timeRange,\n}: { esqlQuery: string; search: ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchGeneric",
|
|
"text": "ISearchGeneric"
|
|
},
|
|
"; signal?: AbortSignal | undefined; timeRange?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n esqlQuery,\n search,\n signal,\n timeRange,\n}",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1.esqlQuery",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esqlQuery",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1.search",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchRequest",
|
|
"text": "IEsSearchRequest"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchRequestParams",
|
|
"text": "ISearchRequestParams"
|
|
},
|
|
">, SearchStrategyResponse extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1.search.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-search-types/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1.search.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-search-types/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1.signal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "signal",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumns.$1.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESQLQueryColumnsRaw",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n esqlQuery,\n search,\n signal,\n timeRange,\n}: { esqlQuery: string; search: ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchGeneric",
|
|
"text": "ISearchGeneric"
|
|
},
|
|
"; signal?: AbortSignal | undefined; timeRange?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; }) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/es-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsTypesPluginApi",
|
|
"section": "def-common.ESQLColumn",
|
|
"text": "ESQLColumn"
|
|
},
|
|
"[]>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n esqlQuery,\n search,\n signal,\n timeRange,\n}",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1.esqlQuery",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esqlQuery",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1.search",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchRequest",
|
|
"text": "IEsSearchRequest"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchRequestParams",
|
|
"text": "ISearchRequestParams"
|
|
},
|
|
">, SearchStrategyResponse extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1.search.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-search-types/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1.search.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-search-types/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1.signal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "signal",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryColumnsRaw.$1.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryVariables",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESQLQueryVariables",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string) => string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLQueryVariables.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESQLResults",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n esqlQuery,\n search,\n signal,\n filter,\n dropNullColumns,\n timeRange,\n variables,\n}: { esqlQuery: string; search: ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchGeneric",
|
|
"text": "ISearchGeneric"
|
|
},
|
|
"; signal?: AbortSignal | undefined; filter?: unknown; dropNullColumns?: boolean | undefined; timeRange?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined; variables?: ",
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[] | undefined; }) => Promise<{ response: ",
|
|
{
|
|
"pluginId": "@kbn/es-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsTypesPluginApi",
|
|
"section": "def-common.ESQLSearchResponse",
|
|
"text": "ESQLSearchResponse"
|
|
},
|
|
"; params: ",
|
|
{
|
|
"pluginId": "@kbn/es-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsTypesPluginApi",
|
|
"section": "def-common.ESQLSearchParams",
|
|
"text": "ESQLSearchParams"
|
|
},
|
|
"; }>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n esqlQuery,\n search,\n signal,\n filter,\n dropNullColumns,\n timeRange,\n variables,\n}",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.esqlQuery",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esqlQuery",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.search",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "search",
|
|
"description": [],
|
|
"signature": [
|
|
"<SearchStrategyRequest extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IKibanaSearchRequest",
|
|
"text": "IKibanaSearchRequest"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchRequest",
|
|
"text": "IEsSearchRequest"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchRequestParams",
|
|
"text": "ISearchRequestParams"
|
|
},
|
|
">, SearchStrategyResponse extends ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IKibanaSearchResponse",
|
|
"text": "IKibanaSearchResponse"
|
|
},
|
|
"<any> = ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.IEsSearchResponse",
|
|
"text": "IEsSearchResponse"
|
|
},
|
|
"<any>>(request: SearchStrategyRequest, options?: ",
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined) => ",
|
|
"Observable",
|
|
"<SearchStrategyResponse>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.search.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"SearchStrategyRequest"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-search-types/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.search.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/search-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnSearchTypesPluginApi",
|
|
"section": "def-common.ISearchOptions",
|
|
"text": "ISearchOptions"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-search-types/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.signal",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "signal",
|
|
"description": [],
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.filter",
|
|
"type": "Unknown",
|
|
"tags": [],
|
|
"label": "filter",
|
|
"description": [],
|
|
"signature": [
|
|
"unknown"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.dropNullColumns",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "dropNullColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.timeRange",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLResults.$1.variables",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLWithSafeLimit",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getESQLWithSafeLimit",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string, limit: number) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLWithSafeLimit.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getESQLWithSafeLimit.$2",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "limit",
|
|
"description": [],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getIndexForESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIndexForESQLQuery",
|
|
"description": [
|
|
"\nThis can be used to get an initial index for a default ES|QL query.\nCould be used during onboarding when data views to get a better index are not yet available.\nCan be used in combination with {@link getESQLAdHocDataview} to create a dataview for the index."
|
|
],
|
|
"signature": [
|
|
"(deps: { dataViews: { getIndices: (props: { pattern: string; showAllIndices?: boolean | undefined; isRollupIndex: (indexName: string) => boolean; }) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.MatchedItem",
|
|
"text": "MatchedItem"
|
|
},
|
|
"[]>; }; }) => Promise<string | null>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_adhoc_dataview.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getIndexForESQLQuery.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "deps",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_adhoc_dataview.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getIndexForESQLQuery.$1.dataViews",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataViews",
|
|
"description": [],
|
|
"signature": [
|
|
"{ getIndices: (props: { pattern: string; showAllIndices?: boolean | undefined; isRollupIndex: (indexName: string) => boolean; }) => Promise<",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "public",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-public.MatchedItem",
|
|
"text": "MatchedItem"
|
|
},
|
|
"[]>; }"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_adhoc_dataview.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getIndexPatternFromESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIndexPatternFromESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getIndexPatternFromESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getInitialESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getInitialESQLQuery",
|
|
"description": [
|
|
"\nBuilds an ES|QL query for the provided dataView\nIf there is @timestamp field in the index, we don't add the WHERE clause\nIf there is no @timestamp and there is a dataView timeFieldName, we add the WHERE clause with the timeFieldName"
|
|
],
|
|
"signature": [
|
|
"(dataView: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
},
|
|
", query: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_initial_esql_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getInitialESQLQuery.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "dataView",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.DataView",
|
|
"text": "DataView"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_initial_esql_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getInitialESQLQuery.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_initial_esql_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getLimitFromESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLimitFromESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string) => number"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getLimitFromESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getNamedParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getNamedParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string, timeRange?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined, variables?: ",
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[] | undefined) => Record<string, string | number | Record<string, string | number> | undefined>[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getNamedParams.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getNamedParams.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "timeRange",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getNamedParams.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getQueryColumnsFromESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getQueryColumnsFromESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string) => string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getQueryColumnsFromESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getStartEndParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getStartEndParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string, time?: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined) => ({ _tstart: string; _tend?: undefined; } | { _tend: string; _tstart?: undefined; })[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getStartEndParams.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getStartEndParams.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "time",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.TimeRange",
|
|
"text": "TimeRange"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getTimeFieldFromESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTimeFieldFromESQLQuery",
|
|
"description": [
|
|
"\nWhen the ?_tstart and ?_tend params are used, we want to retrieve the timefield from the query."
|
|
],
|
|
"signature": [
|
|
"(esql: string) => string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getTimeFieldFromESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [
|
|
":string"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"string"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getValuesFromQueryField",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getValuesFromQueryField",
|
|
"description": [],
|
|
"signature": [
|
|
"(queryString: string, cursorPosition?: ",
|
|
"Position",
|
|
" | undefined) => string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getValuesFromQueryField.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "queryString",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.getValuesFromQueryField.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cursorPosition",
|
|
"description": [],
|
|
"signature": [
|
|
"Position",
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.hasStartEndParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasStartEndParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string) => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.hasStartEndParams.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/run_query.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.hasTransformationalCommand",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "hasTransformationalCommand",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string | undefined) => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.hasTransformationalCommand.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isESQLColumnGroupable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isESQLColumnGroupable",
|
|
"description": [
|
|
"\nCheck if a column is groupable (| STATS ... BY <column>).\n"
|
|
],
|
|
"signature": [
|
|
"(column: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/esql_fields_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isESQLColumnGroupable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "column",
|
|
"description": [
|
|
"The DatatableColumn of the field."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/esql_fields_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"True if the column is groupable, false otherwise."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isESQLColumnSortable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isESQLColumnSortable",
|
|
"description": [
|
|
"\nCheck if a column is sortable.\n"
|
|
],
|
|
"signature": [
|
|
"(column: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/esql_fields_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isESQLColumnSortable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "column",
|
|
"description": [
|
|
"The DatatableColumn of the field."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/esql_fields_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"True if the column is sortable, false otherwise."
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isESQLFieldGroupable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isESQLFieldGroupable",
|
|
"description": [],
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/esql_fields_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isESQLFieldGroupable.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "field",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "dataViews",
|
|
"scope": "common",
|
|
"docId": "kibDataViewsPluginApi",
|
|
"section": "def-common.FieldSpec",
|
|
"text": "FieldSpec"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/esql_fields_utils.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isQueryWrappedByPipes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isQueryWrappedByPipes",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string) => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.isQueryWrappedByPipes.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.mapVariableToColumn",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "mapVariableToColumn",
|
|
"description": [
|
|
"\nThis function is used to map the variables to the columns in the datatable"
|
|
],
|
|
"signature": [
|
|
"(esql: string, variables: ",
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[], columns: ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"[]) => ",
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.mapVariableToColumn.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [
|
|
":string"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.mapVariableToColumn.$2",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "variables",
|
|
"description": [
|
|
":ESQLControlVariable[]"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/esql-types",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsqlTypesPluginApi",
|
|
"section": "def-common.ESQLControlVariable",
|
|
"text": "ESQLControlVariable"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.mapVariableToColumn.$3",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "columns",
|
|
"description": [
|
|
":DatatableColumn[]"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "expressions",
|
|
"scope": "common",
|
|
"docId": "kibExpressionsPluginApi",
|
|
"section": "def-common.DatatableColumn",
|
|
"text": "DatatableColumn"
|
|
},
|
|
"[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [
|
|
"DatatableColumn[]"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.prettifyQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "prettifyQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(query: string, isWrapped: boolean) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.prettifyQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.prettifyQuery.$2",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "isWrapped",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.queryCannotBeSampled",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "queryCannotBeSampled",
|
|
"description": [
|
|
"\nCheck if the query contains any function that cannot be used after LIMIT clause"
|
|
],
|
|
"signature": [
|
|
"(query: ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | { [key: string]: any; } | null | undefined) => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_cannot_be_sampled.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.queryCannotBeSampled.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.Query",
|
|
"text": "Query"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/es-query",
|
|
"scope": "common",
|
|
"docId": "kibKbnEsQueryPluginApi",
|
|
"section": "def-common.AggregateQuery",
|
|
"text": "AggregateQuery"
|
|
},
|
|
" | { [key: string]: any; } | null | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_cannot_be_sampled.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.removeDropCommandsFromESQLQuery",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "removeDropCommandsFromESQLQuery",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string | undefined) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.removeDropCommandsFromESQLQuery.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.replaceESQLQueryIndexPattern",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "replaceESQLQueryIndexPattern",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string, replacements: Record<string, string>) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/replace_index_pattern.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.replaceESQLQueryIndexPattern.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/replace_index_pattern.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.replaceESQLQueryIndexPattern.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "replacements",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, string>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/replace_index_pattern.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.retrieveMetadataColumns",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "retrieveMetadataColumns",
|
|
"description": [],
|
|
"signature": [
|
|
"(esql: string) => string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.retrieveMetadataColumns.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "esql",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.sanitazeESQLInput",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "sanitazeESQLInput",
|
|
"description": [],
|
|
"signature": [
|
|
"(input: string) => string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/sanitaze_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.sanitazeESQLInput.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "input",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/sanitaze_input.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.ENABLE_ESQL",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "ENABLE_ESQL",
|
|
"description": [],
|
|
"signature": [
|
|
"\"enableESQL\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/esql-utils",
|
|
"id": "def-common.FEEDBACK_LINK",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "FEEDBACK_LINK",
|
|
"description": [],
|
|
"signature": [
|
|
"\"https://ela.st/esql-feedback\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-esql-utils/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |