github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_esql_ast.devdocs.json

3224 lines
No EOL
104 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.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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_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": "packages/kbn-esql-ast/src/antlr_error_listener.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.\n\nAST nodes supported:\n\n- [x] command\n- [x] option\n- [x] mode\n- [x] function\n- [x] source\n- [x] column\n- [x] literal\n- [x] list literal\n- [x] timeInterval\n- [x] inlineCast\n- [x] unknown"
],
"path": "packages/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": [
"(node: ",
"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": "packages/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": "node",
"description": [],
"signature": [
"WalkerAstNode"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"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": [
"(node: Node) => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<string>[]"
],
"path": "packages/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": "node",
"description": [
"AST node to extract parameters from."
],
"signature": [
"Node"
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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": [
"(node: ",
"WalkerAstNode",
") => ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLParamLiteral",
"text": "ESQLParamLiteral"
},
"<string>[]"
],
"path": "packages/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": "node",
"description": [
"AST node to extract parameters from."
],
"signature": [
"WalkerAstNode"
],
"path": "packages/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": [
"(node: ",
"WalkerAstNode",
", predicate: (node: ",
"ESQLProperNode",
") => boolean) => ",
"ESQLProperNode",
" | undefined"
],
"path": "packages/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": "node",
"description": [
"AST node to start the search from."
],
"signature": [
"WalkerAstNode"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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": [
"(node: ",
"WalkerAstNode",
", predicate: (node: ",
"ESQLProperNode",
") => boolean) => ",
"ESQLProperNode",
"[]"
],
"path": "packages/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": "node",
"description": [
"AST node to start the search from."
],
"signature": [
"WalkerAstNode"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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.\n"
],
"signature": [
"(node: ",
"WalkerAstNode",
", template: ",
"NodeMatchTemplate",
") => ",
"ESQLProperNode",
" | undefined"
],
"path": "packages/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": "node",
"description": [
"AST node to match against the template."
],
"signature": [
"WalkerAstNode"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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": [
"(node: ",
"WalkerAstNode",
", template: ",
"NodeMatchTemplate",
") => ",
"ESQLProperNode",
"[]"
],
"path": "packages/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": "node",
"description": [
"AST node to match against the template."
],
"signature": [
"WalkerAstNode"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"All nodes that match the template"
]
},
{
"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": [
"(node: ",
"WalkerAstNode",
", predicate: (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": "packages/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": "node",
"description": [
"AST node from which to search for a function"
],
"signature": [
"WalkerAstNode"
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.findFunction.$2",
"type": "Function",
"tags": [],
"label": "predicate",
"description": [
"Callback function to determine if the function is found"
],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLFunction",
"text": "ESQLFunction"
},
"<",
"FunctionSubtype",
", string>) => boolean"
],
"path": "packages/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 or expression in the AST.\n"
],
"signature": [
"(node: ",
{
"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"
},
"[], name: string) => boolean"
],
"path": "packages/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": "node",
"description": [
"AST subtree to search in."
],
"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": "packages/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": "packages/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.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [],
"signature": [
"(node: ",
{
"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"
},
"[] | undefined) => void"
],
"path": "packages/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": "node",
"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"
},
"[] | undefined"
],
"path": "packages/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"
},
") => void"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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"
},
") => void"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkAstItem",
"type": "Function",
"tags": [],
"label": "walkAstItem",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
") => void"
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkAstItem.$1",
"type": "CompoundType",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMode",
"type": "Function",
"tags": [],
"label": "walkMode",
"description": [],
"signature": [
"(node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
") => void"
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkMode.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
}
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.Walker.walkListLiteral",
"type": "Function",
"tags": [],
"label": "walkListLiteral",
"description": [],
"signature": [
"(node: ",
"ESQLList",
") => void"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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"
},
") => void"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"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>) => void"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getAstAndSyntaxErrors",
"type": "Function",
"tags": [],
"label": "getAstAndSyntaxErrors",
"description": [],
"signature": [
"(text: string | undefined) => { errors: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]; ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
"; }"
],
"path": "packages/kbn-esql-ast/src/ast_parser.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getAstAndSyntaxErrors.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-ast/src/ast_parser.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getLexer",
"type": "Function",
"tags": [],
"label": "getLexer",
"description": [],
"signature": [
"(inputStream: ",
"CharStream",
", errorListener: ",
"ErrorListener",
"<any>) => ",
"default"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getLexer.$1",
"type": "Object",
"tags": [],
"label": "inputStream",
"description": [],
"signature": [
"CharStream"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getLexer.$2",
"type": "Object",
"tags": [],
"label": "errorListener",
"description": [],
"signature": [
"ErrorListener",
"<any>"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser",
"type": "Function",
"tags": [],
"label": "getParser",
"description": [],
"signature": [
"(inputStream: ",
"CharStream",
", errorListener: ",
"ErrorListener",
"<any>, parseListener?: ",
"default",
" | undefined) => ",
"default"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser.$1",
"type": "Object",
"tags": [],
"label": "inputStream",
"description": [],
"signature": [
"CharStream"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser.$2",
"type": "Object",
"tags": [],
"label": "errorListener",
"description": [],
"signature": [
"ErrorListener",
"<any>"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.getParser.$3",
"type": "Object",
"tags": [],
"label": "parseListener",
"description": [],
"signature": [
"default",
" | undefined"
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.walk",
"type": "Function",
"tags": [],
"label": "walk",
"description": [],
"signature": [
"(node: ",
"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": "packages/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": "node",
"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": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.EditorError",
"type": "Interface",
"tags": [],
"label": "EditorError",
"description": [],
"path": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand",
"type": "Interface",
"tags": [],
"label": "ESQLAstMetricsCommand",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
},
" extends ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommand",
"text": "ESQLCommand"
},
"<\"metrics\">"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand.sources",
"type": "Array",
"tags": [],
"label": "sources",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSource",
"text": "ESQLSource"
},
"[]"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand.aggregates",
"type": "Array",
"tags": [],
"label": "aggregates",
"description": [],
"signature": [
"ESQLAstField",
"[] | undefined"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLAstMetricsCommand.grouping",
"type": "Array",
"tags": [],
"label": "grouping",
"description": [],
"signature": [
"ESQLAstField",
"[] | undefined"
],
"path": "packages/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 ",
"ESQLAstBaseItem",
"<string>"
],
"path": "packages/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": "packages/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": "packages/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": "packages/kbn-esql-ast/src/types.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts"
},
{
"plugin": "@kbn/esql-validation-autocomplete",
"path": "packages/kbn-esql-validation-autocomplete/src/shared/variables.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 ",
"ESQLAstBaseItem",
"<Name>"
],
"path": "packages/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": "packages/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": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandMode",
"type": "Interface",
"tags": [],
"label": "ESQLCommandMode",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLCommandMode.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"mode\""
],
"path": "packages/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 ",
"ESQLAstBaseItem",
"<string>"
],
"path": "packages/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": "packages/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": "packages/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 ",
"ESQLAstBaseItem",
"<Name>"
],
"path": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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> extends ",
"ESQLAstBaseItem",
"<string>"
],
"path": "packages/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": "packages/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": "packages/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": "packages/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": "packages/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 ",
"ESQLAstBaseItem",
"<string>"
],
"path": "packages/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": "packages/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": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.cluster",
"type": "string",
"tags": [],
"label": "cluster",
"description": [
"\nRepresents the cluster part of the source identifier. Empty string if not\npresent.\n\n```\nFROM [<cluster>:]<index>\n```"
],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLSource.index",
"type": "string",
"tags": [],
"label": "index",
"description": [
"\nRepresents the index part of the source identifier. Unescaped and unquoted.\n\n```\nFROM [<cluster>:]<index>\n```"
],
"signature": [
"string | undefined"
],
"path": "packages/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 ",
"ESQLAstBaseItem",
"<string>"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ESQLTimeInterval.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"timeInterval\""
],
"path": "packages/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": "packages/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": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions",
"type": "Interface",
"tags": [],
"label": "WalkerOptions",
"description": [],
"path": "packages/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>) => void) | undefined"
],
"path": "packages/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": "packages/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"
},
") => void) | undefined"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandMode",
"type": "Function",
"tags": [],
"label": "visitCommandMode",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
") => void) | undefined"
],
"path": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.WalkerOptions.visitCommandMode.$1",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
}
],
"path": "packages/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": [],
"label": "visitSingleAstItem",
"description": [],
"signature": [
"((node: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLSingleAstItem",
"text": "ESQLSingleAstItem"
},
") => void) | undefined"
],
"path": "packages/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": "packages/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"
},
") => void) | undefined"
],
"path": "packages/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": "packages/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>) => void) | undefined"
],
"path": "packages/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": "packages/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"
},
") => void) | undefined"
],
"path": "packages/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": "packages/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"
},
") => void) | undefined"
],
"path": "packages/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": "packages/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",
") => void) | undefined"
],
"path": "packages/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": "packages/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"
},
") => void) | undefined"
],
"path": "packages/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": "packages/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: ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">) => void) | undefined"
],
"path": "packages/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": [
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
">"
],
"path": "packages/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",
") => void) | undefined"
],
"path": "packages/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": "packages/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",
") => void) | undefined"
],
"path": "packages/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": "packages/kbn-esql-ast/src/walker/walker.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstProviderFn",
"type": "Type",
"tags": [],
"label": "AstProviderFn",
"description": [],
"signature": [
"(text: string | undefined) => Promise<{ ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
"; errors: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]; }> | { ast: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAst",
"text": "ESQLAst"
},
"; errors: ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.EditorError",
"text": "EditorError"
},
"[]; }"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.AstProviderFn.$1",
"type": "string",
"tags": [],
"label": "text",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-esql-ast/src/types.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": "packages/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.ESQLAstMetricsCommand",
"text": "ESQLAstMetricsCommand"
}
],
"path": "packages/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": "packages/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.ESQLAstCommand",
"text": "ESQLAstCommand"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
}
],
"path": "packages/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>"
],
"path": "packages/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": [
"\nRepresents an *expression* in the AST."
],
"signature": [
{
"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"
},
" | ",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLCommandMode",
"text": "ESQLCommandMode"
},
" | ",
"ESQLInlineCast",
"<",
{
"pluginId": "@kbn/esql-ast",
"scope": "common",
"docId": "kibKbnEsqlAstPluginApi",
"section": "def-common.ESQLAstItem",
"text": "ESQLAstItem"
},
"> | ",
"ESQLUnknownItem"
],
"path": "packages/kbn-esql-ast/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/esql-ast",
"id": "def-common.ROOT_STATEMENT",
"type": "string",
"tags": [],
"label": "ROOT_STATEMENT",
"description": [],
"signature": [
"\"singleStatement\""
],
"path": "packages/kbn-esql-ast/src/antlr_facade.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink