From 69d9a2845f6328ca2c2d4396c11a79243a956506 Mon Sep 17 00:00:00 2001 From: Yingwen Date: Sat, 4 Jan 2025 19:30:25 +0800 Subject: [PATCH] docs: update standalone example (#5290) --- config/config.md | 4 ++-- config/standalone.example.toml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/config/config.md b/config/config.md index 07301b79a40b..78f33385d4f6 100644 --- a/config/config.md +++ b/config/config.md @@ -94,7 +94,7 @@ | `storage` | -- | -- | The data storage options. | | `storage.data_home` | String | `/tmp/greptimedb/` | The working home directory. | | `storage.type` | String | `File` | The storage type used to store the data.
- `File`: the data is stored in the local file system.
- `S3`: the data is stored in the S3 object storage.
- `Gcs`: the data is stored in the Google Cloud Storage.
- `Azblob`: the data is stored in the Azure Blob Storage.
- `Oss`: the data is stored in the Aliyun OSS. | -| `storage.cache_path` | String | Unset | Read cache configuration for object storage such as 'S3' etc, it's configured by default when using object storage. It is recommended to configure it when using object storage for better performance.
A local file directory, defaults to `{data_home}/object_cache/read`. An empty string means disabling. | +| `storage.cache_path` | String | Unset | Read cache configuration for object storage such as 'S3' etc, it's configured by default when using object storage. It is recommended to configure it when using object storage for better performance.
A local file directory, defaults to `{data_home}`. An empty string means disabling. | | `storage.cache_capacity` | String | Unset | The local file cache capacity in bytes. If your disk space is sufficient, it is recommended to set it larger. | | `storage.bucket` | String | Unset | The S3 bucket name.
**It's only used when the storage type is `S3`, `Oss` and `Gcs`**. | | `storage.root` | String | Unset | The S3 data will be stored in the specified prefix, for example, `s3://${bucket}/${root}`.
**It's only used when the storage type is `S3`, `Oss` and `Azblob`**. | @@ -133,7 +133,7 @@ | `region_engine.mito.page_cache_size` | String | Auto | Cache size for pages of SST row groups. Setting it to 0 to disable the cache.
If not set, it's default to 1/8 of OS memory. | | `region_engine.mito.selector_result_cache_size` | String | Auto | Cache size for time series selector (e.g. `last_value()`). Setting it to 0 to disable the cache.
If not set, it's default to 1/16 of OS memory with a max limitation of 512MB. | | `region_engine.mito.enable_write_cache` | Bool | `false` | Whether to enable the write cache, it's enabled by default when using object storage. It is recommended to enable it when using object storage for better performance. | -| `region_engine.mito.write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}/object_cache/write`. | +| `region_engine.mito.write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}`. | | `region_engine.mito.write_cache_size` | String | `5GiB` | Capacity for write cache. If your disk space is sufficient, it is recommended to set it larger. | | `region_engine.mito.write_cache_ttl` | String | Unset | TTL for write cache. | | `region_engine.mito.sst_write_buffer_size` | String | `8MB` | Buffer size for SST writing. | diff --git a/config/standalone.example.toml b/config/standalone.example.toml index e1bc4a90b982..bd5b7b073b08 100644 --- a/config/standalone.example.toml +++ b/config/standalone.example.toml @@ -337,7 +337,7 @@ data_home = "/tmp/greptimedb/" type = "File" ## Read cache configuration for object storage such as 'S3' etc, it's configured by default when using object storage. It is recommended to configure it when using object storage for better performance. -## A local file directory, defaults to `{data_home}/object_cache/read`. An empty string means disabling. +## A local file directory, defaults to `{data_home}`. An empty string means disabling. ## @toml2docs:none-default #+ cache_path = "" @@ -521,7 +521,7 @@ auto_flush_interval = "1h" ## Whether to enable the write cache, it's enabled by default when using object storage. It is recommended to enable it when using object storage for better performance. enable_write_cache = false -## File system path for write cache, defaults to `{data_home}/object_cache/write`. +## File system path for write cache, defaults to `{data_home}`. write_cache_path = "" ## Capacity for write cache. If your disk space is sufficient, it is recommended to set it larger.