HHH-9820 - Handle JDBC drivers that do not properly report metadata regarding case of identifiers

Author: sebersole

hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java

@@ -11,6 +11,7 @@
 import java.sql.Blob;
 import java.sql.CallableStatement;
 import java.sql.Clob;
+import java.sql.DatabaseMetaData;
 import java.sql.NClob;
 import java.sql.ResultSet;
 import java.sql.SQLException;
@@ -53,6 +54,8 @@
 import org.hibernate.engine.jdbc.LobCreator;
 import org.hibernate.engine.jdbc.env.internal.DefaultSchemaNameResolver;
 import org.hibernate.engine.jdbc.env.spi.AnsiSqlKeywords;
+import org.hibernate.engine.jdbc.env.spi.IdentifierHelper;
+import org.hibernate.engine.jdbc.env.spi.IdentifierHelperBuilder;
 import org.hibernate.engine.jdbc.env.spi.NameQualifierSupport;
 import org.hibernate.engine.jdbc.env.spi.SchemaNameResolver;
 import org.hibernate.engine.jdbc.spi.JdbcServices;
@@ -1846,37 +1849,55 @@ protected void registerKeyword(String word) {
 	}
 
 	/**
-	 * @deprecated See {@link #determineKeywordsForAutoQuoting} instead
+	 * @deprecated These are only ever used (if at all) from the code that handles identifier quoting.  So
+	 * see {@link #buildIdentifierHelper} instead
 	 */
 	@Deprecated
 	public Set<String> getKeywords() {
 		return sqlKeywords;
 	}
 
 	/**
-	 * Hook into auto-quoting of identifiers that are deemed to be keywords.  By default we
-	 * return all of the following here:<ul>
-	 *     <li>all keywords as defined by ANSI SQL:2003 specification</li>
-	 *     <li>all "extra" keywords reported by the JDBC driver </li>
-	 *     <li>all Dialect-registered "extra" keywords</li>
-	 * </ul>
+	 * Build the IdentifierHelper indicated by this Dialect for handling identifier conversions.
+	 * Returning {@code null} is allowed and indicates that Hibernate should fallback to building a
+	 * "standard" helper.  In the fallback path, any changes made to the IdentifierHelperBuilder
+	 * during this call will still be incorporated into the built IdentifierHelper.
 	 * <p/>
-	 * Subclasses are free to override this as they see fit.  Just be aware that overriding this
-	 * does affect what identifiers are auto-quoted based on being seen as a keyword.
+	 * The incoming builder will have the following set:<ul>
+	 *     <li>{@link IdentifierHelperBuilder#isGloballyQuoteIdentifiers()}</li>
+	 *     <li>{@link IdentifierHelperBuilder#getUnquotedCaseStrategy()} - initialized to UPPER</li>
+	 *     <li>{@link IdentifierHelperBuilder#getQuotedCaseStrategy()} - initialized to MIXED</li>
+	 * </ul>
 	 * <p/>
-	 * NOTE: The code that ultimately consumes these and uses them stores them in a case-insensitive
-	 * Set, so case here does not matter.
-	 *
-	 * @see org.hibernate.engine.jdbc.env.spi.AnsiSqlKeywords#sql2003()
-	 * @see java.sql.DatabaseMetaData#getSQLKeywords()
-	 * @see #registerKeyword
-	 */
-	public Set<String> determineKeywordsForAutoQuoting(Set<String> databaseMetadataReportedKeywords) {
-		final Set<String> keywords = new HashSet<String>();
-		keywords.addAll( AnsiSqlKeywords.INSTANCE.sql2003() );
-		keywords.addAll( databaseMetadataReportedKeywords );
-		keywords.addAll( sqlKeywords );
-		return keywords;
+	 * By default Hibernate will do the following:<ul>
+	 *     <li>Call {@link IdentifierHelperBuilder#applyIdentifierCasing(DatabaseMetaData)}
+	 *     <li>Call {@link IdentifierHelperBuilder#applyReservedWords(DatabaseMetaData)}
+	 *     <li>Applies {@link AnsiSqlKeywords#sql2003()} as reserved words</li>
+	 *     <li>Applies the {#link #sqlKeywords} collected here as reserved words</li>
+	 *     <li>Applies the Dialect's NameQualifierSupport, if it defines one</li>
+	 * </ul>
+	 *
+	 * @param builder A semi-configured IdentifierHelper builder.
+	 * @param dbMetaData Access to the metadata returned from the driver if needed and if available.  WARNING: may be {@code null}
+	 *
+	 * @return The IdentifierHelper instance to use, or {@code null} to indicate Hibernate should use its fallback path
+	 *
+	 * @throws SQLException Accessing the DatabaseMetaData can throw it.  Just re-throw and Hibernate will handle.
+	 *
+	 * @see #getNameQualifierSupport()
+	 */
+	public IdentifierHelper buildIdentifierHelper(
+			IdentifierHelperBuilder builder,
+			DatabaseMetaData dbMetaData) throws SQLException {
+		builder.applyIdentifierCasing( dbMetaData );
+
+		builder.applyReservedWords( dbMetaData );
+		builder.applyReservedWords( AnsiSqlKeywords.INSTANCE.sql2003() );
+		builder.applyReservedWords( sqlKeywords );
+
+		builder.setNameQualifierSupport( getNameQualifierSupport() );
+
+		return builder.build();
 	}
 
 

hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/JdbcEnvironmentImpl.java

@@ -9,11 +9,9 @@
 import java.sql.DatabaseMetaData;
 import java.sql.SQLException;
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
 import java.util.Set;
-import java.util.TreeSet;
 
 import org.hibernate.boot.model.naming.Identifier;
 import org.hibernate.boot.registry.selector.spi.StrategySelector;
@@ -22,7 +20,9 @@
 import org.hibernate.engine.config.spi.ConfigurationService;
 import org.hibernate.engine.config.spi.StandardConverters;
 import org.hibernate.engine.jdbc.env.spi.ExtractedDatabaseMetaData;
+import org.hibernate.engine.jdbc.env.spi.IdentifierCaseStrategy;
 import org.hibernate.engine.jdbc.env.spi.IdentifierHelper;
+import org.hibernate.engine.jdbc.env.spi.IdentifierHelperBuilder;
 import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
 import org.hibernate.engine.jdbc.env.spi.LobCreatorBuilder;
 import org.hibernate.engine.jdbc.env.spi.NameQualifierSupport;
@@ -36,10 +36,14 @@
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.service.spi.ServiceRegistryImplementor;
 
+import org.jboss.logging.Logger;
+
 /**
  * @author Steve Ebersole
  */
 public class JdbcEnvironmentImpl implements JdbcEnvironment {
+	private static final Logger log = Logger.getLogger( JdbcEnvironmentImpl.class );
+
 	private final Dialect dialect;
 
 	private final SqlExceptionHelper sqlExceptionHelper;
@@ -51,7 +55,6 @@ public class JdbcEnvironmentImpl implements JdbcEnvironment {
 	private final LobCreatorBuilderImpl lobCreatorBuilder;
 
 	private final LinkedHashSet<TypeInfo> typeInfoSet = new LinkedHashSet<TypeInfo>();
-	private final Set<String> reservedWords = new TreeSet<String>( String.CASE_INSENSITIVE_ORDER );
 
 	/**
 	 * Constructor form used when the JDBC {@link java.sql.DatabaseMetaData} is not available.
@@ -62,6 +65,8 @@ public class JdbcEnvironmentImpl implements JdbcEnvironment {
 	public JdbcEnvironmentImpl(ServiceRegistryImplementor serviceRegistry, Dialect dialect) {
 		this.dialect = dialect;
 
+		final ConfigurationService cfgService = serviceRegistry.getService( ConfigurationService.class );
+
 		NameQualifierSupport nameQualifierSupport = dialect.getNameQualifierSupport();
 		if ( nameQualifierSupport == null ) {
 			// assume both catalogs and schemas are supported
@@ -71,39 +76,43 @@ public JdbcEnvironmentImpl(ServiceRegistryImplementor serviceRegistry, Dialect d
 		this.sqlExceptionHelper = buildSqlExceptionHelper( dialect );
 		this.extractedMetaDataSupport = new ExtractedDatabaseMetaDataImpl.Builder( this ).build();
 
-		reservedWords.addAll( dialect.determineKeywordsForAutoQuoting( Collections.<String>emptySet() ) );
+		final IdentifierHelperBuilder identifierHelperBuilder = IdentifierHelperBuilder.from( this );
+		identifierHelperBuilder.setGloballyQuoteIdentifiers( globalQuoting( cfgService ) );
+		identifierHelperBuilder.setNameQualifierSupport( nameQualifierSupport );
 
-		final boolean globallyQuoteIdentifiers = serviceRegistry.getService( ConfigurationService.class )
-				.getSetting( AvailableSettings.GLOBALLY_QUOTED_IDENTIFIERS, StandardConverters.BOOLEAN, false );
-
-		// a simple impl that works on H2
-		this.identifierHelper = new NormalizingIdentifierHelperImpl(
-				this,
-				nameQualifierSupport,
-				globallyQuoteIdentifiers,
-				true,	// storesMixedCaseQuotedIdentifiers
-				false,	// storesLowerCaseQuotedIdentifiers
-				false, 	// storesUpperCaseQuotedIdentifiers
-				false,  // storesMixedCaseIdentifiers
-				true,	// storesUpperCaseIdentifiers
-				false	// storesLowerCaseIdentifiers
-		);
+		IdentifierHelper identifierHelper = null;
+		try {
+			identifierHelper = dialect.buildIdentifierHelper( identifierHelperBuilder, null );
+		}
+		catch (SQLException sqle) {
+			// should never ever happen
+			log.debug( "There was a problem accessing DatabaseMetaData in building the JdbcEnvironment", sqle );
+		}
+		if ( identifierHelper == null ) {
+			identifierHelper = identifierHelperBuilder.build();
+		}
+		this.identifierHelper = identifierHelper;
 
 		this.currentCatalog = identifierHelper.toIdentifier(
-				serviceRegistry.getService( ConfigurationService.class )
-						.getSetting( AvailableSettings.DEFAULT_CATALOG, StandardConverters.STRING )
+				cfgService.getSetting( AvailableSettings.DEFAULT_CATALOG, StandardConverters.STRING )
 		);
 		this.currentSchema = Identifier.toIdentifier(
-				serviceRegistry.getService( ConfigurationService.class )
-						.getSetting( AvailableSettings.DEFAULT_SCHEMA, StandardConverters.STRING )
+				cfgService.getSetting( AvailableSettings.DEFAULT_SCHEMA, StandardConverters.STRING )
 		);
 
-		// again, a simple impl that works on H2
 		this.qualifiedObjectNameFormatter = new QualifiedObjectNameFormatterStandardImpl( nameQualifierSupport );
 
 		this.lobCreatorBuilder = LobCreatorBuilderImpl.makeLobCreatorBuilder();
 	}
 
+	private static boolean globalQuoting(ConfigurationService cfgService) {
+		return cfgService.getSetting(
+				AvailableSettings.GLOBALLY_QUOTED_IDENTIFIERS,
+				StandardConverters.BOOLEAN,
+				false
+		);
+	}
+
 	/**
 	 * Constructor form used from testing
 	 *
@@ -123,22 +132,20 @@ public JdbcEnvironmentImpl(DatabaseMetaData databaseMetaData, Dialect dialect) t
 			nameQualifierSupport = determineNameQualifierSupport( databaseMetaData );
 		}
 
-		reservedWords.addAll( dialect.determineKeywordsForAutoQuoting( extractedMetaDataSupport.getExtraKeywords() ) );
-
-		final boolean globallyQuoteIdentifiers = false;
-
-		// a simple impl that works on H2
-		this.identifierHelper = new NormalizingIdentifierHelperImpl(
-				this,
-				nameQualifierSupport,
-				globallyQuoteIdentifiers,
-				true,	// storesMixedCaseQuotedIdentifiers
-				false,	// storesLowerCaseQuotedIdentifiers
-				false, 	// storesUpperCaseQuotedIdentifiers
-				false,  // storesMixedCaseIdentifiers
-				true,	// storesUpperCaseIdentifiers
-				false	// storesLowerCaseIdentifiers
-		);
+		final IdentifierHelperBuilder identifierHelperBuilder = IdentifierHelperBuilder.from( this );
+		identifierHelperBuilder.setNameQualifierSupport( nameQualifierSupport );
+		IdentifierHelper identifierHelper = null;
+		try {
+			identifierHelper = dialect.buildIdentifierHelper( identifierHelperBuilder, databaseMetaData );
+		}
+		catch (SQLException sqle) {
+			// should never ever happen
+			log.debug( "There was a problem accessing DatabaseMetaData in building the JdbcEnvironment", sqle );
+		}
+		if ( identifierHelper == null ) {
+			identifierHelper = identifierHelperBuilder.build();
+		}
+		this.identifierHelper = identifierHelper;
 
 		this.currentCatalog = null;
 		this.currentSchema = null;
@@ -184,6 +191,8 @@ public JdbcEnvironmentImpl(
 			DatabaseMetaData databaseMetaData) throws SQLException {
 		this.dialect = dialect;
 
+		final ConfigurationService cfgService = serviceRegistry.getService( ConfigurationService.class );
+
 		this.sqlExceptionHelper = buildSqlExceptionHelper( dialect );
 
 		this.extractedMetaDataSupport = new ExtractedDatabaseMetaDataImpl.Builder( this )
@@ -196,22 +205,21 @@ public JdbcEnvironmentImpl(
 			nameQualifierSupport = determineNameQualifierSupport( databaseMetaData );
 		}
 
-		reservedWords.addAll( dialect.determineKeywordsForAutoQuoting( extractedMetaDataSupport.getExtraKeywords() ) );
-
-		final boolean globallyQuoteIdentifiers = serviceRegistry.getService( ConfigurationService.class )
-				.getSetting( AvailableSettings.GLOBALLY_QUOTED_IDENTIFIERS, StandardConverters.BOOLEAN, false );
-
-		this.identifierHelper = new NormalizingIdentifierHelperImpl(
-				this,
-				nameQualifierSupport,
-				globallyQuoteIdentifiers,
-				databaseMetaData.storesMixedCaseQuotedIdentifiers(),
-				databaseMetaData.storesLowerCaseQuotedIdentifiers(),
-				databaseMetaData.storesUpperCaseQuotedIdentifiers(),
-				databaseMetaData.storesMixedCaseIdentifiers(),
-				databaseMetaData.storesUpperCaseIdentifiers(),
-				databaseMetaData.storesLowerCaseIdentifiers()
-		);
+		final IdentifierHelperBuilder identifierHelperBuilder = IdentifierHelperBuilder.from( this );
+		identifierHelperBuilder.setGloballyQuoteIdentifiers( globalQuoting( cfgService ) );
+		identifierHelperBuilder.setNameQualifierSupport( nameQualifierSupport );
+		IdentifierHelper identifierHelper = null;
+		try {
+			identifierHelper = dialect.buildIdentifierHelper( identifierHelperBuilder, databaseMetaData );
+		}
+		catch (SQLException sqle) {
+			// should never ever happen
+			log.debug( "There was a problem accessing DatabaseMetaData in building the JdbcEnvironment", sqle );
+		}
+		if ( identifierHelper == null ) {
+			identifierHelper = identifierHelperBuilder.build();
+		}
+		this.identifierHelper = identifierHelper;
 
 		// and that current-catalog and current-schema happen after it
 		this.currentCatalog = identifierHelper.toIdentifier( extractedMetaDataSupport.getConnectionCatalogName() );
@@ -225,7 +233,7 @@ public JdbcEnvironmentImpl(
 		this.typeInfoSet.addAll( TypeInfo.extractTypeInfo( databaseMetaData ) );
 
 		this.lobCreatorBuilder = LobCreatorBuilderImpl.makeLobCreatorBuilder(
-				serviceRegistry.getService( ConfigurationService.class ).getSettings(),
+				cfgService.getSettings(),
 				databaseMetaData.getConnection()
 		);
 	}
@@ -307,11 +315,6 @@ public IdentifierHelper getIdentifierHelper() {
 		return identifierHelper;
 	}
 
-	@Override
-	public boolean isReservedWord(String word) {
-		return reservedWords.contains( word );
-	}
-
 	@Override
 	public SqlExceptionHelper getSqlExceptionHelper() {
 		return sqlExceptionHelper;