Skip to content

more consistent handling of JDBC driver name in log message #10692

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.

Sign up for GitHub

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
merged 3 commits into from
Aug 5, 2025
Merged

more consistent handling of JDBC driver name in log message #10692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64d8bca
more consistent handling of JDBC driver name in log message
gavinking Aug 5, 2025
988db7f
add some missing info to log for Hikari and C3P0
gavinking Aug 5, 2025
2498fd6
fix incorrect metadata call
gavinking Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 2 additions & 17 deletions hibernate-agroal/src/main/java/org/hibernate/agroal/internal/AgroalConnectionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@
import static org.hibernate.cfg.AgroalSettings.AGROAL_CONFIG_PREFIX;
import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.toIsolationNiceName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getCatalog;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getDriverName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getFetchSize;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getIsolation;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getSchema;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.hasCatalog;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.hasSchema;
import static org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.allowJdbcMetadataAccess;

/**
* {@link ConnectionProvider} based on Agroal connection pool.
Expand Down Expand Up @@ -79,7 +79,6 @@ public class AgroalConnectionProvider implements ConnectionProvider, Configurabl
@Serial
private static final long serialVersionUID = 1L;
private AgroalDataSource agroalDataSource = null;
private boolean isMetadataAccessAllowed = true;

// --- Configurable

Expand Down Expand Up @@ -107,8 +106,6 @@ private static <T> void copyProperty(Map<String, Object> properties, String key,

@Override
public void configure(Map<String, Object> properties) throws HibernateException {
isMetadataAccessAllowed = allowJdbcMetadataAccess( properties );

ConnectionInfoLogger.INSTANCE.configureConnectionPool( "Agroal" );
try {
final var config = toStringValuedProperties( properties );
Expand Down Expand Up @@ -180,7 +177,7 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
// database metadata is allowed
connectionConfig.connectionProviderClass() != null
? connectionConfig.connectionProviderClass().toString()
: extractDriverNameFromMetadata(),
: getDriverName( connection ),
dialect.getClass(),
dialect.getVersion(),
hasSchema( connection ),
Expand All @@ -206,18 +203,6 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
}
}

private String extractDriverNameFromMetadata() {
if (isMetadataAccessAllowed) {
try ( Connection conn = getConnection() ) {
return conn.getMetaData().getDriverName();
}
catch (SQLException e) {
// Do nothing
}
}
return null;
}

@Override
public boolean isUnwrappableAs(Class<?> unwrapType) {
return ConnectionProvider.class.equals( unwrapType )
Expand Down
4 changes: 3 additions & 1 deletion hibernate-c3p0/src/main/java/org/hibernate/c3p0/internal/C3P0ConnectionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.getConnectionProperties;
import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.toIsolationNiceName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getCatalog;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getDriverName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getFetchSize;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getIsolation;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getSchema;
Expand Down Expand Up @@ -170,13 +171,14 @@ public void configure(Map<String, Object> properties) {
final boolean hasCatalog = hasCatalog( connection );
final String schema = getSchema( connection );
final String catalog = getCatalog( connection );
final String driverName = getDriverName( connection );
if ( isolation == null ) {
isolation = getIsolation( connection );
}
dbInfoProducer = dialect -> new DatabaseConnectionInfoImpl(
C3P0ConnectionProvider.class,
jdbcUrl,
jdbcDriverClass,
driverName,
dialect.getClass(),
dialect.getVersion(),
hasSchema,
Expand Down
11 changes: 10 additions & 1 deletion .../main/java/org/hibernate/engine/jdbc/connections/internal/DatabaseConnectionInfoImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public DatabaseConnectionInfoImpl(Dialect dialect) {

public static boolean hasSchema(Connection connection) {
try {
return connection.getMetaData().supportsSchemasInTableDefinitions();
return connection.getMetaData().supportsSchemasInDataManipulation();
}
catch ( SQLException ignored ) {
return true;
Expand Down Expand Up @@ -173,6 +173,15 @@ public static Integer getIsolation(Connection connection) {
}
}

public static String getDriverName(Connection connection) {
try {
return connection.getMetaData().getDriverName();
}
catch (SQLException e) {
return null;
}
}

@Override
public String getJdbcUrl() {
return jdbcUrl;
Expand Down
17 changes: 8 additions & 9 deletions ...java/org/hibernate/engine/jdbc/connections/internal/DatasourceConnectionProviderImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import javax.sql.DataSource;

import org.hibernate.HibernateException;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.cfg.JdbcSettings;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
Expand Down Expand Up @@ -89,9 +88,9 @@ else if ( DataSource.class.isAssignableFrom( unwrapType ) ) {
}

@Override
public void configure(Map<String, Object> configValues) {
public void configure(Map<String, Object> configuration) {
if ( dataSource == null ) {
final Object dataSourceSetting = configValues.get( DATASOURCE );
final Object dataSourceSetting = configuration.get( DATASOURCE );
if ( dataSourceSetting instanceof DataSource instance ) {
dataSource = instance;
}
Expand All @@ -111,17 +110,17 @@ else if ( dataSourceSetting instanceof String jndiName ) {
throw new ConnectionProviderConfigurationException( "Unable to determine appropriate DataSource to use" );
}

if ( configValues.containsKey( AvailableSettings.AUTOCOMMIT ) ) {
ConnectionInfoLogger.INSTANCE.ignoredSetting( AvailableSettings.AUTOCOMMIT,
if ( configuration.containsKey( JdbcSettings.AUTOCOMMIT ) ) {
ConnectionInfoLogger.INSTANCE.ignoredSetting( JdbcSettings.AUTOCOMMIT,
DatasourceConnectionProviderImpl.class );
}
if ( configValues.containsKey( AvailableSettings.ISOLATION ) ) {
ConnectionInfoLogger.INSTANCE.ignoredSetting( AvailableSettings.ISOLATION,
if ( configuration.containsKey( JdbcSettings.ISOLATION ) ) {
ConnectionInfoLogger.INSTANCE.ignoredSetting( JdbcSettings.ISOLATION,
DatasourceConnectionProviderImpl.class );
}

user = (String) configValues.get( AvailableSettings.USER );
pass = (String) configValues.get( AvailableSettings.PASS );
user = (String) configuration.get( JdbcSettings.USER );
pass = (String) configuration.get( JdbcSettings.PASS );
useCredentials = user != null || pass != null;
available = true;
}
Expand Down
3 changes: 2 additions & 1 deletion ...a/org/hibernate/engine/jdbc/connections/internal/DriverManagerConnectionProviderImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.getConnectionProperties;
import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.toIsolationNiceName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getCatalog;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getDriverName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getFetchSize;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getIsolation;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getSchema;
Expand Down Expand Up @@ -124,7 +125,7 @@ private PooledConnections buildPool(Map<String,Object> configuration, ServiceReg
dbInfo = new DatabaseConnectionInfoImpl(
DriverManagerConnectionProviderImpl.class,
url,
driver == null ? null : driver.getClass().getName(),
getDriverName( connection ),
null,
SimpleDatabaseVersion.ZERO_VERSION,
hasSchema( connection ),
Expand Down
6 changes: 3 additions & 3 deletions ...ore/src/test/java/org/hibernate/orm/test/datasource/TestDataSourceConnectionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ public class TestDataSourceConnectionProvider
final DriverManagerConnectionProviderImpl delegate = new DriverManagerConnectionProviderImpl();

@Override
public void configure(Map<String, Object> configValues) {
delegate.configure(configValues);
public void configure(Map<String, Object> configuration) {
delegate.configure( configuration );
setDataSource( new DataSource() {
PrintWriter logWriter = new PrintWriter( System.out );
@Override
Expand Down Expand Up @@ -74,7 +74,7 @@ public Logger getParentLogger() throws SQLFeatureNotSupportedException {
throw new SQLFeatureNotSupportedException();
}
} );
super.configure( configValues );
super.configure( configuration );
}

@Override
Expand Down
32 changes: 12 additions & 20 deletions ...te-hikaricp/src/main/java/org/hibernate/hikaricp/internal/HikariCPConnectionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@
import com.zaxxer.hikari.HikariDataSource;

import static org.hibernate.engine.jdbc.connections.internal.ConnectionProviderInitiator.toIsolationNiceName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getCatalog;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getDriverName;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getFetchSize;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getIsolation;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.getSchema;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.hasCatalog;
import static org.hibernate.engine.jdbc.connections.internal.DatabaseConnectionInfoImpl.hasSchema;
import static org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator.allowJdbcMetadataAccess;
import static org.hibernate.hikaricp.internal.HikariConfigurationUtil.loadConfiguration;
import static org.hibernate.internal.util.StringHelper.isBlank;

Expand All @@ -48,7 +50,6 @@ public class HikariCPConnectionProvider implements ConnectionProvider, Configura

@Serial
private static final long serialVersionUID = -9131625057941275711L;
private boolean isMetadataAccessAllowed = true;

/**
* HikariCP configuration.
Expand All @@ -65,11 +66,10 @@ public class HikariCPConnectionProvider implements ConnectionProvider, Configura
// *************************************************************************

@Override
public void configure(Map<String, Object> configurationValues) throws HibernateException {
public void configure(Map<String, Object> configuration) throws HibernateException {
try {
isMetadataAccessAllowed = allowJdbcMetadataAccess( configurationValues );
ConnectionInfoLogger.INSTANCE.configureConnectionPool( "HikariCP" );
hikariConfig = loadConfiguration( configurationValues );
hikariConfig = loadConfiguration( configuration );
hikariDataSource = new HikariDataSource( hikariConfig );
}
catch (Exception e) {
Expand Down Expand Up @@ -108,14 +108,18 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
// in case it wasn't explicitly set and access to the
// database metadata is allowed
isBlank( hikariConfig.getDriverClassName() )
? extractDriverNameFromMetadata()
? getDriverName( connection )
: hikariConfig.getDriverClassName(),
dialect.getClass(),
dialect.getVersion(),
hasSchema( connection ),
hasCatalog( connection ),
hikariConfig.getSchema(),
hikariConfig.getCatalog(),
hikariConfig.getSchema() != null
? hikariConfig.getSchema()
: getSchema( connection ),
hikariConfig.getCatalog() != null
? hikariConfig.getCatalog()
: getCatalog( connection ),
Boolean.toString( hikariConfig.isAutoCommit() ),
hikariConfig.getTransactionIsolation() != null
? hikariConfig.getTransactionIsolation()
Expand All @@ -134,18 +138,6 @@ public DatabaseConnectionInfo getDatabaseConnectionInfo(Dialect dialect) {
}
}

private String extractDriverNameFromMetadata() {
if ( isMetadataAccessAllowed ) {
try ( Connection conn = getConnection() ) {
return conn.getMetaData().getDriverName();
}
catch (SQLException e) {
// Do nothing
}
}
return null;
}

@Override
public boolean isUnwrappableAs(Class<?> unwrapType) {
return ConnectionProvider.class.equals( unwrapType )
Expand Down
Loading