Changeset 5388

Timestamp:

Aug 17, 2010, 10:01:25 AM (13 years ago)

Author:

Nicklas Nordborg

Message:

References #1488: Update to Hibernate 3.5.2

Fixes problems with schema update by replacing the Hibernate tool with our own implementation. Most of the work is still done by Hibernate, but we now have the chance to modify or skip certain SQL statements.

Location:

trunk

Files:

• config/dist/log4j.properties (modified) (1 diff)
• src/core/net/sf/basedb/core/HibernateUtil.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/Install.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (1 diff)
• src/core/net/sf/basedb/core/dbengine/AbstractDbEngine.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/dbengine/DbEngine.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/dbengine/PostgresDbEngine.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/hibernate/SchemaGenerator.java (added)

trunk/config/dist/log4j.properties

@@ -74 +74 @@
 ### log schema export/update ###
 #log4j.logger.org.hibernate.tool.hbm2ddl=debug
+#log4j.logger.net.sf.basedb.core.hibernate.SchemaGenerator=debug
 
 ### log HQL parse trees

trunk/src/core/net/sf/basedb/core/HibernateUtil.java

@@ -41 +41 @@
 import net.sf.basedb.core.hibernate.EntityQueryWrapper;
 import net.sf.basedb.core.hibernate.ExecuteUpdateWork;
+import net.sf.basedb.core.hibernate.SchemaGenerator;
 import net.sf.basedb.core.hibernate.TypeWrapper;
 import net.sf.basedb.core.hibernate.JdbcWork;
@@ -90 +91 @@
 import org.hibernate.mapping.PrimaryKey;
 import org.hibernate.cfg.Configuration;
-import org.hibernate.tool.hbm2ddl.SchemaExport;
-import org.hibernate.tool.hbm2ddl.SchemaUpdate;
 import org.hibernate.metadata.ClassMetadata;
 import org.hibernate.dialect.Dialect;
