chore: add documentation for custom storage

GreptimeTeam · Dec 13, 2023 · d580dad · d580dad
1 parent ee60e88
commit d580dad
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/v0.3/en/reference/sql/create.md b/docs/v0.3/en/reference/sql/create.md
@@ -87,6 +87,8 @@ Users can add table options by using `WITH`. The valid options contain the follo
 | `ttl`               | The storage time of the table data | String value, such as `'60m'`, `'1h'` for one hour, `'14d'` for 14 days etc. Supported time units are: `s` / `m` / `h` / `d`                        |
 | `regions`           | The region number of the table     | Integer value, such as 1, 5, 10 etc.                                                                                                                |
 | `write_buffer_size` | Memtable size of the table         | String value representing a valid size, such as `32MB`, `128MB`, etc. The default value of this option is `32MB`. Supported units are: `MB` / `GB`. |
+| `storage` | The name of the table storage         | String value, such as `S3`, `Gcs`, etc. |
+
 
 For example, to create a table with the storage data TTL(Time-To-Live) is seven days and region number is 10:
 

diff --git a/docs/v0.3/en/user-guide/operations/configuration.md b/docs/v0.3/en/user-guide/operations/configuration.md
@@ -223,6 +223,22 @@ access_key_id = "<access key id>"
 secret_access_key = "<secret access key>"
 ```
 
+#### Custom storage
+
+`[[storage.providers]]` allows you to create a table with a specified storage:
+
+```toml
+# Allows using multiple storages
+[[storage.providers]]
+type = "S3"
+bucket = "test_greptimedb"
+~
+[[storage.providers]]
+type = "Gcs"
+bucket = "test_greptimedb"
+~
+```
+
 #### Object storage cache
 
 When using S3, OSS or Azure Blob Storage, it's better to enable object storage caching for speedup data querying: