-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(bigframes): Experimental local sample cache #17587
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.
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
Draft
TrevorBergeron
wants to merge
1
commit into
main
Choose a base branch
from
tbergeron_peek_cache
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from collections import OrderedDict | ||
| import threading | ||
| from typing import Optional | ||
|
|
||
| from bigframes.core import local_data, nodes | ||
|
|
||
|
|
||
| class PeekCache: | ||
| """ | ||
| Thread-safe LRU cache for storing local samples of query relations. | ||
| This enables fast iteration on subsequent compatible operations. | ||
| """ | ||
|
|
||
| def __init__(self, capacity: int = 100): | ||
| self.capacity = capacity | ||
| self._cache: OrderedDict[nodes.BigFrameNode, local_data.ManagedArrowTable] = OrderedDict() | ||
| self._lock = threading.Lock() | ||
|
|
||
| def get(self, key: nodes.BigFrameNode) -> Optional[local_data.ManagedArrowTable]: | ||
| with self._lock: | ||
| if key not in self._cache: | ||
| return None | ||
| # Move to end (most recently used) | ||
| self._cache.move_to_end(key) | ||
| return self._cache[key] | ||
|
|
||
| def put(self, key: nodes.BigFrameNode, value: local_data.ManagedArrowTable) -> None: | ||
| with self._lock: | ||
| if key in self._cache: | ||
| self._cache.move_to_end(key) | ||
| self._cache[key] = value | ||
| if len(self._cache) > self.capacity: | ||
| self._cache.popitem(last=False) | ||
|
|
||
| def clear(self) -> None: | ||
| with self._lock: | ||
| self._cache.clear() | ||
|
|
||
|
|
||
| def substitute_peek_cached_subplans( | ||
| root: nodes.BigFrameNode, | ||
| peek_cache: PeekCache, | ||
| ) -> nodes.BigFrameNode: | ||
| """ | ||
| Recursively replaces subplans in the tree that have a cached local sample | ||
| in the peek cache with a ReadLocalNode, provided that all ancestors | ||
| of the subplan are compatible with running on a sample. | ||
| """ | ||
| # Intermediate nodes that preserve the semantic validity of a sample. | ||
| # WindowOpNode, AggregateNode, OrderByNode, JoinNode, etc. are excluded | ||
| # because evaluating them on a sample breaks semantic contracts. | ||
| _COMPATIBLE_ANCESTOR_CLASSES = ( | ||
| nodes.SelectionNode, | ||
| nodes.ProjectionNode, | ||
| nodes.FilterNode, | ||
| nodes.PromoteOffsetsNode, | ||
| ) | ||
|
|
||
| def traverse(node: nodes.BigFrameNode, ancestors_compatible: bool) -> nodes.BigFrameNode: | ||
| if ancestors_compatible: | ||
| cached_sample = peek_cache.get(node) | ||
| if cached_sample is not None: | ||
| # Replace the node with a ReadLocalNode containing the cached sample | ||
| scan_list = nodes.ScanList( | ||
| tuple(nodes.ScanItem(field.id, field.id.sql) for field in node.fields) | ||
| ) | ||
| session = node.session if node.session is not None else root.session | ||
| return nodes.ReadLocalNode( | ||
| local_data_source=cached_sample, | ||
| scan_list=scan_list, | ||
| session=session, | ||
| ) | ||
|
|
||
| # If we didn't replace, recursively transform children | ||
| is_current_compatible = isinstance(node, _COMPATIBLE_ANCESTOR_CLASSES) | ||
| next_ancestors_compatible = ancestors_compatible and is_current_compatible | ||
|
|
||
| return node.transform_children(lambda child: traverse(child, next_ancestors_compatible)) | ||
|
|
||
| return traverse(root, True) | ||
|
Comment on lines
+56
to
+96
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are two issues in
def substitute_peek_cached_subplans(
root: nodes.BigFrameNode,
peek_cache: PeekCache,
min_rows_required: int,
) -> nodes.BigFrameNode:
"""
Recursively replaces subplans in the tree that have a cached local sample
in the peek cache with a ReadLocalNode, provided that all ancestors
of the subplan are compatible with running on a sample, and the cached
sample contains at least the required number of rows.
"""
# Intermediate nodes that preserve the semantic validity of a sample.
# WindowOpNode, AggregateNode, OrderByNode, JoinNode, etc. are excluded
# because evaluating them on a sample breaks semantic contracts.
_COMPATIBLE_ANCESTOR_CLASSES = (
nodes.SelectionNode,
nodes.ProjectionNode,
nodes.FilterNode,
nodes.PromoteOffsetsNode,
)
def traverse(node: nodes.BigFrameNode, ancestors_compatible: bool) -> nodes.BigFrameNode:
if ancestors_compatible:
cached_sample = peek_cache.get(node)
if cached_sample is not None and cached_sample.num_rows >= min_rows_required:
# Replace the node with a ReadLocalNode containing the cached sample
scan_list = nodes.ScanList(
tuple(nodes.ScanItem(field.id, field.id.name) for field in node.fields)
)
session = node.session if node.session is not None else root.session
return nodes.ReadLocalNode(
local_data_source=cached_sample,
scan_list=scan_list,
session=session,
)
# If we didn't replace, recursively transform children
is_current_compatible = isinstance(node, _COMPATIBLE_ANCESTOR_CLASSES)
next_ancestors_compatible = ancestors_compatible and is_current_compatible
return node.transform_children(lambda child: traverse(child, next_ancestors_compatible))
return traverse(root, True) |
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pass
min_rows_required=execution_spec.peektosubstitute_peek_cached_subplansto ensure we only use the cached sample if it contains enough rows to satisfy the current peek request.