kibana/api_docs/kbn_esql_ast.devdocs.json

9681 lines
No EOL
337 KiB
JSON
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"id": "@kbn/esql-ast",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter",
"type": "Class",
"tags": [],
"label": "BasicPrettyPrinter",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"ES|QL query AST to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"A single-line string representation of the query."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.multiline",
"type": "Function",
"tags": [],
"label": "multiline",
"description": [
"\nPrint a query with each command on a separate line. It is also possible to\nspecify a tabbing option for the pipe character.\n"
],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterMultilineOptions",
"text": "BasicPrettyPrinterMultilineOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.multiline.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [
"ES|QL query AST to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.multiline.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [
"Options for pretty-printing."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterMultilineOptions",
"text": "BasicPrettyPrinterMultilineOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"A multi-line string representation of the query."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.command",
"type": "Function",
"tags": [],
"label": "command",
"description": [],
"signature": [
"(command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.command.$1",
"type": "CompoundType",
"tags": [],
"label": "command",
"description": [
"ES|QL command AST node to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.command.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"Prints a single-line string representation of the command."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.expression",
"type": "Function",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"(expression: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.expression.$1",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [
"ES|QL expression AST node to print."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.expression.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"Prints a single-line string representation of the expression."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.opts",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"{ multiline: boolean; pipeTab: string; lowercase: boolean; lowercaseCommands: boolean; lowercaseOptions: boolean; lowercaseFunctions: boolean; lowercaseKeywords: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.keyword",
"type": "Function",
"tags": [],
"label": "keyword",
"description": [],
"signature": [
"(word: string) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.keyword.$1",
"type": "string",
"tags": [],
"label": "word",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.decorateWithComments",
"type": "Function",
"tags": [],
"label": "decorateWithComments",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>, formatted: string) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.decorateWithComments.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.decorateWithComments.$2",
"type": "string",
"tags": [],
"label": "formatted",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.simplifyMultiplicationByOne",
"type": "Function",
"tags": [],
"label": "simplifyMultiplicationByOne",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
", minusCount?: number) => string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.simplifyMultiplicationByOne.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.simplifyMultiplicationByOne.$2",
"type": "number",
"tags": [],
"label": "minusCount",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.visitor",
"type": "Object",
"tags": [],
"label": "visitor",
"description": [],
"signature": [
"Visitor",
"<any, ",
"SharedData",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printCommand",
"type": "Function",
"tags": [],
"label": "printCommand",
"description": [],
"signature": [
"(command: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printCommand.$1",
"type": "CompoundType",
"tags": [],
"label": "command",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printExpression",
"type": "Function",
"tags": [],
"label": "printExpression",
"description": [],
"signature": [
"(expression: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinter.printExpression.$1",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener",
"type": "Class",
"tags": [],
"label": "ESQLErrorListener",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLErrorListener",
"text": "ESQLErrorListener"
},
" extends ",
"ErrorListener",
"<any>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError",
"type": "Function",
"tags": [],
"label": "syntaxError",
"description": [],
"signature": [
"(recognizer: ",
"Recognizer",
"<any>, offendingSymbol: any, line: number, column: number, message: string, error: ",
"RecognitionException",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$1",
"type": "Object",
"tags": [],
"label": "recognizer",
"description": [],
"signature": [
"Recognizer",
"<any>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$2",
"type": "Any",
"tags": [],
"label": "offendingSymbol",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$3",
"type": "number",
"tags": [],
"label": "line",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$4",
"type": "number",
"tags": [],
"label": "column",
"description": [],
"signature": [
"number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$5",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.syntaxError.$6",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"RecognitionException",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLErrorListener.getErrors",
"type": "Function",
"tags": [],
"label": "getErrors",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/esql_error_listener.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery",
"type": "Class",
"tags": [],
"label": "EsqlQuery",
"description": [
"\nRepresents a parsed or programmatically created ES|QL query. Keeps track of\nthe AST, source code, and optionally lexer tokens."
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.fromSrc",
"type": "Function",
"tags": [],
"label": "fromSrc",
"description": [],
"signature": [
"(src: string, opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EsqlQuery",
"text": "EsqlQuery"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.fromSrc.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.fromSrc.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "ast",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$2",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$3",
"type": "Array",
"tags": [],
"label": "tokens",
"description": [],
"signature": [
"Token",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.Unnamed.$4",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EsqlQuery.print.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/query/query.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser",
"type": "Class",
"tags": [],
"label": "Parser",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(src: string, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Parser",
"text": "Parser"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.create.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.create.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parse",
"type": "Function",
"tags": [],
"label": "parse",
"description": [],
"signature": [
"(src: string, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseResult",
"text": "ParseResult"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parse.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parse.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parseErrors",
"type": "Function",
"tags": [],
"label": "parseErrors",
"description": [],
"signature": [
"(src: string) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parseErrors.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.streams",
"type": "Object",
"tags": [],
"label": "streams",
"description": [],
"signature": [
"CharStream"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.lexer",
"type": "Object",
"tags": [],
"label": "lexer",
"description": [],
"signature": [
"default"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.tokens",
"type": "Object",
"tags": [],
"label": "tokens",
"description": [],
"signature": [
"CommonTokenStream"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parser",
"type": "Object",
"tags": [],
"label": "parser",
"description": [],
"signature": [
"default"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLErrorListener",
"text": "ESQLErrorListener"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.listener",
"type": "Object",
"tags": [],
"label": "listener",
"description": [],
"signature": [
"ESQLAstBuilderListener"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.Unnamed.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parse",
"type": "Function",
"tags": [],
"label": "parse",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseResult",
"text": "ParseResult"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Parser.parseErrors",
"type": "Function",
"tags": [],
"label": "parseErrors",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker",
"type": "Class",
"tags": [],
"label": "Walker",
"description": [
"\nIterates over all nodes in the AST and calls the appropriate visitor\nfunctions."
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [
"\nWalks the AST and calls the appropriate visitor functions."
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", options: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Walker",
"text": "Walker"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find",
"type": "Function",
"tags": [],
"label": "find",
"description": [
"\nFinds and returns the first node that matches the search criteria.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", predicate: (node: ",
"ESQLProperNode",
") => boolean, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined) => ",
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to start the search from."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find.$2",
"type": "Function",
"tags": [],
"label": "predicate",
"description": [
"A function that returns true if the node matches the search criteria."
],
"signature": [
"(node: ",
"ESQLProperNode",
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.find.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"The first node that matches the search criteria."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll",
"type": "Function",
"tags": [],
"label": "findAll",
"description": [
"\nFinds and returns all nodes that match the search criteria.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", predicate: (node: ",
"ESQLProperNode",
") => boolean, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined) => ",
"ESQLProperNode",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to start the search from."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll.$2",
"type": "Function",
"tags": [],
"label": "predicate",
"description": [
"A function that returns true if the node matches the search criteria."
],
"signature": [
"(node: ",
"ESQLProperNode",
") => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findAll.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"All nodes that match the search criteria."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match",
"type": "Function",
"tags": [],
"label": "match",
"description": [
"\nMatches a single node against a template object. Returns the first node\nthat matches the template. The *template* object is a sparse representation\nof the node structure, where each property corresponds to a node type or\nproperty to match against.\n\n- An array matches if the node key is in the array.\n- A RegExp matches if the node key matches the RegExp.\n- Any other value matches if the node key is triple-equal to the value.\n\nFor example, match the first `literal`:\n\n```typescript\nconst literal = Walker.match(ast, { type: 'literal' });\n```\n\nFind the first `literal` with a specific value:\n\n```typescript\nconst number42 = Walker.match(ast, { type: 'literal', value: 42 });\n```\n\nFind the first literal of type `integer` or `decimal`:\n\n```typescript\nconst number = Walker.match(ast, {\n type: 'literal',\n literalType: [ 'integer', 'decimal' ],\n});\n```\n\nFinally, you can also match any field by regular expression. Find\nthe first `source` AST node, which has \"log\" in its name:\n\n```typescript\nconst logSource = Walker.match(ast, { type: 'source', name: /.+log.+/ });\n```\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", template: ",
"NodeMatchTemplate",
", options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined) => ",
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to match against the template."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match.$2",
"type": "Object",
"tags": [],
"label": "template",
"description": [
"Template object to match against the node."
],
"signature": [
"NodeMatchTemplate"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.match.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"The first node that matches the template"
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll",
"type": "Function",
"tags": [],
"label": "matchAll",
"description": [
"\nMatches all nodes against a template object. Returns all nodes that match\nthe template.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", template: ",
"NodeMatchTemplate",
", options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined) => ",
"ESQLProperNode",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to match against the template."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll.$2",
"type": "Object",
"tags": [],
"label": "template",
"description": [
"Template object to match against the node."
],
"signature": [
"NodeMatchTemplate"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.matchAll.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
"All nodes that match the template"
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.commands",
"type": "Function",
"tags": [],
"label": "commands",
"description": [
"\nWalks the AST and extracts all command statements.\n"
],
"signature": [
"(tree: Node, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.commands.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to extract parameters from."
],
"signature": [
"Node"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.commands.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.params",
"type": "Function",
"tags": [],
"label": "params",
"description": [
"\nWalks the AST and extracts all parameter literals.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
">[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.params.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to extract parameters from."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.params.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction",
"type": "Function",
"tags": [],
"label": "findFunction",
"description": [
"\nFinds the first function that matches the predicate.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", predicateOrName: string | ((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => boolean)) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node from which to search for a function"
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction.$2",
"type": "CompoundType",
"tags": [],
"label": "predicateOrName",
"description": [
"Callback to determine if the function is found or\na string with the function name."
],
"signature": [
"string | ((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => boolean)"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The first function that matches the predicate"
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.hasFunction",
"type": "Function",
"tags": [],
"label": "hasFunction",
"description": [
"\nSearches for at least one occurrence of a function by name.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", name: string) => boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.hasFunction.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST subtree to search in."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.hasFunction.$2",
"type": "string",
"tags": [],
"label": "name",
"description": [
"Function or expression name to search for."
],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"True if the function or expression is found in the AST."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.parent",
"type": "Function",
"tags": [],
"label": "parent",
"description": [
"\nReturns the parent node of the given child node.\n\nFor example, if the child node is a source node, this method will return\nthe `FROM` command that contains the source:\n\n```typescript\nconst { ast } = EsqlQuery.fromSrc('FROM index');\nconst child = Walker.match(ast, { type: 'source' });\nconst parent = Walker.parent(ast, child); // FROM\nconst grandParent = Walker.parent(ast, parent); // query expression\n```\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", child: ",
"ESQLProperNode",
") => ",
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.parent.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.parent.$2",
"type": "CompoundType",
"tags": [],
"label": "child",
"description": [
"The child node for which to find the parent."
],
"signature": [
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"The parent node of the child, if found."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.parents",
"type": "Function",
"tags": [],
"label": "parents",
"description": [
"\nReturns an array of parent nodes for the given child node.\nThis method traverses the AST upwards from the child node\nand collects all parent nodes until it reaches the root. The\nmost immediate parent is the first element in the array,\nand the root node is the last element.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", child: ",
"ESQLProperNode",
") => ",
"ESQLProperNode",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.parents.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to search in."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.parents.$2",
"type": "CompoundType",
"tags": [],
"label": "child",
"description": [
"The child node for which to find the parents."
],
"signature": [
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"An array of parent nodes for the child, if found."
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.visitComments",
"type": "Function",
"tags": [],
"label": "visitComments",
"description": [
"\nVisits all comment nodes in the AST. Comments are part of the *hidden*\nchannel and normally not part of the AST. To parse the comments, you\nneed to run the parser with `withFormatting` option set to `true`.\n"
],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", callback: (comment: ",
"ESQLAstComment",
", node: ",
"ESQLProperNode",
", attachment: keyof ",
"ESQLAstNodeFormatting",
") => void) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.visitComments.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [
"AST node to search in."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.visitComments.$2",
"type": "Function",
"tags": [],
"label": "callback",
"description": [
"Callback function that is called for each comment node.\nThe callback receives the comment node, the node it is attached to,\nand the attachment type (top, left, right, rightSingleLine, bottom)."
],
"signature": [
"(comment: ",
"ESQLAstComment",
", node: ",
"ESQLProperNode",
", attachment: keyof ",
"ESQLAstNodeFormatting",
") => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.aborted",
"type": "boolean",
"tags": [],
"label": "aborted",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.abort",
"type": "Function",
"tags": [],
"label": "abort",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
" | undefined, parent?: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkList",
"type": "Function",
"tags": [],
"label": "walkList",
"description": [],
"signature": [
"(list: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[], parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkList.$1",
"type": "Array",
"tags": [],
"label": "list",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkList.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkCommand",
"type": "Function",
"tags": [],
"label": "walkCommand",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
", parent: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkCommand.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkCommand.$2",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOption",
"type": "Function",
"tags": [],
"label": "walkOption",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
", parent: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOption.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOption.$2",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkExpression",
"type": "Function",
"tags": [],
"label": "walkExpression",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
"> | ",
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
"ESQLMap",
" | ",
"ESQLMapEntry",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[], parent?: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkExpression.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
"> | ",
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
"ESQLMap",
" | ",
"ESQLMapEntry",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkExpression.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkListLiteral",
"type": "Function",
"tags": [],
"label": "walkListLiteral",
"description": [],
"signature": [
"(node: ",
"ESQLList",
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkListLiteral.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLList"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkListLiteral.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSource",
"type": "Function",
"tags": [],
"label": "walkSource",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSource.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSource.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkColumn",
"type": "Function",
"tags": [],
"label": "walkColumn",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkColumn.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkColumn.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOrder",
"type": "Function",
"tags": [],
"label": "walkOrder",
"description": [],
"signature": [
"(node: ",
"ESQLOrderExpression",
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOrder.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLOrderExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkOrder.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkInlineCast",
"type": "Function",
"tags": [],
"label": "walkInlineCast",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">, parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkInlineCast.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkInlineCast.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkFunction",
"type": "Function",
"tags": [],
"label": "walkFunction",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>, parent?: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkFunction.$1",
"type": "Object",
"tags": [],
"label": "node",
"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-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkFunction.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMap",
"type": "Function",
"tags": [],
"label": "walkMap",
"description": [],
"signature": [
"(node: ",
"ESQLMap",
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMap.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLMap"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMap.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMapEntry",
"type": "Function",
"tags": [],
"label": "walkMapEntry",
"description": [],
"signature": [
"(node: ",
"ESQLMapEntry",
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMapEntry.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLMapEntry"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMapEntry.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkQuery",
"type": "Function",
"tags": [],
"label": "walkQuery",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkQuery.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkQuery.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSingleAstItem",
"type": "Function",
"tags": [],
"label": "walkSingleAstItem",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
", parent: ",
"ESQLProperNode",
" | undefined) => void"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSingleAstItem.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkSingleAstItem.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter",
"type": "Class",
"tags": [],
"label": "WrappingPrettyPrinter",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", opts?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print.$2",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.opts",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"{ indent: string; tab: string; pipeTab: string; commandTab: string; multiline: boolean; wrap: number; lowercase: boolean; lowercaseCommands: boolean; lowercaseOptions: boolean; lowercaseFunctions: boolean; lowercaseKeywords: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.keyword",
"type": "Function",
"tags": [],
"label": "keyword",
"description": [],
"signature": [
"(word: string) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.keyword.$1",
"type": "string",
"tags": [],
"label": "word",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.printTopDecorations",
"type": "Function",
"tags": [],
"label": "printTopDecorations",
"description": [],
"signature": [
"(indent: string, node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.printTopDecorations.$1",
"type": "string",
"tags": [],
"label": "indent",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.printTopDecorations.$2",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments",
"type": "Function",
"tags": [],
"label": "decorateWithComments",
"description": [],
"signature": [
"({ indent, suffix }: Input, node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>, txt: string, indented?: boolean) => { txt: string; indented: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$1",
"type": "Object",
"tags": [],
"label": "{ indent, suffix }",
"description": [],
"signature": [
"Input"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$2",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$3",
"type": "string",
"tags": [],
"label": "txt",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.decorateWithComments.$4",
"type": "boolean",
"tags": [],
"label": "indented",
"description": [],
"signature": [
"boolean"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.visitor",
"type": "Object",
"tags": [],
"label": "visitor",
"description": [],
"signature": [
"Visitor",
"<any, ",
"SharedData",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(query: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
") => any"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinter.print.$1",
"type": "Object",
"tags": [],
"label": "query",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.createParser",
"type": "Function",
"tags": [
"deprecated"
],
"label": "createParser",
"description": [],
"signature": [
"(src: string, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Parser",
"text": "Parser"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.createParser.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.createParser.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.firstItem",
"type": "Function",
"tags": [],
"label": "firstItem",
"description": [
"\nReturns the first normalized \"single item\" from the \"item\" list.\n"
],
"signature": [
"(items: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.firstItem.$1",
"type": "Array",
"tags": [],
"label": "items",
"description": [
"Returns the first \"single item\" from the \"item\" list."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"A \"single item\", if any."
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isBinaryExpression",
"type": "Function",
"tags": [],
"label": "isBinaryExpression",
"description": [
"\nReturns true if the given node is a binary expression, i.e. an operator\nsurrounded by two operands:\n\n```\n1 + 1\ncolumn LIKE \"foo\"\nfoo = \"bar\"\n```\n"
],
"signature": [
"(node: unknown) => node is ",
"ESQLBinaryExpression",
"<",
"BinaryExpressionOperator",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isBinaryExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [
"Any ES|QL AST node."
],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isColumn",
"type": "Function",
"tags": [],
"label": "isColumn",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isColumn.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isDoubleLiteral",
"type": "Function",
"tags": [],
"label": "isDoubleLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLIntegerLiteral"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isDoubleLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFieldExpression",
"type": "Function",
"tags": [],
"label": "isFieldExpression",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLBinaryExpression",
"<\"where\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFieldExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFunctionExpression",
"type": "Function",
"tags": [],
"label": "isFunctionExpression",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isFunctionExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIdentifier",
"type": "Function",
"tags": [],
"label": "isIdentifier",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIdentifier.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIntegerLiteral",
"type": "Function",
"tags": [],
"label": "isIntegerLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLIntegerLiteral"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isIntegerLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isLiteral",
"type": "Function",
"tags": [],
"label": "isLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isParamLiteral",
"type": "Function",
"tags": [],
"label": "isParamLiteral",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isParamLiteral.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isProperNode",
"type": "Function",
"tags": [],
"label": "isProperNode",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isProperNode.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isSource",
"type": "Function",
"tags": [],
"label": "isSource",
"description": [],
"signature": [
"(node: unknown) => node is ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isSource.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isWhereExpression",
"type": "Function",
"tags": [],
"label": "isWhereExpression",
"description": [],
"signature": [
"(node: unknown) => node is ",
"ESQLBinaryExpression",
"<\"where\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.isWhereExpression.$1",
"type": "Unknown",
"tags": [],
"label": "node",
"description": [],
"signature": [
"unknown"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/ast/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.lastItem",
"type": "Function",
"tags": [],
"label": "lastItem",
"description": [
"\nReturns the last normalized \"single item\" from the \"item\" list.\n"
],
"signature": [
"(items: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.lastItem.$1",
"type": "Array",
"tags": [],
"label": "items",
"description": [
"Returns the last \"single item\" from the \"item\" list."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"A \"single item\", if any."
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse",
"type": "Function",
"tags": [
"deprecated"
],
"label": "parse",
"description": [],
"signature": [
"(src: string | undefined, options?: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseResult",
"text": "ParseResult"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/resources_helpers.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts"
},
{
"plugin": "@kbn/monaco",
"path": "src/platform/packages/shared/kbn-monaco/src/languages/esql/lib/hover/hover.ts"
},
{
"plugin": "@kbn/monaco",
"path": "src/platform/packages/shared/kbn-monaco/src/languages/esql/lib/hover/hover.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_cannot_be_sampled.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_cannot_be_sampled.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/correct_with_ast.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/correct_with_ast.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/alert_rule_from_vis_ui_action/escape_field_name_factory.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/alert_rule_from_vis_ui_action/escape_field_name_factory.ts"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/alert_rule_from_vis_ui_action/rule_flyout_component.tsx"
},
{
"plugin": "triggersActionsUi",
"path": "x-pack/platform/plugins/shared/triggers_actions_ui/public/common/alert_rule_from_vis_ui_action/rule_flyout_component.tsx"
},
{
"plugin": "discover",
"path": "src/platform/plugins/shared/discover/public/context_awareness/profile_providers/observability/logs_data_source_profile/accessors/get_row_additional_leading_controls.ts"
},
{
"plugin": "discover",
"path": "src/platform/plugins/shared/discover/public/context_awareness/profile_providers/observability/logs_data_source_profile/accessors/get_row_additional_leading_controls.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/common/es_query/esql_query_utils.ts"
},
{
"plugin": "@kbn/securitysolution-utils",
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts"
},
{
"plugin": "@kbn/securitysolution-utils",
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts"
},
{
"plugin": "@kbn/securitysolution-utils",
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts"
},
{
"plugin": "@kbn/securitysolution-utils",
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/parse_esql_query.ts"
},
{
"plugin": "@kbn/securitysolution-utils",
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_mv_expand_fields.ts"
},
{
"plugin": "@kbn/securitysolution-utils",
"path": "x-pack/solutions/security/packages/kbn-securitysolution-utils/src/esql/get_mv_expand_fields.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/common/utils/esql.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/common/utils/esql.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/assistant/tools/esql/graphs/generate_esql/nodes/validate_esql_in_last_message_node/utils.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/assistant/tools/esql/graphs/generate_esql/nodes/validate_esql_in_last_message_node/utils.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/like.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/like.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/like.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/like.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/like.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/like.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "inference",
"path": "x-pack/platform/plugins/shared/inference/common/tasks/nl_to_esql/ast/corrections/timespan_literals.test.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.test.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.test.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.test.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/helper.test.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/helper.test.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.test.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.test.ts"
}
],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parse.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ParseOptions",
"text": "ParseOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parseErrors",
"type": "Function",
"tags": [
"deprecated"
],
"label": "parseErrors",
"description": [],
"signature": [
"(src: string) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.parseErrors.$1",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.resolveItem",
"type": "Function",
"tags": [],
"label": "resolveItem",
"description": [],
"signature": [
"(items: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.resolveItem.$1",
"type": "CompoundType",
"tags": [],
"label": "items",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.singleItems",
"type": "Function",
"tags": [],
"label": "singleItems",
"description": [
"\nNormalizes AST \"item\" list to only contain *single* items.\n"
],
"signature": [
"(items: Iterable<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
"> | ",
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
"ESQLMap",
" | ",
"ESQLMapEntry",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]>) => Iterable<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.singleItems.$1",
"type": "Object",
"tags": [],
"label": "items",
"description": [
"A list of single or nested items."
],
"signature": [
"Iterable<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
"> | ",
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
"ESQLMap",
" | ",
"ESQLMapEntry",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/visitor/utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [],
"signature": [
"(tree: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerAstNode",
"text": "WalkerAstNode"
},
", options: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
},
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Walker",
"text": "Walker"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk.$1",
"type": "CompoundType",
"tags": [],
"label": "tree",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WalkerOptions",
"text": "WalkerOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions",
"type": "Interface",
"tags": [],
"label": "BasicPrettyPrinterOptions",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.multiline",
"type": "CompoundType",
"tags": [],
"label": "multiline",
"description": [
"\nWhether to break the query into multiple lines on each pipe. Defaults to\n`false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.pipeTab",
"type": "string",
"tags": [],
"label": "pipeTab",
"description": [
"\nTabbing string inserted before a pipe, when `multiline` is `true`. Defaults\nto two spaces."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercase",
"type": "CompoundType",
"tags": [],
"label": "lowercase",
"description": [
"\nThe default lowercase setting to use for all options. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseCommands",
"type": "CompoundType",
"tags": [],
"label": "lowercaseCommands",
"description": [
"\nWhether to lowercase command names. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseOptions",
"type": "CompoundType",
"tags": [],
"label": "lowercaseOptions",
"description": [
"\nWhether to lowercase command options. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseFunctions",
"type": "CompoundType",
"tags": [],
"label": "lowercaseFunctions",
"description": [
"\nWhether to lowercase function names. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterOptions.lowercaseKeywords",
"type": "CompoundType",
"tags": [],
"label": "lowercaseKeywords",
"description": [
"\nWhether to lowercase keywords. Defaults to `false`."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError",
"type": "Interface",
"tags": [],
"label": "EditorError",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.startLineNumber",
"type": "number",
"tags": [],
"label": "startLineNumber",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.endLineNumber",
"type": "number",
"tags": [],
"label": "endLineNumber",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.startColumn",
"type": "number",
"tags": [],
"label": "startColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.endColumn",
"type": "number",
"tags": [],
"label": "endColumn",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError.severity",
"type": "CompoundType",
"tags": [],
"label": "severity",
"description": [],
"signature": [
"number | \"error\" | \"warning\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstBaseItem",
"type": "Interface",
"tags": [],
"label": "ESQLAstBaseItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<Name>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstBaseItem.name",
"type": "Uncategorized",
"tags": [],
"label": "name",
"description": [],
"signature": [
"Name"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstBaseItem.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstBaseItem.location",
"type": "Object",
"tags": [],
"label": "location",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstBaseItem.incomplete",
"type": "boolean",
"tags": [],
"label": "incomplete",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstBaseItem.formatting",
"type": "Object",
"tags": [],
"label": "formatting",
"description": [],
"signature": [
"ESQLAstNodeFormatting",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstChangePointCommand",
"type": "Interface",
"tags": [],
"label": "ESQLAstChangePointCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstChangePointCommand",
"text": "ESQLAstChangePointCommand"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<\"change_point\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstChangePointCommand.value",
"type": "Object",
"tags": [],
"label": "value",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstChangePointCommand.key",
"type": "Object",
"tags": [],
"label": "key",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstChangePointCommand.target",
"type": "Object",
"tags": [],
"label": "target",
"description": [],
"signature": [
"{ type: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
"; pvalue: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
"; } | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstJoinCommand",
"type": "Interface",
"tags": [],
"label": "ESQLAstJoinCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstJoinCommand",
"text": "ESQLAstJoinCommand"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<\"join\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstJoinCommand.commandType",
"type": "CompoundType",
"tags": [],
"label": "commandType",
"description": [],
"signature": [
"\"right\" | \"left\" | \"lookup\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstQueryExpression",
"type": "Interface",
"tags": [],
"label": "ESQLAstQueryExpression",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<\"\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstQueryExpression.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"query\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstQueryExpression.commands",
"type": "Array",
"tags": [],
"label": "commands",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstTimeseriesCommand",
"type": "Interface",
"tags": [],
"label": "ESQLAstTimeseriesCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstTimeseriesCommand",
"text": "ESQLAstTimeseriesCommand"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<\"ts\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstTimeseriesCommand.sources",
"type": "Array",
"tags": [],
"label": "sources",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn",
"type": "Interface",
"tags": [],
"label": "ESQLColumn",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"column\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [
"\nA ES|QL column name can be composed of multiple parts,\ne.g: part1.part2.`part``3⃣`.?param. Where parts can be quoted, or not\nquoted, or even be a parameter.\n\nThe args list contains the parts of the column name."
],
"signature": [
"(",
"ESQLIdentifier",
" | ",
"ESQLParam",
")[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.parts",
"type": "Array",
"tags": [],
"label": "parts",
"description": [
"\nAn identifier can be composed of multiple parts, e.g: part1.part2.`part``3⃣`.\nThis property contains the parsed unquoted parts of the identifier.\nFor example: `['part1', 'part2', 'part`3⃣']`."
],
"signature": [
"string[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLColumn.quoted",
"type": "boolean",
"tags": [
"deprecated"
],
"label": "quoted",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/shared/helpers.ts"
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand",
"type": "Interface",
"tags": [],
"label": "ESQLCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<Name> extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<Name>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"command\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand.commandType",
"type": "string",
"tags": [],
"label": "commandType",
"description": [
"\nThe subtype of the command. For example, the `JOIN` command can be: (1)\nLOOKUP JOIN, (2) LEFT JOIN, (3) RIGHT JOIN."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommand.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandOption",
"type": "Interface",
"tags": [],
"label": "ESQLCommandOption",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandOption.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"option\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandOption.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction",
"type": "Interface",
"tags": [],
"label": "ESQLFunction",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<Subtype, Name> extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<Name>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"function\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.subtype",
"type": "Uncategorized",
"tags": [],
"label": "subtype",
"description": [
"\nDefault is 'variadic-call'."
],
"signature": [
"Subtype | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [
"\nA node representing the function or operator being called."
],
"signature": [
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLFunction.args",
"type": "Array",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLInlineCast",
"type": "Interface",
"tags": [],
"label": "ESQLInlineCast",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<ValueType> extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLInlineCast.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"inlineCast\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLInlineCast.value",
"type": "Uncategorized",
"tags": [],
"label": "value",
"description": [],
"signature": [
"ValueType"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLInlineCast.castType",
"type": "CompoundType",
"tags": [],
"label": "castType",
"description": [],
"signature": [
"\"string\" | \"boolean\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"keyword\" | \"text\" | \"date_nanos\" | \"version\" | \"integer\" | \"long\" | \"double\" | \"unsigned_long\" | \"bool\" | \"datetime\" | \"int\" | \"cartesian_point\" | \"cartesian_shape\" | \"date_period\" | \"time_duration\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLocation",
"type": "Interface",
"tags": [],
"label": "ESQLLocation",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLocation.min",
"type": "number",
"tags": [],
"label": "min",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLocation.max",
"type": "number",
"tags": [],
"label": "max",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage",
"type": "Interface",
"tags": [],
"label": "ESQLMessage",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"error\" | \"warning\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.text",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.location",
"type": "Object",
"tags": [],
"label": "location",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLMessage.code",
"type": "string",
"tags": [],
"label": "code",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral",
"type": "Interface",
"tags": [],
"label": "ESQLParamLiteral",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<ParamType, ParamKind> extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"literal\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.literalType",
"type": "string",
"tags": [],
"label": "literalType",
"description": [],
"signature": [
"\"param\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.paramKind",
"type": "Uncategorized",
"tags": [],
"label": "paramKind",
"description": [],
"signature": [
"ParamKind"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.paramType",
"type": "Uncategorized",
"tags": [],
"label": "paramType",
"description": [],
"signature": [
"ParamType"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLParamLiteral.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | number"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource",
"type": "Interface",
"tags": [],
"label": "ESQLSource",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"source\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.sourceType",
"type": "CompoundType",
"tags": [],
"label": "sourceType",
"description": [],
"signature": [
"\"index\" | \"policy\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.prefix",
"type": "Object",
"tags": [],
"label": "prefix",
"description": [
"\nRepresents the prefix part of the source identifier. Empty string if not\npresent. Used in index pattern as the cluster identifier or as \"mode\" in\nenrich policy.\n\n```\nFROM [<prefix>:]<index>\n```"
],
"signature": [
"ESQLStringLiteral",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.index",
"type": "Object",
"tags": [],
"label": "index",
"description": [
"\nRepresents the index part of the source identifier. Unescaped and unquoted.\n\n```\nFROM [<cluster>:]<index>\n```"
],
"signature": [
"ESQLStringLiteral",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.selector",
"type": "Object",
"tags": [],
"label": "selector",
"description": [
"\nRepresents the selector (component) part of the source identifier.\n\n```\nFROM <index>[::<selector>]\n```"
],
"signature": [
"ESQLStringLiteral",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval",
"type": "Interface",
"tags": [],
"label": "ESQLTimeInterval",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstBaseItem",
"text": "ESQLAstBaseItem"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.type",
"type": "string",
"tags": [
"todo"
],
"label": "type",
"description": [],
"signature": [
"\"timeInterval\""
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.unit",
"type": "string",
"tags": [],
"label": "unit",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.quantity",
"type": "number",
"tags": [],
"label": "quantity",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseOptions",
"type": "Interface",
"tags": [],
"label": "ParseOptions",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseOptions.withFormatting",
"type": "CompoundType",
"tags": [],
"label": "withFormatting",
"description": [
"\nWhether to collect and attach to AST nodes user's custom formatting:\ncomments and whitespace."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult",
"type": "Interface",
"tags": [],
"label": "ParseResult",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.root",
"type": "Object",
"tags": [],
"label": "root",
"description": [
"\nThe root *QueryExpression* node of the parsed tree."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.ast",
"type": "Array",
"tags": [
"deprecated"
],
"label": "ast",
"description": [
"\nList of parsed commands.\n"
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "src/platform/packages/shared/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/query_parsing_helpers.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/get_esql_with_safe_limit.ts"
},
{
"plugin": "@kbn/esql-utils",
"path": "src/platform/packages/shared/kbn-esql-utils/src/utils/append_to_query.ts"
}
]
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.tokens",
"type": "Array",
"tags": [],
"label": "tokens",
"description": [
"\nList of ANTLR tokens generated by the lexer."
],
"signature": [
"Token",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ParseResult.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [
"\nList of parsing errors."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions",
"type": "Interface",
"tags": [],
"label": "WalkerOptions",
"description": [],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommand",
"type": "Function",
"tags": [],
"label": "visitCommand",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>, parent: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommand.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommand.$2",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommand.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandOption",
"type": "Function",
"tags": [],
"label": "visitCommandOption",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
", parent: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandOption.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandOption.$2",
"type": "Object",
"tags": [],
"label": "parent",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandOption.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitQuery",
"type": "Function",
"tags": [],
"label": "visitQuery",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitQuery.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitQuery.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitQuery.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitFunction",
"type": "Function",
"tags": [],
"label": "visitFunction",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>, parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitFunction.$1",
"type": "Object",
"tags": [],
"label": "node",
"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-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitFunction.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitFunction.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSource",
"type": "Function",
"tags": [],
"label": "visitSource",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSource.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSource.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSource.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitColumn",
"type": "Function",
"tags": [],
"label": "visitColumn",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitColumn.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitColumn.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitColumn.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitOrder",
"type": "Function",
"tags": [],
"label": "visitOrder",
"description": [],
"signature": [
"((node: ",
"ESQLOrderExpression",
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitOrder.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLOrderExpression"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitOrder.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitOrder.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitLiteral",
"type": "Function",
"tags": [],
"label": "visitLiteral",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
},
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitLiteral.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitLiteral.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitLiteral.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitListLiteral",
"type": "Function",
"tags": [],
"label": "visitListLiteral",
"description": [],
"signature": [
"((node: ",
"ESQLList",
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitListLiteral.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLList"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitListLiteral.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitListLiteral.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitTimeIntervalLiteral",
"type": "Function",
"tags": [],
"label": "visitTimeIntervalLiteral",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitTimeIntervalLiteral.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitTimeIntervalLiteral.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitTimeIntervalLiteral.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitInlineCast",
"type": "Function",
"tags": [],
"label": "visitInlineCast",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">, parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitInlineCast.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitInlineCast.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitInlineCast.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitUnknown",
"type": "Function",
"tags": [],
"label": "visitUnknown",
"description": [],
"signature": [
"((node: ",
"ESQLUnknownItem",
", parents: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitUnknown.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLUnknownItem"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitUnknown.$2",
"type": "CompoundType",
"tags": [],
"label": "parents",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitUnknown.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitIdentifier",
"type": "Function",
"tags": [],
"label": "visitIdentifier",
"description": [],
"signature": [
"((node: ",
"ESQLIdentifier",
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitIdentifier.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitIdentifier.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitIdentifier.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMap",
"type": "Function",
"tags": [],
"label": "visitMap",
"description": [],
"signature": [
"((node: ",
"ESQLMap",
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMap.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLMap"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMap.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMap.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMapEntry",
"type": "Function",
"tags": [],
"label": "visitMapEntry",
"description": [],
"signature": [
"((node: ",
"ESQLMapEntry",
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMapEntry.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLMapEntry"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMapEntry.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitMapEntry.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSingleAstItem",
"type": "Function",
"tags": [
"todo"
],
"label": "visitSingleAstItem",
"description": [
"\nCalled on every expression node.\n"
],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSingleAstItem.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSingleAstItem.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitSingleAstItem.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitAny",
"type": "Function",
"tags": [],
"label": "visitAny",
"description": [
"\nCalled for any node type that does not have a specific visitor.\n"
],
"signature": [
"((node: ",
"ESQLProperNode",
", parent: ",
"ESQLProperNode",
" | undefined, walker: ",
"WalkerVisitorApi",
") => void) | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitAny.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [
"Any valid AST node."
],
"signature": [
"ESQLProperNode"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitAny.$2",
"type": "CompoundType",
"tags": [],
"label": "parent",
"description": [],
"signature": [
"ESQLProperNode",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitAny.$3",
"type": "Object",
"tags": [],
"label": "walker",
"description": [],
"signature": [
"WalkerVisitorApi"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.order",
"type": "CompoundType",
"tags": [
"default"
],
"label": "order",
"description": [
"\nOrder in which to traverse child nodes. If set to 'forward', child nodes\nare traversed in the order they appear in the AST. If set to 'backward',\nchild nodes are traversed in reverse order.\n"
],
"signature": [
"\"forward\" | \"backward\" | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions",
"type": "Interface",
"tags": [],
"label": "WrappingPrettyPrinterOptions",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.WrappingPrettyPrinterOptions",
"text": "WrappingPrettyPrinterOptions"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.BasicPrettyPrinterOptions",
"text": "BasicPrettyPrinterOptions"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.indent",
"type": "string",
"tags": [],
"label": "indent",
"description": [
"\nInitial indentation string inserted before the whole query. Defaults to an\nempty string."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.tab",
"type": "string",
"tags": [],
"label": "tab",
"description": [
"\nTabbing string inserted before new level of nesting. Defaults to two spaces."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.pipeTab",
"type": "string",
"tags": [],
"label": "pipeTab",
"description": [
"\nTabbing string inserted before a pipe, when `multiline` is `true`."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.commandTab",
"type": "string",
"tags": [],
"label": "commandTab",
"description": [
"\nTabbing string inserted before command arguments, when they are broken into\nmultiple lines. Defaults to four spaces."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.multiline",
"type": "CompoundType",
"tags": [],
"label": "multiline",
"description": [
"\nWhether to force multiline formatting. Defaults to `false`. If set to\n`false`, it will try to fit the query into a single line."
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WrappingPrettyPrinterOptions.wrap",
"type": "number",
"tags": [],
"label": "wrap",
"description": [
"\nExpected width of the output. Defaults to 80 characters. Text will be\nwrapped to fit this width."
],
"signature": [
"number | undefined"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/wrapping_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstNodeParserFields",
"type": "Type",
"tags": [],
"label": "AstNodeParserFields",
"description": [
"\nNode fields which are available only when the node is minted by the parser.\nWhen creating nodes manually, these fields are not available."
],
"signature": [
"{ text: string; location: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLocation",
"text": "ESQLLocation"
},
"; incomplete: boolean; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/builder/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstNodeTemplate",
"type": "Type",
"tags": [],
"label": "AstNodeTemplate",
"description": [
"\nThe node *template* transforms ES|QL AST nodes into a permissive shape, with\nthe aim to:\n\n- Remove the `type` property, as the builder will set it.\n- Make properties like `text`, `location`, and `incomplete` optional, as they\n are a available only when the AST node is minted by the parser.\n- Make all other properties optional, for easy node creation."
],
"signature": [
"Omit<Node, \"type\" | \"text\" | \"location\" | \"incomplete\"> & Partial<Omit<Node, \"type\">>"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/builder/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.BasicPrettyPrinterMultilineOptions",
"type": "Type",
"tags": [],
"label": "BasicPrettyPrinterMultilineOptions",
"description": [],
"signature": [
"{ lowercase?: boolean | undefined; pipeTab?: string | undefined; lowercaseCommands?: boolean | undefined; lowercaseOptions?: boolean | undefined; lowercaseFunctions?: boolean | undefined; lowercaseKeywords?: boolean | undefined; }"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/basic_pretty_printer.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAst",
"type": "Type",
"tags": [],
"label": "ESQLAst",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstCommand",
"text": "ESQLAstCommand"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstCommand",
"type": "Type",
"tags": [],
"label": "ESQLAstCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstTimeseriesCommand",
"text": "ESQLAstTimeseriesCommand"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstJoinCommand",
"text": "ESQLAstJoinCommand"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstChangePointCommand",
"text": "ESQLAstChangePointCommand"
},
" | ",
"ESQLAstRerankCommand",
" | ",
"ESQLAstCompletionCommand"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstItem",
"type": "Type",
"tags": [],
"label": "ESQLAstItem",
"description": [
"\nAn array of AST nodes represents different things in different contexts.\nFor example, in command top level arguments it is treated as an \"assignment expression\"."
],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstNode",
"type": "Type",
"tags": [],
"label": "ESQLAstNode",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstTimeseriesCommand",
"text": "ESQLAstTimeseriesCommand"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstJoinCommand",
"text": "ESQLAstJoinCommand"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstChangePointCommand",
"text": "ESQLAstChangePointCommand"
},
" | ",
"ESQLAstRerankCommand",
" | ",
"ESQLAstCompletionCommand",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
"> | ",
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
"ESQLMap",
" | ",
"ESQLMapEntry",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLLiteral",
"type": "Type",
"tags": [],
"label": "ESQLLiteral",
"description": [],
"signature": [
"ESQLDecimalLiteral",
" | ",
"ESQLIntegerLiteral",
" | ",
"ESQLBooleanLiteral",
" | ",
"ESQLNullLiteral",
" | ",
"ESQLStringLiteral",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSingleAstItem",
"type": "Type",
"tags": [],
"label": "ESQLSingleAstItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstQueryExpression",
"text": "ESQLAstQueryExpression"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string> | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandOption",
"text": "ESQLCommandOption"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
" | ",
"ESQLList",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
},
" | ",
"ESQLIdentifier",
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLInlineCast",
"text": "ESQLInlineCast"
},
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLOrderExpression",
" | ",
"ESQLUnknownItem",
" | ",
"ESQLMap",
" | ",
"ESQLMapEntry"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerAstNode",
"type": "Type",
"tags": [],
"label": "WalkerAstNode",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstNode",
"text": "ESQLAstNode"
},
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Builder",
"type": "Object",
"tags": [],
"label": "Builder",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.Builder",
"text": "Builder"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/builder/builder.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter",
"type": "Object",
"tags": [],
"label": "LeafPrinter",
"description": [
"\nPrinter for leaf AST nodes. The printing output of these nodes should\ntypically not depend on word wrapping settings, should always return an\natomic short string."
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.source",
"type": "Function",
"tags": [],
"label": "source",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.source.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.identifier",
"type": "Function",
"tags": [],
"label": "identifier",
"description": [],
"signature": [
"(node: ",
"ESQLIdentifier",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.identifier.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLIdentifier"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.column",
"type": "Function",
"tags": [],
"label": "column",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.column.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLColumn",
"text": "ESQLColumn"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.string",
"type": "Function",
"tags": [],
"label": "string",
"description": [],
"signature": [
"(node: Pick<",
"ESQLStringLiteral",
", \"valueUnquoted\" | \"unquoted\">) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.string.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
"Pick<",
"ESQLStringLiteral",
", \"valueUnquoted\" | \"unquoted\">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.literal",
"type": "Function",
"tags": [],
"label": "literal",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.literal.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLLiteral",
"text": "ESQLLiteral"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.param",
"type": "Function",
"tags": [],
"label": "param",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
">) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.param.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string, ",
"ESQLParamKinds",
">"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.timeInterval",
"type": "Function",
"tags": [],
"label": "timeInterval",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
},
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.timeInterval.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLTimeInterval",
"text": "ESQLTimeInterval"
}
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.comment",
"type": "Function",
"tags": [],
"label": "comment",
"description": [],
"signature": [
"(node: ",
"ESQLAstComment",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.comment.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLAstComment"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.commentList",
"type": "Function",
"tags": [],
"label": "commentList",
"description": [],
"signature": [
"(comments: ",
"ESQLAstCommentMultiLine",
"[]) => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.commentList.$1",
"type": "Array",
"tags": [],
"label": "comments",
"description": [],
"signature": [
"ESQLAstCommentMultiLine",
"[]"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.print",
"type": "Function",
"tags": [],
"label": "print",
"description": [],
"signature": [
"(node: ",
"ESQLProperNode",
" | ",
"ESQLAstComment",
") => string"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.LeafPrinter.print.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
"ESQLProperNode",
" | ",
"ESQLAstComment"
],
"path": "src/platform/packages/shared/kbn-esql-ast/src/pretty_print/leaf_printer.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
]
}
}