Changeset 7455

Timestamp:

Mar 6, 2018, 10:12:30 AM (4 years ago)

Author:

Nicklas Nordborg

Message:

References #2048: Upgrade to Hibernate 5.2

I hope this fixes the schema update problem. The SchemaMigrator has been replaced with code that goes directly into the internals of Hibernate and tries to check for an existing table using both quoted and unquoted table names. The generated SQL is then modified back to always use quoted table names. A good thing is that the "hack" mentioned in #2090 is no longer needed (due to the search-and-replace operation).

Location:

branches/3.12-stable/src/core/net/sf/basedb/core

Files:

• ServiceSessionControl.java (modified) (1 diff)
• hibernate/SchemaGenerator.java (modified) (7 diffs)

branches/3.12-stable/src/core/net/sf/basedb/core/ServiceSessionControl.java

@@ -346 +346 @@
         
         // Check if the schema exists or not
-        boolean schemaExists = HibernateUtil.doReturningWork(session, new SchemaExistsWork(catalog, schema));
+        boolean schemaExists = HibernateUtil.doReturningWork(session, new SchemaExistsWork(actualCatalog, actualSchema));
         installMode = schemaExists ? SchemaGenerator.Mode.UPDATE : SchemaGenerator.Mode.INSTALL;
         if (log.isDebugEnabled()) log.debug("Mode: " +installMode);

branches/3.12-stable/src/core/net/sf/basedb/core/hibernate/SchemaGenerator.java

@@ -22 +22 @@
 package net.sf.basedb.core.hibernate;
 
-import java.lang.reflect.Field;
 import java.sql.Connection;
+import java.sql.DatabaseMetaData;
 import java.sql.SQLException;
 import java.sql.Statement;
@@ -30 +30 @@
 import java.util.EnumSet;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 
+import net.sf.basedb.core.DatabaseException;
 import net.sf.basedb.core.ProgressReporter;
 import net.sf.basedb.core.StringUtil;
 import net.sf.basedb.core.dbengine.DbEngine;
+import net.sf.basedb.core.dbengine.TableInfo;
 import net.sf.basedb.util.EqualsHelper;
 
 import org.hibernate.boot.Metadata;
 import org.hibernate.boot.model.naming.Identifier;
-import org.hibernate.boot.model.relational.QualifiedName;
-import org.hibernate.boot.model.relational.QualifiedSequenceName;
 import org.hibernate.boot.model.relational.QualifiedTableName;
 import org.hibernate.boot.spi.MetadataImplementor;
 import org.hibernate.dialect.Dialect;
-import org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentImpl;
+import org.hibernate.engine.jdbc.env.internal.QualifiedObjectNameFormatterStandardImpl;
 import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
 import org.hibernate.engine.jdbc.env.spi.QualifiedObjectNameFormatter;
 import org.hibernate.jdbc.Work;
+import org.hibernate.mapping.Table;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.service.spi.ServiceRegistryImplementor;
 import org.hibernate.tool.schema.SourceType;
 import org.hibernate.tool.schema.TargetType;
+import org.hibernate.tool.schema.extract.spi.DatabaseInformation;
+import org.hibernate.tool.schema.extract.spi.TableInformation;
 import org.hibernate.tool.schema.internal.SchemaCreatorImpl;
+import org.hibernate.tool.schema.internal.exec.JdbcContext;
 import org.hibernate.tool.schema.internal.ExceptionHandlerHaltImpl;
+import org.hibernate.tool.schema.internal.Helper;
 import org.hibernate.tool.schema.internal.HibernateSchemaManagementTool;
-import org.hibernate.tool.schema.internal.IndividuallySchemaMigratorImpl;
 import org.hibernate.tool.schema.spi.ExceptionHandler;
 import org.hibernate.tool.schema.spi.ExecutionOptions;
 import org.hibernate.tool.schema.spi.SchemaCreator;
-import org.hibernate.tool.schema.spi.SchemaMigrator;
 import org.hibernate.tool.schema.spi.ScriptSourceInput;
 import org.hibernate.tool.schema.spi.ScriptTargetOutput;
@@ -117 +121 @@
     -----------------------
   */
+  @SuppressWarnings("unchecked")
   @Override
   public void execute(Connection connection) 
@@ -131 +136 @@
     String currentSql = null;
     boolean autoCommit = connection.getAutoCommit();
