[docs] Add documentation for cache configuration properties #24623
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
minhancao
requested review from
steveburnett,
elharo and
a team
as code owners
prestodb-ci
requested review from
a team and
anandamideShakyan
and removed request for
a team
minhancao
force-pushed
the
cache_configs_doc_prestissimo
branch
from
2427fdf to
3d22475
Compare
steveburnett
requested changes
Feb 25, 2025
| are supported: ns, us, ms, s, m, h, d. | ||
|
|
||
| ``cache.velox.ttl-check-interval`` | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
There was a problem hiding this comment.
Suggested change
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| * **Type:** ``string`` | ||
| * **Default value:** ``0s`` | ||
|
|
||
| The interval for persisting in-memory cache to SSD. Setting this config |
There was a problem hiding this comment.
Suggested change
| The interval for persisting in-memory cache to SSD. Setting this config | |
| The interval for persisting in-memory cache to SSD. Set this |
| * **Default value:** ``0s`` | ||
|
|
||
| The interval for persisting in-memory cache to SSD. Setting this config | ||
| to a non-zero value will activate periodic cache persistence. |
There was a problem hiding this comment.
Suggested change
| to a non-zero value will activate periodic cache persistence. | |
| to a non-zero value to activate periodic cache persistence. |
| * **Type:** ``integer`` | ||
| * **Default value:** ``0`` | ||
|
|
||
| The size of the SSD. |
There was a problem hiding this comment.
Suggest mentioning the units for this: bytes, Mb, Gb?
| * **Type:** ``string`` | ||
| * **Default value:** ``/mnt/flash/async_cache.`` | ||
|
|
||
| The directory that is mounted onto SSD. |
There was a problem hiding this comment.
Suggested change
| The directory that is mounted onto SSD. | |
| The path of the directory that is mounted in the SSD. |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| * **Type:** ``bool`` | ||
| * **Default value:** ``false`` | ||
| When enabled, a CRC-based checksum is calculated for each cache entry written to SSD. |
There was a problem hiding this comment.
Suggested change
| When enabled, a CRC-based checksum is calculated for each cache entry written to SSD. | |
| When enabled, a CRC-based checksum is calculated for each cache entry written to SSD. |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| * **Type:** ``bool`` | ||
| * **Default value:** ``false`` | ||
| When enabled, the checksum is recalculated and verified against the stored value when |
There was a problem hiding this comment.
Suggested change
| When enabled, the checksum is recalculated and verified against the stored value when | |
| When enabled, the checksum is recalculated and verified against the stored value when |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| * **Type:** ``bool`` | ||
| * **Default value:** ``false`` | ||
| Enable TTL for AsyncDataCache and SSD cache. |
There was a problem hiding this comment.
Suggested change
| Enable TTL for AsyncDataCache and SSD cache. | |
| Enable TTL for AsyncDataCache and SSD cache. |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| * **Type:** ``string`` | ||
| * **Default value:** ``2d`` | ||
| TTL duration for AsyncDataCache and SSD cache entries. The following time units |
There was a problem hiding this comment.
Suggested change
| TTL duration for AsyncDataCache and SSD cache entries. The following time units | |
| TTL duration for AsyncDataCache and SSD cache entries. The following time units |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| * **Type:** ``string`` | ||
| * **Default value:** ``1h`` | ||
| The periodic duration to apply cache TTL and evict AsyncDataCache and SSD cache entries. |
There was a problem hiding this comment.
Suggested change
| The periodic duration to apply cache TTL and evict AsyncDataCache and SSD cache entries. | |
| The periodic duration to apply cache TTL and evict AsyncDataCache and SSD cache entries. |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add documentation for cache configuration properties
All of these cache configuration properties are defined here in the codebase:
https://github.com/prestodb/presto/blob/master/presto-native-execution/presto_cpp/main/common/Configs.h#L328
Relates to facebookincubator/velox#11429
Motivation and Context
Impact
Test Plan
Contributor checklist
Release Notes
Please follow release notes guidelines and fill in the release notes below.