-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[core] Share JDBC connection pool across catalog instances in same JVM #8323
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
Open
nickdelnano
wants to merge
4
commits into
apache:master
Choose a base branch
from
nickdelnano:nickdelnano/jdbc-cached-client-pool
base: master
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.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c336d1b
[core] Share JDBC connection pool across catalog instances in same JVM
nickdelnano 762ba6f
[core] Add tests for CachedJdbcClientPool
nickdelnano a5731b8
[core] Fix CachedJdbcClientPool: replace Caffeine with ConcurrentHashMap
nickdelnano 54a23e4
[common] Fix connection leak when ClientPool.close() races with run()
nickdelnano 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
118 changes: 118 additions & 0 deletions
118
paimon-core/src/main/java/org/apache/paimon/jdbc/CachedJdbcClientPool.java
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,118 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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. | ||
| */ | ||
|
|
||
| package org.apache.paimon.jdbc; | ||
|
|
||
| import org.apache.paimon.annotation.VisibleForTesting; | ||
| import org.apache.paimon.options.Options; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.concurrent.ConcurrentMap; | ||
|
|
||
| import static org.apache.paimon.options.CatalogOptions.CLIENT_POOL_SIZE; | ||
| import static org.apache.paimon.options.CatalogOptions.URI; | ||
|
|
||
| /** | ||
| * A cache that shares {@link JdbcClientPool} instances across multiple catalog instances in the | ||
| * same JVM. This prevents each Flink operator from creating its own connection pool when using the | ||
| * JDBC catalog. | ||
| * | ||
| * <p>The cache is keyed by JDBC URI and catalog key. Pools live for the lifetime of the JVM and are | ||
| * closed via a shutdown hook. | ||
| */ | ||
| public class CachedJdbcClientPool { | ||
|
|
||
| private static final ConcurrentMap<Key, JdbcClientPool> CLIENT_POOLS = | ||
| new ConcurrentHashMap<>(); | ||
|
|
||
| static { | ||
| Runtime.getRuntime() | ||
| .addShutdownHook( | ||
| new Thread( | ||
| () -> { | ||
| for (JdbcClientPool pool : CLIENT_POOLS.values()) { | ||
| pool.close(); | ||
| } | ||
| CLIENT_POOLS.clear(); | ||
| }, | ||
| "jdbc-client-pool-shutdown")); | ||
| } | ||
|
|
||
| private final Key key; | ||
| private final int poolSize; | ||
| private final String dbUrl; | ||
| private final Map<String, String> props; | ||
|
|
||
| public CachedJdbcClientPool(Options options, Map<String, String> props) { | ||
| this.dbUrl = options.get(URI); | ||
| this.poolSize = options.get(CLIENT_POOL_SIZE); | ||
| this.props = props; | ||
| this.key = Key.of(dbUrl, options.get(JdbcCatalogOptions.CATALOG_KEY)); | ||
| } | ||
|
|
||
| /** Returns the shared {@link JdbcClientPool} for this cache key, creating one if needed. */ | ||
| public JdbcClientPool get() { | ||
| return CLIENT_POOLS.computeIfAbsent(key, k -> new JdbcClientPool(poolSize, dbUrl, props)); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static ConcurrentMap<Key, JdbcClientPool> clientPools() { | ||
| return CLIENT_POOLS; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| static void resetCache() { | ||
| for (JdbcClientPool pool : CLIENT_POOLS.values()) { | ||
| pool.close(); | ||
| } | ||
| CLIENT_POOLS.clear(); | ||
| } | ||
|
|
||
| static class Key { | ||
| private final String uri; | ||
| private final String catalogKey; | ||
|
|
||
| private Key(String uri, String catalogKey) { | ||
| this.uri = uri; | ||
| this.catalogKey = catalogKey; | ||
| } | ||
|
|
||
| static Key of(String uri, String catalogKey) { | ||
| return new Key(uri, catalogKey); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| Key that = (Key) o; | ||
| return Objects.equals(uri, that.uri) && Objects.equals(catalogKey, that.catalogKey); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(uri, catalogKey); | ||
| } | ||
| } | ||
| } | ||
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
131 changes: 131 additions & 0 deletions
131
paimon-core/src/test/java/org/apache/paimon/jdbc/CachedJdbcClientPoolTest.java
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,131 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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. | ||
| */ | ||
|
|
||
| package org.apache.paimon.jdbc; | ||
|
|
||
| import org.apache.paimon.options.CatalogOptions; | ||
| import org.apache.paimon.options.Options; | ||
|
|
||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.sql.SQLException; | ||
| import java.util.UUID; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** Tests for {@link CachedJdbcClientPool}. */ | ||
| public class CachedJdbcClientPoolTest { | ||
|
|
||
| @AfterEach | ||
| void tearDown() { | ||
| CachedJdbcClientPool.resetCache(); | ||
| } | ||
|
|
||
| @Test | ||
| void testSameKeyReturnsSamePool() { | ||
| String uri = sqliteUri(); | ||
| Options options = createOptions(uri, "my-catalog"); | ||
|
|
||
| CachedJdbcClientPool cache1 = new CachedJdbcClientPool(options, options.toMap()); | ||
| CachedJdbcClientPool cache2 = new CachedJdbcClientPool(options, options.toMap()); | ||
|
|
||
| assertThat(cache1.get()).isSameAs(cache2.get()); | ||
| } | ||
|
|
||
| @Test | ||
| void testDifferentUriReturnsDifferentPool() { | ||
| Options options1 = createOptions(sqliteUri(), "my-catalog"); | ||
| Options options2 = createOptions(sqliteUri(), "my-catalog"); | ||
|
|
||
| CachedJdbcClientPool cache1 = new CachedJdbcClientPool(options1, options1.toMap()); | ||
| CachedJdbcClientPool cache2 = new CachedJdbcClientPool(options2, options2.toMap()); | ||
|
|
||
| assertThat(cache1.get()).isNotSameAs(cache2.get()); | ||
| } | ||
|
|
||
| @Test | ||
| void testDifferentCatalogKeyReturnsDifferentPool() { | ||
| String uri = sqliteUri(); | ||
| Options options1 = createOptions(uri, "catalog-a"); | ||
| Options options2 = createOptions(uri, "catalog-b"); | ||
|
|
||
| CachedJdbcClientPool cache1 = new CachedJdbcClientPool(options1, options1.toMap()); | ||
| CachedJdbcClientPool cache2 = new CachedJdbcClientPool(options2, options2.toMap()); | ||
|
|
||
| assertThat(cache1.get()).isNotSameAs(cache2.get()); | ||
| } | ||
|
|
||
| @Test | ||
| void testPoolIsUsable() throws SQLException, InterruptedException { | ||
| Options options = createOptions(sqliteUri(), "test-catalog"); | ||
| CachedJdbcClientPool cache = new CachedJdbcClientPool(options, options.toMap()); | ||
|
|
||
| JdbcClientPool pool = cache.get(); | ||
| Boolean result = pool.run(conn -> !conn.isClosed()); | ||
|
|
||
| assertThat(result).isTrue(); | ||
| } | ||
|
|
||
| @Test | ||
| void testMultipleCatalogInstancesSharePool() { | ||
| String uri = sqliteUri(); | ||
| Options options = createOptions(uri, "shared-catalog"); | ||
|
|
||
| JdbcCatalog catalog1 = | ||
| new JdbcCatalog( | ||
| new org.apache.paimon.fs.local.LocalFileIO(), | ||
| "shared-catalog", | ||
| org.apache.paimon.catalog.CatalogContext.create(options), | ||
| "/tmp/warehouse1"); | ||
| JdbcCatalog catalog2 = | ||
| new JdbcCatalog( | ||
| new org.apache.paimon.fs.local.LocalFileIO(), | ||
| "shared-catalog", | ||
| org.apache.paimon.catalog.CatalogContext.create(options), | ||
| "/tmp/warehouse2"); | ||
|
|
||
| assertThat(catalog1.getConnections()).isSameAs(catalog2.getConnections()); | ||
| } | ||
|
|
||
| @Test | ||
| void testResetCacheClearsAllPools() { | ||
| Options options = createOptions(sqliteUri(), "test-catalog"); | ||
| CachedJdbcClientPool cache = new CachedJdbcClientPool(options, options.toMap()); | ||
| JdbcClientPool pool = cache.get(); | ||
|
|
||
| assertThat(pool).isNotNull(); | ||
| assertThat(CachedJdbcClientPool.clientPools()).isNotEmpty(); | ||
|
|
||
| CachedJdbcClientPool.resetCache(); | ||
|
|
||
| assertThat(CachedJdbcClientPool.clientPools()).isEmpty(); | ||
| } | ||
|
|
||
| private static Options createOptions(String uri, String catalogKey) { | ||
| Options options = new Options(); | ||
| options.set(CatalogOptions.URI, uri); | ||
| options.set(JdbcCatalogOptions.CATALOG_KEY, catalogKey); | ||
| options.set(CatalogOptions.CLIENT_POOL_SIZE, 2); | ||
| return options; | ||
| } | ||
|
|
||
| private static String sqliteUri() { | ||
| return "jdbc:sqlite:file::memory:?ic" + UUID.randomUUID().toString().replace("-", ""); | ||
| } | ||
| } |
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.
This key does not include the JDBC connection properties used by
JdbcClientPool(propsis later passed toJdbcUtils.extractJdbcConfiguration, includingjdbc.user/jdbc.password). If two catalogs in the same JVM use the same URI andcatalog-keybut different credentials, the second catalog will reuse the pool created by the first one and run with the wrong database user. Please include the effective JDBC connection properties in the cache key (and add a regression test with the same URI/catalog-key but differentjdbc.userorjdbc.password).