fix: add catalog to cache key when getting tables/views #31910
Conversation
|
Based on your review schedule, I'll hold off on reviewing this PR until it's marked as ready for review. If you'd like me to take a look now, comment
|
betodealmeida
force-pushed
the
fix-cache-key-reflection
branch
from
15a1ff2 to
c3c0123
Compare
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review by Korbit AI
Korbit automatically attempts to detect when you fix issues in new commits.
| Category | Issue | Fix Detected |
|---|---|---|
 |
Cache key not handling None catalog properly ▹ view |
Files scanned
| File Path | Reviewed |
|---|---|
| superset/models/core.py | ✅ |
Explore our documentation to understand the languages and file types we support and the files we ignore.
Need a new review? Comment
/korbit-reviewon this PR and I'll review your latest changes.Korbit Guide: Usage and Customization
Interacting with Korbit
- You can manually ask Korbit to review your PR using the
/korbit-reviewcommand in a comment at the root of your PR.- You can ask Korbit to generate a new PR description using the
/korbit-generate-pr-descriptioncommand in any comment on your PR.- Too many Korbit comments? I can resolve all my comment threads if you use the
/korbit-resolvecommand in any comment on your PR.- Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
- Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.
Customizing Korbit
- Check out our docs on how you can make Korbit work best for you and your team.
- Customize Korbit for your organization through the Korbit Console.
Current Korbit Configuration
General Settings
Setting Value Review Schedule Automatic excluding drafts Max Issue Count 10 Automatic PR Descriptions ❌ Issue Categories
Category Enabled Naming ✅ Database Operations ✅ Documentation ✅ Logging ✅ Error Handling ✅ Systems and Environment ✅ Objects and Data Structures ✅ Readability and Maintainability ✅ Asynchronous Processing ✅ Design Patterns ✅ Third-Party Libraries ✅ Performance ✅ Security ✅ Functionality ✅ Feedback and Support
Note
Korbit Pro is free for open source projects 🎉
Looking to add Korbit to your team? Get started with a free 2 week trial here
| @cache_util.memoized_func( | ||
| key="db:{self.id}:schema:{schema}:table_list", | ||
| key="db:{self.id}:catalog:{catalog}:schema:{schema}:table_list", | ||
| cache=cache_manager.cache, | ||
| ) |
There was a problem hiding this comment.
Cache key not handling None catalog properly 
Tell me more
What is the issue?
The cache key for get_all_table_names_in_schema uses {catalog} even when catalog is None, which could cause cache conflicts for databases not supporting catalogs.
Why this matters
When catalog support is not enabled for a database (allow_multi_catalog=False), passing None as catalog could still create different cache keys, defeating the caching mechanism's purpose and potentially causing unnecessary database queries.
Suggested change ∙ Feature Preview
Modify the cache key to only include catalog when it's not None or when the database supports multi-catalog:
@cache_util.memoized_func(
key=lambda self, catalog, schema:
f"db:{self.id}:" +
(f"catalog:{catalog}:" if catalog and self.allow_multi_catalog else "") +
f"schema:{schema}:table_list",
cache=cache_manager.cache,
)Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.
One thing I want to do is write a CI action that checks if the return value of cached functions has changed, and warns in the PR that the cache needs to be purged. We could also make it check if all arguments are used in the cache key. |
SUMMARY
The cache key for
get_all_table_names_in_schemaandget_all_view_names_in_schemadoesn't include the catalog.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION