Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supplement ceresdb docs #555

Merged
merged 24 commits into from
Jan 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d533d35
add table operation doc
MichaelLeeHZ Oct 18, 2022
e3d748b
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Nov 1, 2022
269ce78
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Nov 21, 2022
ed0a7b0
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Nov 28, 2022
4ab04a3
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Dec 1, 2022
2c9ab5e
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Dec 6, 2022
0ba20ca
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Dec 8, 2022
a0fc88a
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Jan 5, 2023
86f2ad2
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Jan 9, 2023
095b88d
Merge branch 'main' of github.com:MachaelLee/ceresdb
MichaelLeeHZ Jan 10, 2023
33e08a3
refact docs summary
MichaelLeeHZ Jan 10, 2023
7811692
refactor docs summary
MichaelLeeHZ Jan 10, 2023
d2eb923
Update docs/guides/src/SUMMARY.md
MichaelLeeHZ Jan 10, 2023
c4546f7
rm Chinese doc
MichaelLeeHZ Jan 10, 2023
44c6923
Update docs/guides/src/operation/monitor.md
MichaelLeeHZ Jan 10, 2023
aa1e846
rename observability doc
MichaelLeeHZ Jan 10, 2023
0b4a892
Merge branch 'feature_ceresdb_doc' of github.com:MachaelLee/ceresdb i…
MichaelLeeHZ Jan 10, 2023
961c52f
Update docs/guides/src/SUMMARY.md
MichaelLeeHZ Jan 10, 2023
b5a94ae
update summary && update doc path
MichaelLeeHZ Jan 10, 2023
7e58954
Merge branch 'CeresDB:main' into feature_ceresdb_doc
MichaelLeeHZ Jan 10, 2023
80eafc8
rename doc of table partitioning
MichaelLeeHZ Jan 10, 2023
2ab37ff
Update docs/guides/src/operation/observability.md
MichaelLeeHZ Jan 10, 2023
ec314e7
Merge branch 'feature_ceresdb_doc' of github.com:MachaelLee/ceresdb i…
MichaelLeeHZ Jan 10, 2023
c890d33
rename headline
MichaelLeeHZ Jan 10, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions docs/guides/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

# User Guide

- [Data Model](model/README.md)
- [Data Types](model/data_types.md)
- [Special Columns](model/special_columns.md)
- [SQL Syntax](sql/README.md)
- [Data Model](sql/model/README.md)
- [Data Types](sql/model/data_types.md)
- [Special Columns](sql/model/special_columns.md)
- [Identifier](sql/identifier.md)
- [Data Definition Statements](sql/ddl/README.md)
- [CREATE TABLE](sql/ddl/create_table.md)
Expand All @@ -19,18 +19,24 @@
- [INSERT](sql/dml/insert.md)
- [SELECT](sql/dml/select.md)
- [Utility Statements](sql/utility.md)
- [Analytic Engine](analytic_engine/README.md)
- [Options](analytic_engine/options.md)
- [Engine Options](sql/engine_options.md)

- [Deployment](deploy/README.md)
- [Supported Platform](deploy/platform.md)
- [Static Routing](deploy/static_routing.md)
- [Dynamic Routing](deploy/dynamic_routing.md)

- [Develop Kits](sdk.md)
- [Protocol](protocol.md)
- [Java SDK](sdk/java.md)
- [Go SDK](sdk/go.md)
- [Python SDK](sdk/python.md)
- [Rust SDK](sdk/rust.md)

- [Operation](operation/README.md)
- [Table](operation/table.md)
- [System Table](operation/system_table.md)
- [Block List](operation/block_list.md)
- [Observability](operation/observability.md)

# Dev Guide
- [Supported Platform](dev/platform.md)
Expand All @@ -41,7 +47,8 @@

# Technical and Design
- [Architecture](architecture.md)
- [Storage](storage.md)
- [Query](query.md)
- [Wal](wal.md)
- [Table Partitioning](table_partitioning.md)

-----

- [Trouble Shooting](trouble_shooting.md)
2 changes: 1 addition & 1 deletion docs/guides/src/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ The basic design idea of CeresDB is to adopt a hybrid storage format and the cor

# How does CeresDB work?
- See [Quick Start](quick_start.md) to learn about how to get started
- For data model of CeresDB, see [Data Model](model)
- For data model of CeresDB, see [Data Model](sql/model)
- For the supported SQL data types, operators, and commands, please navigate to [SQL reference](sql)
1 change: 0 additions & 1 deletion docs/guides/src/analytic_engine/README.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/guides/src/operation/README-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 运维手册

本章主要介绍CeresDB系统相关的运维操作,包括集群安装,数据库表操作,容错,灾备,数据导入导出等。
6 changes: 6 additions & 0 deletions docs/guides/src/operation/observability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Observability

CeresDB is observable with Prometheus and Grafana.



1 change: 1 addition & 0 deletions docs/guides/src/query.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Query
2 changes: 1 addition & 1 deletion docs/guides/src/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ See [sdk](./sdk.md)
## Next Step

Congrats, you have finished this tutorial. For more information about CeresDB, see the following:
- [Data Model](./model)
- [Data Model](sql/model)
- [Analytic Engine](./analytic_engine)
4 changes: 4 additions & 0 deletions docs/guides/src/sdk/go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Go



5 changes: 5 additions & 0 deletions docs/guides/src/sdk/java.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Java




5 changes: 5 additions & 0 deletions docs/guides/src/sdk/python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Python




5 changes: 5 additions & 0 deletions docs/guides/src/sdk/rust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Rust




4 changes: 2 additions & 2 deletions docs/guides/src/sql/ddl/create_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Add `IF NOT EXIST` to tell CeresDB to ignore errors if the table name already ex

## Define Column

A column's definition should at least contains the name and type parts. All supported types are listed [here](../../model/data_types.md).
A column's definition should at least contains the name and type parts. All supported types are listed [here](../model/data_types.md).

Column is default be nullable. i.e. `NULL` keyword is implied. Adding `NOT NULL` constrains to make it required.
```sql
Expand All @@ -39,7 +39,7 @@ a_nullable int NULL
b_not_null NOT NULL
```

A column can be marked as [special column](../../model/special_columns.md) with related keyword.
A column can be marked as [special column](../model/special_columns.md) with related keyword.

## Engine

Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions docs/guides/src/storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Storage
1 change: 1 addition & 0 deletions docs/guides/src/table_partitioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Table Partitioning
1 change: 1 addition & 0 deletions docs/guides/src/wal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Wal