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.

Sign up for GitHub

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

chore: add documentation for custom storage #712

Merged
merged 1 commit into from
Dec 15, 2023
Merged

chore: add documentation for custom storage #712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/v0.4/en/reference/sql/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ 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:

Expand Down
16 changes: 16 additions & 0 deletions docs/v0.4/en/user-guide/operations/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,22 @@ access_key_id = "<access key id>"
secret_access_key = "<secret access key>"
```

#### Custom storages

`[[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:
Expand Down
Loading