Skip to content

Commit e2b7896

Browse files
committed
Re-add missing doc that was deleted.
Signed-off-by: forestmvey <[email protected]>
1 parent 14b8bba commit e2b7896

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

docs/dev/index.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
2+
# OpenSearch SQL/PPL Engine Development Manual
3+
4+
## Introduction
5+
6+
+ [Architecture](intro-architecture.md): a quick overview of architecture
7+
+ [V2 Engine](intro-v2-engine.md): introduces why we developed new V2 engine
8+
+ Concepts
9+
+ Quickstart
10+
11+
---
12+
## Clients
13+
14+
+ **CLI**
15+
+ **JDBC Driver**
16+
+ **ODBC Driver**
17+
+ **Query Workbench**
18+
19+
---
20+
## Deployment
21+
22+
+ **Standalone Mode**
23+
+ **OpenSearch Cluster**
24+
25+
---
26+
## Programming Guides
27+
28+
+ **API**
29+
+ **JavaDoc**
30+
31+
---
32+
## Development Guides
33+
34+
### Language Processing
35+
36+
+ **SQL**
37+
+ [Aggregate Window Function](sql-aggregate-window-function.md): aggregate window function support
38+
+ **Piped Processing Language**
39+
40+
### Query Processing
41+
42+
+ **Query Analyzing**
43+
+ [Semantic Analysis](query-semantic-analysis.md): performs semantic analysis to ensure semantic correctness
44+
+ [Type Conversion](query-type-conversion.md): implement implicit data type conversion
45+
+ **Query Planning**
46+
+ [Logical Optimization](query-optimizier-improvement.md): improvement on logical optimizer and physical implementer
47+
+ **Query Execution**
48+
+ [Query Manager](query-manager.md): query management
49+
+ **Query Acceleration**
50+
+ [Automatic Acceleration](query-automatic-acceleration.md): workload based automatic query acceleration proposal
51+
52+
### Data Sources
53+
54+
+ **OpenSearch**
55+
+ [Relevancy Search](opensearch-relevancy-search.md): OpenSearch relevancy search functions
56+
+ [Sub Queries](opensearch-nested-field-subquery.md): support sub queries on OpenSearch nested field
57+
+ [Pagination](opensearch-pagination.md): pagination implementation by OpenSearch scroll API
58+
+ [Prometheus](datasource-prometheus.md): Prometheus query federation
59+
+ **File System**
60+
+ [Querying S3](datasource-query-s3.md): S3 query federation proposal
61+
62+
---
63+
## Other Documents
64+
65+
+ **Test Framework**
66+
+ [Doc Test](testing-doctest.md): makes our doc live and runnable to ensure documentation correctness
67+
+ [Comparison Test](testing-comparison-test.md): compares with other databases to ensure functional correctness
68+
+ **Benchmark**
69+
+ [Hash Join Benchmark](testing-hash-join-benchmark.md): performance test on hash join implementation
70+
+ **Operation Tools**

0 commit comments

Comments
 (0)