@@ -504 +503 @@
   
   /**
-    Create the all tables in the database. We use the {@link SchemaUpdate} tool
-    provided by Hibernate. The database must exists and we recommend that
-    it is empty to begin with.
-  */
-  static void createStaticTables(boolean update)
+    Create the all tables in the database. The database must exists and we 
+    recommend that it is empty to begin with.
+  */
+  static void createStaticTables(boolean update, ProgressReporter progress)
     throws BaseException
   {
     assert sf != null : "HibernateUtil has not been initialised";
-    if (!update && !isEmptyDatabase())
-    {
-      throw new BaseException("Database already has tables.");
-    }
-    try
-    {
-      List exceptions;
-      if (update)
+
+    if (update)
+    {
+      int currentSchemaVersion = Application.getSchemaVersion();        
+      if (currentSchemaVersion < 0)
       {
-        int currentSchemaVersion = Application.getSchemaVersion();        
-        if (currentSchemaVersion < 0)
-        {
-          throw new BaseException("Couldn't load current schema version of database");
-        }
-        else if (Install.NEW_SCHEMA_VERSION < currentSchemaVersion)
-        {
-          throw new BaseException("Can't update to schema version " + Install.NEW_SCHEMA_VERSION + 
-              " of database, cause you already have schema version " + currentSchemaVersion + " installed");
-        }
-        // Note! This doesn't create indexes correctly. Use dbIndexes method.
-        SchemaUpdate se = new SchemaUpdate(cfg);
-        se.setHaltOnError(true);
-        se.execute(false, true);
-        exceptions = se.getExceptions();
+        throw new BaseException("Couldn't load current schema version of database");
       }
-      else
+      else if (Install.NEW_SCHEMA_VERSION < currentSchemaVersion)
       {
-        SchemaExport se = new SchemaExport(cfg);
-        se.setHaltOnError(true);
-        se.execute(false, true, false, true);
-        exceptions = se.getExceptions();
+        throw new BaseException("Can't update to schema version " + Install.NEW_SCHEMA_VERSION + 
+            " of database, cause you already have schema version " + currentSchemaVersion + " installed");
       }
-      if (exceptions != null && exceptions.size() > 0)
+    }
+    else
+    {
+      if (!isEmptyDatabase())
       {
-        throw new BaseException((Throwable)exceptions.get(0));
+        throw new BaseException("Database already has tables.");
       }
     }
-    catch (HibernateException ex)
-    {
-      throw new BaseException(ex);
+
+    Session session = null;
+    Transaction tx = null;
+    try
+    {
+      SchemaGenerator schemaGenerator = new SchemaGenerator(cfg, dialect, dbEngine, update, progress);
+      session = HibernateUtil.newSession();
+      tx = HibernateUtil.newTransaction(session);
+      session.doWork(schemaGenerator);
+      HibernateUtil.commit(tx);
+    }
+    catch (Exception ex)
+    {
+      if (tx != null) HibernateUtil.rollback(tx);
+      throw new BaseException(ex);
+    }
+    finally
+    {
+      if (session != null) HibernateUtil.close(session);
     }
   }

trunk/src/core/net/sf/basedb/core/Install.java

@@ -82 +82 @@
 import java.util.HashMap;
 import java.util.Set;
-import java.util.TimerTask;
 
 import org.jdom.Document;
@@ -122 +121 @@
   {
     String message = "";
-    TimerTask timer = null;
-    if (progress != null) 
-    {
-      progress.display(0, "Building database...");
-      // The timer will append a dot to the progress reporter every second
-      timer = new TimerTask()
-        {
-          public void run()
-          {
-            progress.append(".");
-          }
-        };
-    }
-    try
-    {
-      if (timer != null) Application.getCoreTimer().schedule(timer, 1000, 1000);
+    try
+    {
       Application.start(true, false, false);
-      HibernateUtil.createStaticTables(update);
+      if (progress != null) progress.display(0, "Building database...");
+      HibernateUtil.createStaticTables(update, progress);
       message = "Database built successfully.";
     }
@@ -149 +135 @@
     finally
     {
-      if (timer != null) 
-      {
-        timer.cancel();
-        timer = null;
-      }
       if (progress != null)
       {

trunk/src/core/net/sf/basedb/core/Update.java

@@ -2857 +2857 @@
       // Commit the changes
       HibernateUtil.commit(tx);
-      log.info("updateToSchemaVersion79: OK");
+      log.info("updateToSchemaVersion80: OK");
     }
     catch (BaseException ex)
     {
       if (tx != null) HibernateUtil.rollback(tx); 
-      log.error("updateToSchemaVersion79: FAILED", ex);
+      log.error("updateToSchemaVersion80: FAILED", ex);
       throw ex;
     }

trunk/src/core/net/sf/basedb/core/dbengine/AbstractDbEngine.java

@@ -23 +23 @@
 
 import java.util.regex.Pattern;
+
+import org.hibernate.dialect.Dialect;
 
 /**
@@ -177 +179 @@
     return null;
   }
+  /**
+    Remove "not null" constraints from "alter table ... add column"
+    statements that doesn't supply a default value for the new column
+    when updating.
+    @since 2.16
+  */
+  @Override
+  public String inspectSchemaGenerationSQL(String sql, Dialect dialect,
+      boolean update)
+  {
+    String addColumn = dialect.getAddColumnString();
+    if (update && sql.contains("alter table") && sql.contains(addColumn) && 
+        sql.contains("not null") && !sql.contains("default"))
+    {
+      sql = sql.replace("not null", "");
+    }
+    return sql;
+  }
+
   // -------------------------------------------
 

trunk/src/core/net/sf/basedb/core/dbengine/DbEngine.java

@@ -24 +24 @@
 
 import java.util.Set;
+
+import net.sf.basedb.core.hibernate.SchemaGenerator;
 
 import org.hibernate.dialect.Dialect;
@@ -314 +316 @@
   public String getCaseSensitiveVarchar(int length);
   
+  /**
+    Let the DbEninge inspect a schema generation sql statment and
+    possible modify it before it is sent to the database. This
+    method is called from the {@link SchemaGenerator} class
+    when creating or updating a database.
+    @param sql The original SQL statment as generated by Hibernate
+    @param dialect The Hibernate dialect currently in use
+    @param update TRUE if we are updating an existing database,
+      FALSE if we are creating a new one
+    @return The SQL statement which may have been modified or null
+      to skip executing the statment
+    @since 2.16
+  */
+  public String inspectSchemaGenerationSQL(String sql, Dialect dialect, boolean update);
+  
 }

trunk/src/core/net/sf/basedb/core/dbengine/PostgresDbEngine.java

@@ -23 +23 @@
 
 import java.util.Set;
+
+import org.hibernate.dialect.Dialect;
 
 /**
@@ -209 +211 @@
     return value + " ~ " + regexp;
   }
+  /**
+    Skip all "create index" statements since Hibernate doesn't generate those
+    with unique names. PostgreSQL users should always run the ./updateindexes.sh
+    tool which will create the missing indexes.
+    @since 2.16
+  */
+  @Override
+  public String inspectSchemaGenerationSQL(String sql, Dialect dialect,
+      boolean update)
+  {
+    sql = super.inspectSchemaGenerationSQL(sql, dialect, update);
+    if (sql != null && sql.startsWith("create index"))
+    {
+      sql = null;
+    }
+    return sql;
+  }
   // -------------------------------------------