-    ForceQuotedTableNameFormatter tableNameFormatter = new ForceQuotedTableNameFormatter(metadata);
+
     try
     {
@@ -144 +149 @@
       {
         log.info("Generating schema update script");
-        tableNameFormatter.applyWorkaroundForHibernateBug();
-        SchemaMigrator schemaMigrator = new IndividuallySchemaMigratorImpl(tool, null);
-        schemaMigrator.doMigration(metadata, schemaUpdates, schemaUpdates);
+        
+        DatabaseMetaData jdbcMetaData = connection.getMetaData();
+        JdbcContext jdbcContext = tool.resolveJdbcContext(schemaUpdates.getConfigurationValues());
+        JdbcEnvironment jdbcEnvironment = metadata.getDatabase().getJdbcEnvironment();
+        
+        QualifiedObjectNameFormatter tableNameFormatter = new QualifiedObjectNameFormatterStandardImpl(jdbcEnvironment.getNameQualifierSupport());
+        
+        DatabaseInformation hibernateDbInfo = Helper.buildDatabaseInformation(serviceRegistry, 
+            tool.getDdlTransactionIsolator(jdbcContext), 
+            metadata.getDatabase().getDefaultNamespace().getName());
+        
+        Iterator<Table> tables = metadata.collectTableMappings().iterator();
+        while (tables.hasNext())
+        {
+          Table table = tables.next();
+          TableInfo jdbcTableInfo = new TableInfo(table, jdbcMetaData);
+          
+          log.debug("Table: " + table + (jdbcTableInfo.existsInDb() ? " EXISTS" : "NOT FOUND"));
+          
+          if (jdbcTableInfo.existsInDb())
+          {
+            // This table exists in the database, we need to force Hibernate to check and ALTER it if needed
+            QualifiedTableName qft = table.getQualifiedTableName();
+            
+            // First try: let Hibernate use the default settings to find the table
+            TableInformation hibernateTableInfo = hibernateDbInfo.getTableInformation(qft);
+            
+            if (log.isDebugEnabled()) log.debug(qft + ": " + hibernateTableInfo);
+            
+            if (hibernateTableInfo == null)
+            {
+              // If that fails, we need to try again with unquoted table name
+              qft = new QualifiedTableName(qft.getCatalogName(), qft.getSchemaName(), Identifier.toIdentifier(table.getName(), false));
+              hibernateTableInfo = hibernateDbInfo.getTableInformation(qft);
+              if (log.isDebugEnabled()) log.debug(qft + ": " + hibernateTableInfo);
+              
+              // If this is null here we are in trouble!!!
+              if (hibernateTableInfo == null)
+              {
+                throw new DatabaseException("Table '" + table.getName() + "' exists, but Hibernate can't find any information about it. "+
+                    "Please report as a bug to the BASE developers");
+              }
+            }
+            
+            // To get the quoting, upper- and lower-case correct we need to re-create a new instance
+            // and do a search-and-replace in the SQL generated by Hibernate
+            qft = new QualifiedTableName(hibernateTableInfo.getName().getCatalogName(), hibernateTableInfo.getName().getSchemaName(), table.getNameIdentifier());
+            String correctTableName = tableNameFormatter.format(qft, dialect);
+            String tableNameGeneratedByHibernate = tableNameFormatter.format(hibernateTableInfo.getName(), dialect);
+            if (log.isDebugEnabled())
+            {
+              log.debug("Search-and-replace: " + tableNameGeneratedByHibernate + "-->" + correctTableName);
+            }
+            Iterator<String> it = (Iterator<String>)table.sqlAlterStrings(dialect, metadata, hibernateTableInfo, null, null);
+            while (it.hasNext())
+            {
+              String sql = it.next();
+              String modifiedSql = sql.replace(tableNameGeneratedByHibernate, correctTableName);
+              if (!sql.equals(modifiedSql))
+              {
+                log.debug("Hibernate SQL: " + sql);
+                log.debug("Modified  SQL: " + modifiedSql);
+              }
+              schemaUpdates.accept(modifiedSql);
+            }
+          }
+          else
+          {
+            String[] sql = dialect.getTableExporter().getSqlCreateStrings(table, metadata);
+            for (String s : sql)
+            {
+              schemaUpdates.accept(s);
+            }
+          } 
+        }
       }
       else if (mode == Mode.INSTALL)
@@ -223 +300 @@
     {
       if (autoCommit != connection.getAutoCommit()) connection.setAutoCommit(autoCommit);
-      tableNameFormatter.resetWorkaroundForHibernateBug();
       if (stmt != null) 
       {
@@ -416 +492 @@
   }
   
-
-  /**
-    Replace the 'QualifiedObjectNameFormatter' with an implementation that forces 
-    all table names to be flagged as quoted. This is a hack to work around a bug
-    in Hibernate which generates "alter table table-name add column ..."
-    statements without quotes around the table-name which causes an error
-    
-    TODO - When (if?) this issue is fixed in Hibernate we can remove this workaround
-  */
-  static class ForceQuotedTableNameFormatter
-    implements QualifiedObjectNameFormatter
-  {
-
-    private final Metadata metadata;
-    private final JdbcEnvironment jdbc;
-    private QualifiedObjectNameFormatter originalFormatter;
-    
-    ForceQuotedTableNameFormatter(Metadata metadata)
-    {
-      this.metadata = metadata;
-      this.jdbc = metadata.getDatabase().getJdbcEnvironment();
-    }
-    
-    @Override
-    public String format(QualifiedTableName tableName, Dialect dialect) 
-    {
-      QualifiedTableName quotedTableName = new QualifiedTableName(
-        tableName.getCatalogName(), 
-        tableName.getSchemaName(),
-        Identifier.toIdentifier(tableName.getTableName().getText(), true)
-      );
-      return originalFormatter.format(quotedTableName, dialect);
-    }
-
-    @Override
-    public String format(QualifiedSequenceName sequenceName, Dialect dialect) 
-    {
-      return originalFormatter.format(sequenceName, dialect);
-    }
-
-    @Override
-    public String format(QualifiedName name, Dialect dialect) 
-    {
-      return originalFormatter.format(name, dialect);
-    }
-    
-    void applyWorkaroundForHibernateBug()
-    {
-      this.originalFormatter = jdbc.getQualifiedObjectNameFormatter();
-      setFormatter(this);
-    }
-    
-    void resetWorkaroundForHibernateBug()
-    {
-      if (originalFormatter != null) setFormatter(originalFormatter);
-    }
-    
-    private void setFormatter(QualifiedObjectNameFormatter formatter)
-    {
-      try
-      {
-        Field f = JdbcEnvironmentImpl.class.getDeclaredField("qualifiedObjectNameFormatter");
-        f.setAccessible(true);
-        f.set(jdbc, formatter);
-      }
-      catch (Exception ex)
-      {
-        throw new RuntimeException(ex);
-      }
-    }
-    
-  }
   
 }