ekuiper-new/docs/directory.json

{
	"cn": [
		{
			"title": "概要",
			"path": "./"
		},
		{
			"title": "快速开始",
			"children": [
				{
					"title": "本地运行",
					"path": "getting_started"
				},
				{
					"title": "Docker 容器运行",
					"path": "quick_start_docker"
				},
				{
					"title": "作为 EdgeX Foundry 规则引擎运行",
					"path": "edgex/edgex_rule_engine_tutorial"
				}
			]
		},
		{
			"title": "概念",
			"children": [
				{
					"title": "eKuiper 基本概念",
					"path": "concepts/ekuiper"
				},
				{
					"title": "规则",
					"path": "concepts/rules"
				},
				{
					"title": "Sources 源",
					"children": [
						{
							"title": "概览",
							"path": "concepts/sources/overview"
						},
						{
							"title": "流",
							"path": "concepts/sources/stream"
						},
						{
							"title": "表",
							"path": "concepts/sources/table"
						}
					]
				},
				{
					"title": "Sinks 动作",
					"path": "concepts/sinks"
				},
				{
					"title": "SQL 查询",
					"path": "concepts/sql"
				},
				{
					"title": "流式处理",
					"children": [
						{
							"title": "概览",
							"path": "concepts/streaming/overview"
						},
						{
							"title": "时间属性",
							"path": "concepts/streaming/time"
						},
						{
							"title": "窗口",
							"path": "concepts/streaming/windowing"
						},
						{
							"title": "连接",
							"path": "concepts/streaming/join"
						}
					]
				},
				{
					"title": "扩展",
					"path": "concepts/extensions"
				}
			]
		},
		{
			"title": "教程",
			"children": [
				{
					"title": "AI 教程",
					"children": [
						{
							"title": "使用 eKuiper 原生插件实现图像标注",
							"path": "tutorials/ai/tensorflow_lite_tutorial"
						},
						{
							"title": "使用 Python 函数插件运行 AI 算法",
							"path": "tutorials/ai/python_tensorflow_lite_tutorial"
						}
					]
				},
				{
					"title": "EdgeX Foundry 相关教程",
					"children": [
						{
							"title": "EdgeX Foundry 规则引擎教程",
							"path": "edgex/edgex_rule_engine_tutorial"
						},
						{
							"title": "使用 EdgeX 流的 meta 函数",
							"path": "edgex/edgex_meta"
						},
						{
							"title": "EdgeX 规则引擎使用 command 服务",
							"path": "edgex/edgex_rule_engine_command"
						},
						{
							"title": "EdgeX 源配置教程",
							"path": "edgex/edgex_source_tutorial"
						}
					]
				},
				{
					"title": "使用 eKuiper 对 Neuron 采集的数据进行流式处理",
					"path": "tutorials/neuron/neuron_integration_tutorial"
				},
				{
					"title": "通过 OpenYurt 部署教程",
					"path": "tutorials/deploy/openyurt_tutorial"
				},
				{
					"title": "功能使用教程",
					"children": [
						{
							"title": "流批结合计算",
							"path": "tutorials/table/lookup"
						},
						{
							"title": "使用 Protobuf 编解码教程",
							"path": "tutorials/usage/protobuf_tutorial"
						},
						{
							"title": "使用 Prometheus 监控规则运行状态",
							"path": "tutorials/usage/monitor_with_prometheus"
						}
					]
				}
			]
		},
		{
			"title": "参考",
			"children": [
				{
					"title": "规则",
					"children": [
						{
							"title": "概览",
							"path": "rules/overview"
						},
						{
							"title": "规则流水线",
							"path": "rules/rule_pipeline"
						},
						{
							"title": "状态和容错",
							"path": "rules/state_and_fault_tolerance"
						},{
							"title": "编解码",
							"path": "rules/codecs"
						},{
							"title": "图规则",
							"path": "rules/graph_rule"
						}
					]
				},
				{
					"title": "Sources 源",
					"children": [
						{
							"title": "概览",
							"path": "rules/sources/overview"
						},
						{
							"title": "内置源",
							"children": [
								{
									"title": "MQTT 源",
									"path": "rules/sources/builtin/mqtt"
								},
								{
									"title": "Neuron 源",
									"path": "rules/sources/builtin/neuron"
								},
								{
									"title": "EdgeX 源",
									"path": "rules/sources/builtin/edgex"
								},
								{
									"title": "HTTP 拉取源",
									"path": "rules/sources/builtin/http_pull"
								},
								{
									"title": "HTTP 推送源",
									"path": "rules/sources/builtin/http_push"
								},
								{
									"title": "内存源",
									"path": "rules/sources/builtin/memory"
								},
								{
									"title": "文件源",
									"path": "rules/sources/builtin/file"
								},
								{
									"title": "Redis 源",
									"path": "rules/sources/builtin/redis"
								}
							]
						},
						{
							"title": "预定义插件源",
							"children": [
								{
									"title": "Zero MQ 源",
									"path": "rules/sources/plugin/zmq"
								},
								{
									"title": "SQL 源",
									"path": "rules/sources/plugin/sql"
								},
								{
									"title": "随机源",
									"path": "rules/sources/plugin/random"
								},
								{
									"title": "视频源",
									"path": "rules/sources/plugin/video"
								}
							]
						}
					]
				},
				{
					"title": "Sinks 动作",
					"children": [
						{
							"title": "概览",
							"path": "rules/sinks/overview"
						},
						{
							"title": "数据模板",
							"path": "rules/data_template"
						},
						{
							"title": "内置 sinks",
							"children": [
								{
									"title": "MQTT 动作",
									"path": "rules/sinks/builtin/mqtt"
								},
								{
									"title": "Neuron 动作",
									"path": "rules/sinks/builtin/neuron"
								},
								{
									"title": "EdgeX 动作",
									"path": "rules/sinks/builtin/edgex"
								},
								{
									"title": "REST 动作",
									"path": "rules/sinks/builtin/rest"
								},
								{
									"title": "内存动作",
									"path": "rules/sinks/builtin/memory"
								},
								{
									"title": "日志动作",
									"path": "rules/sinks/builtin/log"
								},
								{
									"title": "Nop 动作",
									"path": "rules/sinks/builtin/nop"
								},
								{
									"title": "Redis 动作",
									"path": "rules/sinks/builtin/redis"
								}
							]
						},
						{
							"title": "预定义 sink 插件",
							"children": [
								{
									"title": "Zero MQ 动作",
									"path": "rules/sinks/plugin/zmq"
								},
								{
									"title": "文件动作",
									"path": "rules/sinks/plugin/file"
								},
								{
									"title": "SQL 动作",
									"path": "rules/sinks/plugin/sql"
								},
								{
									"title": "InfluxDB 动作",
									"path": "rules/sinks/plugin/influx"
								},
								{
									"title": "InfluxDBV2 动作",
									"path": "rules/sinks/plugin/influx2"
								},
								{
									"title": "TDengine 动作",
									"path": "rules/sinks/plugin/tdengine"
								},
								{
									"title": "图像动作",
									"path": "rules/sinks/plugin/image"
								}
							]
						}
					]
				},
				{
					"title": "SQL 参考",
					"children": [
						{
							"title": "语法",
							"children": [
								{
									"title": "概览",
									"path": "sqls/overview"
								},
								{
									"title": "词汇元素",
									"path": "sqls/lexical_elements"
								},
								{
									"title": "数据类型",
									"path": "sqls/data_types"
								},
								{
									"title": "JSON 表达式",
									"path": "sqls/json_expr"
								},
								{
									"title": "查询语言元素",
									"path": "sqls/query_language_elements"
								}
							]
						},
						{
							"title": "语句",
							"children": [
								{
									"title": "流语句",
									"path": "sqls/streams"
								},
								{
									"title": "表语句",
									"path": "sqls/tables"
								}
							]
						},
						{
							"title": "窗口",
							"path": "sqls/windows"
						},
						{
							"title": "内置函数",
							"path": "sqls/built-in_functions"
						},
						{
							"title": "预定义函数插件",
							"path": "sqls/custom_functions"
						}
					]
				}
			]
		},
		{
			"title": "扩展开发",
			"children": [
				{
					"title": "概览",
					"path": "extension/overview"
				},
				{
					"title": "原生插件开发",
					"children": [
						{
							"title": "总览",
							"path": "extension/native/overview"
						},
						{
							"title": "原生插件总览",
							"path": "extension/native/develop/overview"
						},
						{
							"title": "插件开发教程",
							"path": "extension/native/develop/plugins_tutorial"
						},
						{
							"title": "函数插件开发",
							"path": "extension/native/develop/function"
						},
						{
							"title": "动作插件开发",
							"path": "extension/native/develop/sink"
						},
						{
							"title": "源插件开发",
							"path": "extension/native/develop/source"
						}
					]
				},
				{
					"title": "Portable 插件开发",
					"children": [
						{
							"title": "Portable 插件简介",
							"path": "extension/portable/overview"
						},
						{
							"title": "Portable 插件 Go 语言 SDK",
							"path": "extension/portable/go_sdk"
						},
						{
							"title": "Portable 插件 Python 语言 SDK",
							"path": "extension/portable/python_sdk"
						}
					]
				},
				{
					"title": "外部函数",
					"path": "extension/external/external_func"
				}
			]
		},
		{
			"title": "使用指南",
			"children": [
				{
					"title": "概览",
					"path": "operation/overview"
				},
				{
					"title": "安装",
					"children": [
						{
							"title": "安装指南",
							"path": "operation/install/overview"
						},
						{
							"title": "centos 安装",
							"path": "operation/install/cent-os"
						}
					]
				},
				{
					"title": "配置",
					"children": [
						{
							"title": "配置文件",
							"path": "operation/config/configuration_file"
						},
						{
							"title": "认证配置",
							"path": "operation/config/authentication"
						}
					]
				},
				{
					"title": "Rest API 接口",
					"children": [
						{
							"title": "接口介绍",
							"path": "operation/restapi/overview"
						},
						{
							"title": "流管理",
							"path": "operation/restapi/streams"
						},
						{
							"title": "表管理",
							"path": "operation/restapi/tables"
						},
						{
							"title": "规则管理",
							"path": "operation/restapi/rules"
						},
						{
							"title": "插件管理",
							"path": "operation/restapi/plugins"
						},
						{
							"title": "外部函数管理",
							"path": "operation/restapi/services"
						},
						{
							"title": "模式管理",
							"path": "operation/restapi/schemas"
						},
						{
							"title": "上传文件管理",
							"path": "operation/restapi/uploads"
						},
						{
							"title": "规则集管理",
							"path": "operation/restapi/ruleset"
						}
					]
				},
				{
					"title": "命令行工具",
					"children": [
						{
							"title": "总览",
							"path": "operation/cli/overview"
						},
						{
							"title": "流管理",
							"path": "operation/cli/streams"
						},
						{
							"title": "表管理",
							"path": "operation/cli/tables"
						},
						{
							"title": "规则管理",
							"path": "operation/cli/rules"
						},
						{
							"title": "插件管理",
							"path": "operation/cli/plugins"
						},
						{
							"title": "模式管理",
							"path": "operation/cli/schemas"
						},
						{
							"title": "规则集管理",
							"path": "operation/cli/ruleset"
						}
					]
				},
				{
					"title": "管理控制台",
					"children": [
						{
							"title": "控制台使用",
							"path": "operation/manager-ui/overview"
						},
						{
							"title": "插件管理",
							"path": "operation/manager-ui/plugins_in_manager"
						}
					]
				},
				{
					"title": "编译",
					"children": [
						{
							"title": "编译指南",
							"path": "operation/compile/compile"
						},
						{
							"title": "交叉编译",
							"path": "operation/compile/cross-compile"
						},
						{
							"title": "按需编译",
							"path": "features"
						}
					]
				}
			]
		},
		{
			"title": "贡献",
			"path": "CONTRIBUTING"
		}
	],
	"en": [
		{
			"title": "Introduction",
			"path": "./"
		},
		{
			"title": "Getting Started",
			"children": [
				{
					"title": "Getting Started",
					"path": "getting_started/getting_started"
				},
				{
					"title": "5 Minutes Quick Start",
					"path": "getting_started/quick_start_docker"
				},
				{
					"title": "Run eKuiper with EdgeX Foundry",
					"path": "edgex/edgex_rule_engine_tutorial"
				}
			]
		},
		{
			"title": "Installation",
			"children": [
				{
					"title": "Installation",
					"path": "installation"
				}
			]
		},
		{
			"title": "Configuration",
			"children": [
				{
					"title": "Configuration",
					"path": "configuration/configuration"
				},
				{
					"title": "Global Configurations",
					"path": "configuration/global_configurations"
				}
			]
		},
		{
			"title": "User Guide",
			"children": [
				{
					"title": "Stream: unbounded series of events",
					"children": [
						{
							"title": "Overview",
							"path": "guide/streams/overview"
						}
					]
				},
				{
					"title": "Table: snapshot of events",
					"children": [
						{
							"title": "Overview",
							"path": "guide/tables/overview"
						},
						{
							"title": "Scan Table",
							"path": "guide/tables/scan"
						},
						{
							"title": "Lookup Table",
							"path": "guide/tables/lookup"
						}
					]
				},
				{
					"title": "Rule: query and action",
					"children": [
						{
							"title": "Rules",
							"path": "guide/rules/overview"
						},
						{
							"title": "Graph Rule",
							"path": "guide/rules/graph_rule"
						},
						{
							"title": "Rule Pipeline",
							"path": "guide/rules/rule_pipeline"
						},
						{
							"title": "State and Fault Tolerance",
							"path": "guide/rules/state_and_fault_tolerance"
						}
					]
				},
				{
					"title": "Source Connectors",
					"children": [
						{
							"title": "Overview",
							"path": "guide/sources/overview"
						},
						{
							"title": "Built-in Sources",
							"children": [
								{
									"title": "MQTT Source",
									"path": "guide/sources/builtin/mqtt"
								},
								{
									"title": "Neuron Source",
									"path": "guide/sources/builtin/neuron"
								},
								{
									"title": "EdgeX Source",
									"path": "guide/sources/builtin/edgex"
								},
								{
									"title": "HTTP Pull Source",
									"path": "guide/sources/builtin/http_pull"
								},
								{
									"title": "HTTP Push Source",
									"path": "guide/sources/builtin/http_push"
								},
								{
									"title": "Memory Source",
									"path": "guide/sources/builtin/memory"
								},
								{
									"title": "File Source",
									"path": "guide/sources/builtin/file"
								},
								{
									"title": "Redis Source",
									"path": "guide/sources/builtin/redis"
								}
							]
						},
						{
							"title": "Predefined Source Plugins",
							"children": [
								{
									"title": "Zero MQ Source",
									"path": "guide/sources/plugin/zmq"
								},
								{
									"title": "SQL Source",
									"path": "guide/sources/plugin/sql"
								},
								{
									"title": "Random Source",
									"path": "guide/sources/plugin/random"
								},
								{
									"title": "Video Source",
									"path": "guide/sources/plugin/video"
								}
							]
						}
					]
				},
				{
					"title": "Sink Connectors",
					"children": [
						{
							"title": "Overview",
							"path": "guide/sinks/overview"
						},
						{
							"title": "Data Template",
							"path": "guide/sinks/data_template"
						},
						{
							"title": "Built-in Sinks",
							"children": [
								{
									"title": "MQTT Sink",
									"path": "guide/sinks/builtin/mqtt"
								},
								{
									"title": "Neuron Sink",
									"path": "guide/sinks/builtin/neuron"
								},
								{
									"title": "EdgeX Sink",
									"path": "guide/sinks/builtin/edgex"
								},
								{
									"title": "REST Sink",
									"path": "guide/sinks/builtin/rest"
								},
								{
									"title": "Memory Sink",
									"path": "guide/sinks/builtin/memory"
								},
								{
									"title": "Log Sink",
									"path": "guide/sinks/builtin/log"
								},
								{
									"title": "Nop Sink",
									"path": "guide/sinks/builtin/nop"
								},
								{
									"title": "Redis Sink",
									"path": "guide/sinks/builtin/redis"
								}
							]
						},
						{
							"title": "Predefined Sink Plugins",
							"children": [
								{
									"title": "ZeroMQ Sink",
									"path": "guide/sinks/plugin/zmq"
								},
								{
									"title": "File Sink",
									"path": "guide/sinks/plugin/file"
								},
								{
									"title": "SQL Sink",
									"path": "guide/sinks/plugin/sql"
								},
								{
									"title": "InfluxDB Sink",
									"path": "guide/sinks/plugin/influx"
								},
								{
									"title": "InfluxDBV2 Sink",
									"path": "guide/sinks/plugin/influx2"
								},
								{
									"title": "TDengine Sink",
									"path": "guide/sinks/plugin/tdengine"
								},
								{
									"title": "Image Sink",
									"path": "guide/sinks/plugin/image"
								}
							]
						}
					]
				},
				{
					"title": "Serialization",

					"children": [
						{
							"title": "Overview",
							"path": "guide/serialization/serialization"
						},
						{
							"title": "Protobuf Codec Tutorial",
							"path": "guide/serialization/protobuf_tutorial"
						}
					]
				},
				{
					"title": "AI/ML",
					"children": [
						{
							"title": "Running AI Algorithms with Native Plugin",
							"path": "guide/ai/tensorflow_lite_tutorial"
						},
						{
							"title": "Running AI Algorithms with Python Function Plugin",
							"path": "guide/ai/python_tensorflow_lite_tutorial"
						}
					]
				}
			]
		},
		{
			"title": "Admin Guide",
			"children": [
				{
					"title": "Installation",
					"path": "installation"
				},
				{
					"title": "Configuration",
					"children": [
						{
							"title": "Configuration",
							"path": "configuration/configuration"
						},
						{
							"title": "Global Configurations",
							"path": "configuration/global_configurations"
						}
					]
				},
				{
					"title": "Management Console",
					"children": [
						{
							"title": "Introduction",
							"path": "operation/manager-ui/overview"
						},
						{
							"title": "Plugin Management",
							"path": "operation/manager-ui/plugins_in_manager"
						}
					]
				},
				{
					"title": "Compilation",
					"children": [
						{
							"title": "Compile",
							"path": "operation/compile/compile"
						},
						{
							"title": "Cross Compile",
							"path": "operation/compile/cross-compile"
						},
						{
							"title": "Compile selected features only",
							"path": "operation/compile/features"
						}
					]
				},
				{
					"title": "Monitor",
					"children": [
						{
							"title": "Monitor with Prometheus",
							"path": "operation/usage/monitor_with_prometheus"
						}
					]
				}
			]
		},
		{
			"title": "Use Cases",
			"children": [
				{
					"title": "IIoT case",
					"path": "usecases/iiot"
				},
				{
					"title": "IoV case",
					"path": "usecases/iov"
				}
			]
		},
		{
			"title": "Integrations",
			"children": [
				{
					"title": "Edge Cloud Collaboration",
					"path": "integrations/edge_cloud/overview"
				},
				{
					"title": "Working with EdgeX Foundry",
					"children": [
						{
							"title": "EdgeX Foundry Rule Engine Tutorial",
							"path": "edgex/edgex_rule_engine_tutorial"
						},
						{
							"title": "Meta Function for EdgeX Stream",
							"path": "edgex/edgex_meta"
						},
						{
							"title": "Command EdgeX Device",
							"path": "edgex/edgex_rule_engine_command"
						},
						{
							"title": "EdgeX Source Configurations",
							"path": "edgex/edgex_source_tutorial"
						}
					]
				},
				{
					"title": "Processing Data Collected by Neuron ",
					"path": "integrations/neuron/neuron_integration_tutorial"
				},
				{
					"title": "Analytic Engine for KubeEdge",
					"path": "integrations/kubeedge/overview"
				},
				{
					"title": "Deploy by OpenYurt",
					"path": "integrations/deploy/openyurt_tutorial"
				}
			]
		},
		{
			"title": "Architecture Design",
			"children": [
				{
					"title": "Architecture",
					"path": "concepts/ekuiper"
				},
				{
					"title": "Key Concepts",
					"children": [
						{
							"title": "Rules",
							"path": "concepts/rules"
						},
						{
							"title": "Sources",
							"children": [
								{
									"title": "Overview",
									"path": "concepts/sources/overview"
								},
								{
									"title": "Stream",
									"path": "concepts/sources/stream"
								},
								{
									"title": "Table",
									"path": "concepts/sources/table"
								}
							]
						},
						{
							"title": "Sinks",
							"path": "concepts/sinks"
						},
						{
							"title": "SQL Queries",
							"path": "concepts/sql"
						},
						{
							"title": "Extensions",
							"path": "concepts/extensions"
						}
					]
				},
				{
					"title": "Stream Processing",
					"children": [
						{
							"title": "Overview",
							"path": "concepts/streaming/overview"
						},
						{
							"title": "Time Attribute",
							"path": "concepts/streaming/time"
						},
						{
							"title": "Windowing",
							"path": "concepts/streaming/windowing"
						},
						{
							"title": "Join",
							"path": "concepts/streaming/join"
						}
					]
				}
			]
		},
		{
			"title": "Developer Guide",
			"children": [
				{
					"title": "Introduction",
					"path": "extension/overview"
				},
				{
					"title": "Native Plugin Develop",
					"children": [
						{
							"title": "Overview",
							"path": "extension/native/overview"
						},
						{
							"title": "Develop",
							"path": "extension/native/develop/overview"
						},
						{
							"title": "Plugin Develop Tutorial",
							"path": "extension/native/develop/plugins_tutorial"
						},
						{
							"title": "Function Plugin",
							"path": "extension/native/develop/function"
						},
						{
							"title": "Sink Plugin",
							"path": "extension/native/develop/sink"
						},
						{
							"title": "Source Plugin",
							"path": "extension/native/develop/source"
						}
					]
				},
				{
					"title": "Portable Plugin Development",
					"children": [
						{
							"title": "Portable Plugin",
							"path": "extension/portable/overview"
						},
						{
							"title": "GO SDK for Portable Plugin",
							"path": "extension/portable/go_sdk"
						},
						{
							"title": "Python SDK for Portable Plugin",
							"path": "extension/portable/python_sdk"
						}
					]
				},
				{
					"title": "External Function",
					"path": "extension/external/external_func"
				},
				{
					"title": "Wasm Function",
					"path": "extension/wasm/overview"
				}
			]
		},
		{
			"title": "SQL Reference",
			"children": [
				{
					"title": "Statements",
					"children": [
						{
							"title": "Streams",
							"path": "sqls/streams"
						},
						{
							"title": "Tables",
							"path": "sqls/tables"
						},
						{
							"title": "Query",
							"path": "sqls/query_language_elements"
						}
					]
				},
				{
					"title": "Syntax",
					"children": [
						{
							"title": "Introduction",
							"path": "sqls/overview"
						},
						{
							"title": "Lexical elements",
							"path": "sqls/lexical_elements"
						},
						{
							"title": "Data types",
							"path": "sqls/data_types"
						},
						{
							"title": "JSON Expressions",
							"path": "sqls/json_expr"
						}
					]
				},
				{
					"title": "Built-in Functions",
					"path": "sqls/built-in_functions"
				},
				{
					"title": "Predefined function plugins",
					"path": "sqls/custom_functions"
				},
				{
					"title": "Windowing",
					"path": "sqls/windows"
				}
			]
		},
		{
			"title": "API Reference",
			"children": [
				{
					"title": "Rest API",
					"children": [
						{
							"title": "Introduction",
							"path": "api/restapi/overview"
						},
						{
							"title": "Authentication",
							"path": "api/restapi/authentication"
						},
						{
							"title": "Streams",
							"path": "api/restapi/streams"
						},
						{
							"title": "Tables",
							"path": "api/restapi/tables"
						},
						{
							"title": "Rules",
							"path": "api/restapi/rules"
						},
						{
							"title": "Plugins",
							"path": "api/restapi/plugins"
						},
						{
							"title": "External Services",
							"path": "api/restapi/services"
						},
						{
							"title": "Schemas",
							"path": "api/restapi/schemas"
						},
						{
							"title": "Upload files",
							"path": "api/restapi/uploads"
						},
						{
							"title": "Ruleset",
							"path": "api/restapi/ruleset"
						}
					]
				},
				{
					"title": "Command Line Tool",
					"children": [
						{
							"title": "Introduction",
							"path": "api/cli/overview"
						},
						{
							"title": "Streams",
							"path": "api/cli/streams"
						},
						{
							"title": "Rules",
							"path": "api/cli/rules"
						},
						{
							"title": "Tables",
							"path": "api/cli/tables"
						},
						{
							"title": "Plugins",
							"path": "api/cli/plugins"
						},
						{
							"title": "Schemas",
							"path": "api/cli/schemas"
						},
						{
							"title": "Ruleset",
							"path": "api/cli/ruleset"
						}
					]
				}
			]
		},
		{
			"title": "Contribute",
			"path": "CONTRIBUTING"
		}
	]
}