OpenSearch SQL/PPL Engine Development Manual

Introduction

Architecture: a quick overview of architecture
V2 Engine: introduces why we developed new V2 engine
Concepts
Quickstart

Clients

CLI
JDBC Driver
ODBC Driver
Query Workbench

Deployment

Standalone Mode
OpenSearch Cluster

Programming Guides

API
JavaDoc

Development Guides

Language Processing

SQL
- Aggregate Window Function: aggregate window function support
Piped Processing Language

Query Processing

Query Analyzing
- Semantic Analysis: performs semantic analysis to ensure semantic correctness
- Type Conversion: implement implicit data type conversion
Query Planning
- Logical Optimization: improvement on logical optimizer and physical implementer
Query Execution
- Query Manager: query management
Query Acceleration
- Automatic Acceleration: workload based automatic query acceleration proposal

Data Sources

OpenSearch
- Relevancy Search: OpenSearch relevancy search functions
- Sub Queries: support sub queries on OpenSearch nested field
- Pagination: pagination implementation by OpenSearch scroll API
Prometheus: Prometheus query federation
File System
- Querying S3: S3 query federation proposal

Other Documents

Test Framework
- Doc Test: makes our doc live and runnable to ensure documentation correctness
- Comparison Test: compares with other databases to ensure functional correctness
Operation Tools