-
Notifications
You must be signed in to change notification settings - Fork 3.7k
branch-4.1: [feat](paimon) support jdbc catalog type #61094 #61694
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
Merged
yiguolei
merged 1 commit into
apache:branch-4.1
from
xylaaaaa:auto-pick-61094-branch-4.1
Mar 26, 2026
Merged
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
247 changes: 247 additions & 0 deletions
247
...in/java/org/apache/doris/datasource/property/metastore/PaimonJdbcMetaStoreProperties.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,247 @@ | ||
| // 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.doris.datasource.property.metastore; | ||
|
|
||
| import org.apache.doris.catalog.JdbcResource; | ||
| import org.apache.doris.common.security.authentication.HadoopExecutionAuthenticator; | ||
| import org.apache.doris.datasource.paimon.PaimonExternalCatalog; | ||
| import org.apache.doris.datasource.property.ConnectorProperty; | ||
| import org.apache.doris.datasource.property.storage.HdfsProperties; | ||
| import org.apache.doris.datasource.property.storage.StorageProperties; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.apache.paimon.catalog.Catalog; | ||
| import org.apache.paimon.catalog.CatalogContext; | ||
| import org.apache.paimon.catalog.CatalogFactory; | ||
| import org.apache.paimon.jdbc.JdbcCatalogFactory; | ||
| import org.apache.paimon.options.CatalogOptions; | ||
|
|
||
| import java.net.MalformedURLException; | ||
| import java.net.URL; | ||
| import java.net.URLClassLoader; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
|
|
||
| public class PaimonJdbcMetaStoreProperties extends AbstractPaimonProperties { | ||
| private static final Logger LOG = LogManager.getLogger(PaimonJdbcMetaStoreProperties.class); | ||
| private static final String JDBC_PREFIX = "jdbc."; | ||
| private static final Map<URL, ClassLoader> DRIVER_CLASS_LOADER_CACHE = new ConcurrentHashMap<>(); | ||
| private static final Set<String> REGISTERED_DRIVER_KEYS = ConcurrentHashMap.newKeySet(); | ||
|
|
||
| @ConnectorProperty( | ||
| names = {"uri", "paimon.jdbc.uri"}, | ||
| required = true, | ||
| description = "JDBC connection URI for the Paimon JDBC catalog." | ||
| ) | ||
| private String uri = ""; | ||
|
|
||
| @ConnectorProperty( | ||
| names = {"paimon.jdbc.user", "jdbc.user"}, | ||
| required = false, | ||
| description = "Username for the Paimon JDBC catalog." | ||
| ) | ||
| private String jdbcUser; | ||
|
|
||
| @ConnectorProperty( | ||
| names = {"paimon.jdbc.password", "jdbc.password"}, | ||
| required = false, | ||
| sensitive = true, | ||
| description = "Password for the Paimon JDBC catalog." | ||
| ) | ||
| private String jdbcPassword; | ||
|
|
||
| @ConnectorProperty( | ||
| names = {"paimon.jdbc.driver_url", "jdbc.driver_url"}, | ||
| required = false, | ||
| description = "JDBC driver JAR file path or URL. " | ||
| + "Can be a local file name (will look in $DORIS_HOME/plugins/jdbc_drivers/) " | ||
| + "or a full URL (http://, https://, file://)." | ||
| ) | ||
| private String driverUrl; | ||
|
|
||
| @ConnectorProperty( | ||
| names = {"paimon.jdbc.driver_class", "jdbc.driver_class"}, | ||
| required = false, | ||
| description = "JDBC driver class name. If specified with paimon.jdbc.driver_url, " | ||
| + "the driver will be loaded dynamically." | ||
| ) | ||
| private String driverClass; | ||
|
|
||
| protected PaimonJdbcMetaStoreProperties(Map<String, String> props) { | ||
| super(props); | ||
| } | ||
|
|
||
| @Override | ||
| public String getPaimonCatalogType() { | ||
| return PaimonExternalCatalog.PAIMON_JDBC; | ||
| } | ||
|
|
||
| @Override | ||
| protected void checkRequiredProperties() { | ||
| super.checkRequiredProperties(); | ||
| if (StringUtils.isBlank(warehouse)) { | ||
| throw new IllegalArgumentException("Property warehouse is required."); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Catalog initializeCatalog(String catalogName, List<StorageProperties> storagePropertiesList) { | ||
| buildCatalogOptions(); | ||
| Configuration conf = new Configuration(); | ||
| for (StorageProperties storageProperties : storagePropertiesList) { | ||
| if (storageProperties.getHadoopStorageConfig() != null) { | ||
| conf.addResource(storageProperties.getHadoopStorageConfig()); | ||
| } | ||
| if (storageProperties.getType().equals(StorageProperties.Type.HDFS)) { | ||
| this.executionAuthenticator = new HadoopExecutionAuthenticator(((HdfsProperties) storageProperties) | ||
| .getHadoopAuthenticator()); | ||
| } | ||
| } | ||
| appendUserHadoopConfig(conf); | ||
| if (StringUtils.isNotBlank(driverUrl)) { | ||
| registerJdbcDriver(driverUrl, driverClass); | ||
| LOG.info("Using dynamic JDBC driver for Paimon JDBC catalog from: {}", driverUrl); | ||
| } | ||
| CatalogContext catalogContext = CatalogContext.create(catalogOptions, conf); | ||
| try { | ||
| return this.executionAuthenticator.execute(() -> CatalogFactory.createCatalog(catalogContext)); | ||
| } catch (Exception e) { | ||
| throw new RuntimeException("Failed to create Paimon catalog with JDBC metastore: " + e.getMessage(), e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void appendCustomCatalogOptions() { | ||
| catalogOptions.set(CatalogOptions.URI.key(), uri); | ||
| addIfNotBlank("jdbc.user", jdbcUser); | ||
| addIfNotBlank("jdbc.password", jdbcPassword); | ||
| appendRawJdbcCatalogOptions(); | ||
| } | ||
|
|
||
| @Override | ||
| protected String getMetastoreType() { | ||
| return JdbcCatalogFactory.IDENTIFIER; | ||
| } | ||
|
|
||
| private void addIfNotBlank(String key, String value) { | ||
| if (StringUtils.isNotBlank(value)) { | ||
| catalogOptions.set(key, value); | ||
| } | ||
| } | ||
|
|
||
| private void appendRawJdbcCatalogOptions() { | ||
| origProps.forEach((key, value) -> { | ||
| if (key != null && key.startsWith(JDBC_PREFIX) && !catalogOptions.keySet().contains(key)) { | ||
| catalogOptions.set(key, value); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Register JDBC driver with DriverManager. | ||
| * This is necessary because DriverManager.getConnection() doesn't use Thread.contextClassLoader. | ||
| */ | ||
| private void registerJdbcDriver(String driverUrl, String driverClassName) { | ||
| try { | ||
| if (StringUtils.isBlank(driverClassName)) { | ||
| throw new IllegalArgumentException( | ||
| "jdbc.driver_class or paimon.jdbc.driver_class is required when jdbc.driver_url " | ||
| + "or paimon.jdbc.driver_url is specified"); | ||
| } | ||
|
|
||
| String fullDriverUrl = JdbcResource.getFullDriverUrl(driverUrl); | ||
| URL url = new URL(fullDriverUrl); | ||
| String driverKey = fullDriverUrl + "#" + driverClassName; | ||
| if (!REGISTERED_DRIVER_KEYS.add(driverKey)) { | ||
| LOG.info("JDBC driver already registered for Paimon catalog: {} from {}", | ||
| driverClassName, fullDriverUrl); | ||
| return; | ||
|
Comment on lines
+174
to
+178
|
||
| } | ||
| try { | ||
| ClassLoader classLoader = DRIVER_CLASS_LOADER_CACHE.computeIfAbsent(url, u -> { | ||
| ClassLoader parent = getClass().getClassLoader(); | ||
| return URLClassLoader.newInstance(new URL[] {u}, parent); | ||
| }); | ||
| Class<?> loadedDriverClass = Class.forName(driverClassName, true, classLoader); | ||
| java.sql.Driver driver = (java.sql.Driver) loadedDriverClass.getDeclaredConstructor().newInstance(); | ||
| java.sql.DriverManager.registerDriver(new DriverShim(driver)); | ||
| LOG.info("Successfully registered JDBC driver for Paimon catalog: {} from {}", | ||
| driverClassName, fullDriverUrl); | ||
| } catch (ClassNotFoundException e) { | ||
| REGISTERED_DRIVER_KEYS.remove(driverKey); | ||
| throw new IllegalArgumentException("Failed to load JDBC driver class: " + driverClassName, e); | ||
| } catch (Exception e) { | ||
| REGISTERED_DRIVER_KEYS.remove(driverKey); | ||
| throw new RuntimeException("Failed to register JDBC driver: " + driverClassName, e); | ||
| } | ||
| } catch (MalformedURLException e) { | ||
| throw new IllegalArgumentException("Invalid driver URL: " + driverUrl, e); | ||
| } catch (IllegalArgumentException e) { | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| private static class DriverShim implements java.sql.Driver { | ||
| private final java.sql.Driver delegate; | ||
|
|
||
| DriverShim(java.sql.Driver delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| @Override | ||
| public java.sql.Connection connect(String url, java.util.Properties info) throws java.sql.SQLException { | ||
| return delegate.connect(url, info); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean acceptsURL(String url) throws java.sql.SQLException { | ||
| return delegate.acceptsURL(url); | ||
| } | ||
|
|
||
| @Override | ||
| public java.sql.DriverPropertyInfo[] getPropertyInfo(String url, java.util.Properties info) | ||
| throws java.sql.SQLException { | ||
| return delegate.getPropertyInfo(url, info); | ||
| } | ||
|
|
||
| @Override | ||
| public int getMajorVersion() { | ||
| return delegate.getMajorVersion(); | ||
| } | ||
|
|
||
| @Override | ||
| public int getMinorVersion() { | ||
| return delegate.getMinorVersion(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean jdbcCompliant() { | ||
| return delegate.jdbcCompliant(); | ||
| } | ||
|
|
||
| @Override | ||
| public java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException { | ||
| return delegate.getParentLogger(); | ||
| } | ||
| } | ||
| } | ||
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
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.
The dynamic JDBC driver registration implementation (
registerJdbcDriver/DriverShimand related caches) is very similar to the existing implementation inIcebergJdbcMetaStoreProperties. Keeping two near-identical implementations tends to cause long-term drift and missed fixes in one path. Consider extracting a shared helper for driver URL normalization + classloader caching +DriverManagerregistration and reuse it from both classes.