Skip to main content

Module cache

Module cache 

Source
Expand description

Cache for the engine.

ModulesΒ§

cache_size πŸ”’
Cache size of different cache value.
file_cache πŸ”’
A cache for files.
index πŸ”’
manifest_cache πŸ”’
A cache for manifest files.
write_cache πŸ”’
A write-through cache for remote object stores.

StructsΒ§

CacheManager
Manages cached data for the engine.
CacheManagerBuilder
Builder to construct a CacheManager.
CachedSstMeta πŸ”’
Cached SST metadata combines the parquet footer with the decoded region metadata.
CompactSstMeta πŸ”’
Compact, authoritative form of one SST’s metadata.
PageFragmentGroupKey πŸ”’
PageFragmentKey
Cache key for one byte fragment in an SST row group.
PageRangeCache
Byte-fragment cache for Parquet row-group reads.
PageRangeLookup
Result of looking up request ranges in the page range cache.
PageRangePart
One cached byte fragment that overlaps a requested range.
PrefilterKey πŸ”’
Key for a cached prefilter result.
PrefilterRowSelector πŸ”’
PreparedSstMeta πŸ”’
Both forms produced by decoding metadata after a cache miss.
RangeResultMemoryLimiter πŸ”’
SelectorResultKey
Cache key for time series row selector result.
SelectorResultValue
Cached result for time series row selector.
SstMetaKey πŸ”’
Cache key (region id, file id) for SST meta.

EnumsΒ§

CacheStrategy
Cache strategies that may only enable a subset of caches.
SelectorResult
Result stored in the selector result cache.
SstMetaPreparation πŸ”’
Result of decoding SST metadata and attempting to encode its compact cache entry.

ConstantsΒ§

FILE_TYPE πŸ”’
Metrics type key for files on the local store.
INDEX_TYPE πŸ”’
Metrics type key for index files (puffin) on the local store.
PAGE_TYPE πŸ”’
Metrics type key for pages.
PREFILTER_RESULT_TYPE πŸ”’
Metrics type key for prefilter result cache.
RANGE_RESULT_CONCAT_MEMORY_LIMIT πŸ”’
RANGE_RESULT_CONCAT_MEMORY_PERMIT πŸ”’
RANGE_RESULT_TYPE πŸ”’
Metrics type key for range scan result cache.
SELECTOR_RESULT_TYPE πŸ”’
Metrics type key for selector result cache.
SST_META_DECODED_TYPE πŸ”’
Metrics type key for the optional decoded SST metadata acceleration tier.
SST_META_TYPE πŸ”’
Metrics type key for sst meta.
VECTOR_TYPE πŸ”’
Metrics type key for vector.

FunctionsΒ§

decode_sst_meta πŸ”’
Decodes SST metadata without preparing a compact cache entry.
decoded_meta_cache_weight πŸ”’
encode_compact_sst_meta πŸ”’
finish_sst_meta_preparation πŸ”’
infer_loaded_page_index_policy πŸ”’
meta_cache_weight πŸ”’
new_prefilter_result_cache πŸ”’
page_cache_weight πŸ”’
prefilter_result_cache_weight πŸ”’
prepare_sst_meta πŸ”’
Decodes SST metadata and attempts to encode both cache representations on the blocking runtime.
prepare_sst_meta_sync πŸ”’
Synchronously prepares SST metadata. Callers must run this on a blocking runtime.
range_result_cache_weight πŸ”’
removal_cause_str πŸ”’
satisfies_page_index_policy πŸ”’
selector_result_cache_hit
Increases selector cache hit metrics.
selector_result_cache_miss
Increases selector cache miss metrics.
selector_result_cache_weight πŸ”’
strip_column_indexes πŸ”’
strip_region_metadata_from_parquet πŸ”’
update_hit_miss πŸ”’
Updates cache hit/miss metrics.
vector_cache_weight πŸ”’

Type AliasesΒ§

CacheManagerRef
PageFragmentIndex πŸ”’
PageFragmentRangeIndex πŸ”’
PrefilterResultCache πŸ”’
RangeResultCache πŸ”’
Maps partition-range scan key to cached flat batches.
SelectorResultCache πŸ”’
Maps (file id, row group id, time series row selector) to SelectorResultValue.
SstDecodedMetaCache πŸ”’
Maps (region id, file id) to decoded SST metadata retained as an acceleration tier.
SstMetaCache πŸ”’
Maps (region id, file id) to fused SST metadata.
VectorCache πŸ”’
Maps [Value] to a vector that holds this value repeatedly.