docs: update getting started

Author: crwen

.github/workflows/doc.yml

@@ -21,6 +21,7 @@ jobs:
           cd guide
           curl -L https://github.com/rust-lang/mdBook/releases/download/v0.4.28/mdbook-v0.4.28-x86_64-unknown-linux-gnu.tar.gz | tar xzf -
           echo $PWD >> $GITHUB_PATH
+          cargo install mdbook-toc
           ./mdbook build
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@v4

guide/src/SUMMARY.md

@@ -2,7 +2,7 @@
 
 [Introduction](./introduction.md)
 
-- [Getting started](./start.md)
+- [Getting Started](./start.md)
 - [Usage](./usage/index.md)
   - [Tonbo](./usage/tonbo.md)
   - [Python Binding](./usage/python.md)
@@ -18,5 +18,6 @@
   - [Building](./contribution/build.md)
   - [Testing](./contribution/testing.md)
 - [TonboLite](./tonbolite/index.md)
+  - [Getting Started](./tonbolite/start.md)
   - [Building](./tonbolite/build.md)
   - [Usage](./tonbolite/usage.md)

guide/src/start.md

@@ -138,6 +138,58 @@ while let Some(entry) = scan.next().await.transpose().unwrap() {
 }
 ```
 
+### Persistence
+As Tonbo uses LSM(Log-Structured-Merge Tree) as the underlying data structure, some data are in the memory(mem). If you want to persist these data, you can use the `flush` method.
+
+If WAL is enabled, the data will be persisted to disk automatically. But as tonbo has buffer for WAL by default, you need to call `flush_wal` method if you want to ensure that all the data will be recovered. If you don not want to use buffer for WAL, you can disable it by setting `wal_buffer_size` to 0.
+
+```rust
+let options = DbOption::new(
+    Path::from_filesystem_path("./db_path/users").unwrap(),
+    &UserSchema,
+).wal_buffer_size(0);
+```
+
+If you don't want to use WAL, you can disable it by setting the `DbOption::disable_wal`. But please ensure that losing data is acceptable for you.
+```rust
+let options = DbOption::new(
+    Path::from_filesystem_path("./db_path/users").unwrap(),
+    &UserSchema,
+).disable_wal(true);
+```
+
+> **Note**: If you disable WAL, there is nothing to do with `flush_wal`. You need to call `flush` method to persist the memory data.
+>
+> If you enable WAL and set `wal_buffer_size` to 0, you do not need to call `flush_wal` method, since WAL will be flushed to disk before writing.
+
+### Using in S3
+
+If you want to use Tonbo in S3, you can configure `DbOption` to specify which part of the data to store in S3 and which part to store in local disk. Here is an example:
+
+```rust
+let s3_option = FsOptions::S3 {
+    bucket: "wasm-data".to_string(),
+    credential: Some(AwsCredential {
+        key_id: "key_id".to_string(),
+        secret_key: "secret_key".to_string(),
+        token: None,
+    }),
+    endpoint: None,
+    sign_payload: None,
+    checksum: None,
+    region: Some("region".to_string()),
+};
+let options = DbOption::new(
+    Path::from_filesystem_path("./db_path/users").unwrap(),
+    &UserSchema,
+).level_path(2, "l2", s3_option.clone())
+).level_path(3, "l3", s3_option);
+```
+
+In this example, the data of level 2 and level 3 will be stored in S3 and the rest of the data will be stored in local disk.
+
+For more configuration options, please refer to the [Configuration](./usage/conf.md) section.
+
 ## What next?
 - To learn more about tonbo in Rust or in WASM, you can refer to [Tonbo API](./usage/tonbo.md)
 - To use tonbo in python, you can refer to [Python API](./usage/python.md)

guide/src/tonbolite/start.md

@@ -0,0 +1,3 @@
+# Getting Started
+
+TODO

guide/src/usage/tonbo.md

@@ -183,7 +183,7 @@ Transactions support easily reading the state of keys that are currently batched
 
 You can use `get` method to get a record by key, and `get` method will return a `UserRef` instance. This `UserRef` instance is a struct that tonbo generates for you in the compile time. All fields except primary key are `Option` type, because you may not have set them when you create the record. You can also pass a `Projection` to specify which fields you want to get. `Projection::All` will get all fields, `Projection::Parts(Vec<&str>)` will get only primary key, `email` and `bytes` fields(other fields will be `None`).
 
-You can use `scan` method to scan all records that in the specified range. `scan` method will return a `Scan` instance. You can use `taken` method to get a `Stream` instance and iterate all records that satisfied. Tonbo also supports pushing down filters and projections. You can use `Scan::projection(vec!["id", "email"])` to specify which fields you want to get and use `Scan::limit(10)` to limit the number of records you want to get.
+You can use `scan` method to scan all records that in the specified range. `scan` method will return a `Scan` instance. You can use `take` method to get a `Stream` instance and iterate all records that satisfied. Tonbo also supports pushing down filters and projections. You can use `Scan::projection(vec!["id", "email"])` to specify which fields you want to get and use `Scan::limit(10)` to limit the number of records you want to get.
 
 ```rust
 let txn = db.transaction().await;