Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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 velox/docs/develop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ This guide is intended for Velox contributors and developers of Velox-based appl
develop/TpchBenchmark
develop/window
develop/dynamic-loading
develop/cache
39 changes: 39 additions & 0 deletions velox/docs/develop/cache.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
=====================================
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm now doubting the need for this PR. Do we need this in addition to what we have in the PrestoC++ doc?
This content looks more like PrestoC++ documentation content with the references to the Velox doc.

All the content here sounds more like at the PrestoC++ level rather than Velox. The Velox documentation would rather go into detail as to how it works rather than talk about the operationalization and some vague statements.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@czentgr I agree, I will close this PR since the cache configs PR already was merged for Prestissimo.

AsyncDataCache (In Memory Data Cache)
=====================================

Background
----------
Velox provides a transparent data cache (AsyncDataCache) to accelerate table scans operators through hot data reuse and prefetch algorithms.
This data cache is integrated with the memory system to achieve dynamic memory sharing between the data cache and query memory.
When a query fails to allocate memory, Velox retries the allocation by shrinking the data cache.
Therefore, the data cache size is automatically adjusted in response to the query memory usage change.
See `Memory Management - Velox Documentation <https://facebookincubator.github.io/velox/develop/memory.html>`_
for more information about Velox's data cache.

Configuration Properties
------------------------
See `Configuration Properties
<https://github.com/prestodb/presto/blob/master/presto-docs/src/main/sphinx/presto_cpp/properties.rst#cache-properties>`_
for AsyncDataCache related configuration properties.

=========
SSD Cache
=========

Background
----------
The in-memory data cache (AsyncDataCache) is configured to use SSD when provided.
The SSD serves as an extension for the AsyncDataCache.
This helps mitigate the number of reads from slower storage.

Configuration Properties
------------------------
See `Configuration Properties
<https://github.com/prestodb/presto/blob/master/presto-docs/src/main/sphinx/presto_cpp/properties.rst#cache-properties>`_
for SSD Cache related configuration properties.

Metrics
-------
There are SSD cache relevant metrics that Velox emits during query execution and runtime.
See `Debugging Metrics <./debugging/metrics.rst>`_ and `Monitoring Metrics <../monitoring/metrics.rst>`_ for more details.
Loading