feat: configurable caching for postgres with support for tracing #5082
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
CodSpeed Performance ReportMerging #5082 will not alter performanceComparing Summary
|
jacek-prisma
changed the title
jkomyno
reviewed
Dec 12, 2024
Comment on lines
+137
to
154
| QuaintManager::Postgres { | ||
| url, | ||
| tls_manager, | ||
| is_tracing_enabled: false, | ||
| } => { | ||
| use crate::connector::PostgreSqlWithDefaultCache; | ||
| Ok(Box::new(PostgreSqlWithDefaultCache::new(url.clone(), tls_manager).await?) as Self::Connection) | ||
| } | ||
|
|
||
| #[cfg(feature = "postgresql-native")] | ||
| QuaintManager::Postgres { | ||
| url, | ||
| tls_manager, | ||
| is_tracing_enabled: true, | ||
| } => { | ||
| use crate::connector::PostgreSqlWithTracingCache; | ||
| Ok(Box::new(PostgreSqlWithTracingCache::new(url.clone(), tls_manager).await?) as Self::Connection) | ||
| } |
There was a problem hiding this comment.
Summary:
- when
is_tracing_enabled, we use the tracing cache (crate::connector::PostgreSqlWithTracingCache) - when
!is_tracing_enabled, we use the default cache (crate::connector::PostgreSqlWithDefaultCache)
jkomyno
reviewed
Dec 12, 2024
| #[tokio::test] | ||
| async fn tracing_lru_cache_reuses_queries_within_capacity() { | ||
| run_with_client(|client| async move { | ||
| let cache = TracingLruCache::with_capacity(1); |
There was a problem hiding this comment.
Let's expand this test case with a higher capacity, e.g., 3.
jkomyno
reviewed
Dec 12, 2024
| #[tokio::test] | ||
| async fn prepared_statement_lru_cache_reuses_statements_within_capacity() { | ||
| run_with_client(|client| async move { | ||
| let cache = PreparedStatementLruCache::with_capacity(1); |
There was a problem hiding this comment.
Let's expand this test case with a higher capacity, e.g., 3.
jkomyno
reviewed
Dec 12, 2024
| #[tokio::test] | ||
| async fn prepared_statement_lru_cache_reuses_queries_within_capacity() { | ||
| run_with_client(|client| async move { | ||
| let cache = PreparedStatementLruCache::with_capacity(1); |
There was a problem hiding this comment.
Let's expand this test case with a higher capacity, e.g., 3.
jkomyno
reviewed
Dec 12, 2024
jkomyno
reviewed
Dec 12, 2024
jkomyno
reviewed
Dec 12, 2024
| match self.cache.get(sql, types).await { | ||
| Some(statement) => Ok(statement), | ||
| None => { | ||
| let stmt = client.prepare_typed(sql, types).await?; |
There was a problem hiding this comment.
Ah, here's why we need Result in the function signature's return type
jkomyno
reviewed
Dec 12, 2024
Comment on lines
+16
to
+30
| /// Types that can be used as a cache for prepared queries and statements. | ||
| #[async_trait] | ||
| pub trait QueryCache: From<CacheSettings> + Send + Sync { | ||
| /// The type that is returned when a prepared query is requested from the cache. | ||
| type Query<'a>: PreparedQuery; | ||
|
|
||
| /// Retrieve a prepared query. | ||
| async fn get_query<'a>(&self, client: &Client, sql: &'a str, types: &[Type]) -> Result<Self::Query<'a>, Error>; | ||
|
|
||
| /// Retrieve a prepared statement. | ||
| /// | ||
| /// This is useful in scenarios that require direct access to a prepared statement, | ||
| /// e.g. describing a query. | ||
| async fn get_statement(&self, client: &Client, sql: &str, types: &[Type]) -> Result<Statement, Error>; | ||
| } |
There was a problem hiding this comment.
Yes! This is so much better than having two separate caches.
aqrln
reviewed
Dec 13, 2024
aqrln
reviewed
Dec 13, 2024
aqrln
approved these changes
Dec 13, 2024
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.
This PR fixes https://github.com/prisma/team-orm/issues/1331.