Automatic Schema Generation

[subhashchandra medhiassam]

Hi all,
Could anybody enlighten me on what is automatic schema generation using hibernate? Your replies would be highly appreciated. I would also like to know how to implement automatic schema generation. It would be nice if somebody would provide some example.

Thanks,
Subhash

[subhashchandra medhiassam]

Hi all,
I have gone through some tutorial available in the net on automatically updating a schema.(web page)

I tried to implement whatever is given in that tutorial. Here goes the description.

I have a class Schema1 which is a representation for the table schema1 in MYSQL.

Table schema1 has columns id(int type),description(varchar type) and country_code(int type).

Table schema1:
Column Data-type
------ ---------
id int
description varchar
country_code int

Class Scema1.java looks like the following:

 public class Schema1 {
 
    private int id;
    private String description;
    private int country_code;
    
    public int getCountry_code() {
        return country_code;
    }
    public void setCountry_code(int country_code) {
        this.country_code = country_code;
    }
    public String getDescription() {
        return description;
    }
    public void setDescription(String description) {
        this.description = description;
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    
    
}   

Now, i have another class UpdateSchema.java. It looks like the following:

  
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
 
import org.hibernate.*;
import org.hibernate.cfg.*;
import org.hibernate.tool.hbm2ddl.SchemaUpdate;   
 
 
public class UpdateSchema {
    public static SessionFactory sessionFactory;
    
    public UpdateSchema(Configuration myConfiguration) {
// TODO Auto-generated constructor stub
    }
 
    public static void main(String[] args) {
System.out.println("initialization");

try
        {
            Configuration myConfiguration = new
                 Configuration();
 
            myConfiguration.addClass(Schema1.class);
            
 
            // Load the *.hbm.xml files as set in the
            // config, and set the dialect.
            new UpdateSchema(myConfiguration).execute(true,true);
 
        } catch (Exception e)
        {
            e.printStackTrace();
        }
    }
 
}

I have exactly followed the code given in the tutorial.

What I am unable to understand is where from does the "execute" method arise?(In "new UpdateSchema(myConfiguration).execute(true,true);")

Could anybody give me some idea about this code?

Thanks,
Subhash
[ September 24, 2008: Message edited by: subhashchandra medhiassam ]

[Paul Sturrock]

The Hibernate documentation is always the best place to start (especially as the tutorial you link to is three years old, uses Hibernate v2 and demonstrates a technique that is unneccesary). Have a read of the official documentation and this should get you going.

Typically you should not have to programatically enable dynamic DDL - its a property you set in your configuration and Hibernate will do the work for you. Read the official documentation, all should become clear.
[ September 24, 2008: Message edited by: Paul Sturrock ]

[subhashchandra medhiassam]

Well,
I have tried updating the schema in another way.

I have the same table schema1. I want to add another column "addition" of type varchar to this table.

So,I have added one extra property to my mapping file. My .hbm.xml file now looks like this:

 
<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC 
"-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
 
<hibernate-mapping>
  <class name="Schema1" table="Schema1">
     <id name="id" column="id" type="int">
     <generator class="native"/>
     </id>
     <property name="description" column="description" type="string" /> 
     <property name="country_code" column="country_code" type="int" /> 
     <property name="addition" column="addition" type="string" />   
 </class>  
</hibernate-mapping>

I have changed my POJO class Schema1.java which now looks like the following:

 
public class Schema1 {
 
    private int id;
    private String description;
    private int country_code;
    private String addition;
    
    
    public String getAddition() {
        return addition;
    }
    public void setAddition(String addition) {
        this.addition = addition;
    }
    public int getCountry_code() {
        return country_code;
    }
    public void setCountry_code(int country_code) {
        this.country_code = country_code;
    }
    public String getDescription() {
        return description;
    }
    public void setDescription(String description) {
        this.description = description;
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    
    
}

Now, my i have another class UpdateSchema.java which looks like the following:

import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;
 
import org.hibernate.*;
import org.hibernate.cfg.*;
import org.hibernate.tool.hbm2ddl.SchemaUpdate;   
 

public class UpdateSchema {
    public static SessionFactory sessionFactory;
    
    public UpdateSchema(Configuration myConfiguration) {
// TODO Auto-generated constructor stub
    }
 
    public static void main(String[] args) {
System.out.println("initialization");

try
        {
    Configuration cfg = new Configuration().addClass(Schema1.class).setProperty("hibernate.dialect", "org.hibernate.dialect.MySQLInnoDBDialect");
    SchemaUpdate schemaUpdate = new SchemaUpdate(cfg);
    schemaUpdate.execute(true, true);
 

        } catch (Exception e)
        {
            e.printStackTrace();
        }
    }
 
}

When i execute this program, i don't get any error output. It executes properly. But the table schema1 doesn't get changed. It remains the same.

Could anybody kindly tell me why? What's the remedy for this?

Thanks,
Subhash

[subhashchandra medhiassam]

Hi Paul,
You are telling that the official Hibernate documentation is the best place to start. Well, i went through that document. What's given there is that we should include the following two lines of code in our program:

  Configuration cfg = ....;
new SchemaUpdate(cfg).execute(false);  

But the method execute which is available takes two arguments of type boolean and not one?


What should i do now? Kindly help.

Thanks,
Subhash

[Paul Sturrock]

What's given there is that we should include the following two lines of code in our program:

Not sure where you found that bit of information - its not mentioned in the "Automatic schema generation" section of the docs. Where did you see it?

The Hibernate tools API included a SchemaUpdate type - but I don't see why you should need to use it. Hibernate includes a tool generate DDL based on your mapping files. Have a read about the hibernate.hbm2ddl.auto property and its effects.

[subhashchandra medhiassam]

Okay,
I got the following in the official documentation on hibernate.hbm2ddl.auto:

"Automatically validate or export schema DDL to the database when the SessionFactory is created. With create-drop, the database schema will be dropped when the SessionFactory is closed explicitly.
eg. validate | update | create | create-drop"


So, accordingly, i have changed my third class UpdateSchema.java. It now looks like this:

public static void main(String[] args) {
System.out.println("initialization");

try
        {
        
    SessionFactory sessionFactory = new Configuration().configure().buildSessionFactory(); 
    
 
        } catch (Exception e)
        {
            e.printStackTrace();
        }
    }    

But when i run it, it is throwing the following message:

org.hibernate.MappingException: An AnnotationConfiguration instance is required to use <mapping clazz="Schema1"/>
at org.hibernate.cfg.Configuration.parseMappingElement(Configuration.java:1391)
at org.hibernate.cfg.Configuration.parseSessionFactory(Configuration.java:1353)
at org.hibernate.cfg.Configuration.doConfigure(Configuration.java:1335)
at org.hibernate.cfg.Configuration.doConfigure(Configuration.java:1302)
at org.hibernate.cfg.Configuration.configure(Configuration.java:1230)
at org.hibernate.cfg.Configuration.configure(Configuration.java:1216)
at UpdateSchema.main(UpdateSchema.java:19)

What could be the reason? Kindly do let me know what i should do?

Thanks,
Subhash

[Paul Sturrock]

I think you can only get that error mapping classes directly in you hibernate.cfg.xml file. Can you post that?

[subhashchandra medhiassam]

Yes, i have tried to map my bean class in the hibernate.cfg.xml. It looks like the following now:

 <?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD//EN"
"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
 
<hibernate-configuration>
<session-factory>
      <property name="hibernate.connection.driver_class">
 
com.mysql.jdbc.Driver</property>
      <property name="hibernate.connection.url">
 
jdbc:mysql://localhost/hibernatetutorial</property>
      <property name="hibernate.connection.username">root</property>
      <property name="hibernate.connection.password">root</property>
      <property name="hibernate.connection.pool_size">10</property>
      <property name="show_sql">true</property>
      <property name="dialect">org.hibernate.dialect.MySQLDialect</property>
      <property name="hibernate.hbm2ddl.auto">update</property>
      <!-- Persistent classes -->
      <mapping class="Schema1" />
      <!-- Mapping files -->
      <mapping resource="Schema1.hbm.xml"/>
</session-factory>
</hibernate-configuration>   

Kindly help.

Thanks,
Subhash

[Paul Sturrock]

<mapping class="Schema1" />

There is your problem. You are mapping a class, not a resource. If you map a class you are relying on annotations not mapping files.

[subhashchandra medhiassam]

Then what should i do? Map the class as a resource?

Thanks in advance,
Subhash

[Paul Sturrock]

Map the resource (since the resource maps the class)

[subhashchandra medhiassam]

Which resource do you mean? Could you be a bit clearer?

Thanks,
Subhash

[subhashchandra medhiassam]

But when i am mapping Schema1 as a resource and then running the program, i am getting the following message:

 
org.hibernate.MappingException: Error reading resource: Schema1.class
at org.hibernate.cfg.Configuration.addResource(Configuration.java:447)
at org.hibernate.cfg.Configuration.parseMappingElement(Configuration.java:1381)
at org.hibernate.cfg.Configuration.parseSessionFactory(Configuration.java:1353)
at org.hibernate.cfg.Configuration.doConfigure(Configuration.java:1335)
at org.hibernate.cfg.Configuration.doConfigure(Configuration.java:1302)
at org.hibernate.cfg.Configuration.configure(Configuration.java:1230)
at org.hibernate.cfg.Configuration.configure(Configuration.java:1216)
at UpdateSchema.main(UpdateSchema.java:19)
Caused by: org.hibernate.MappingException: org.dom4j.DocumentException: Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.
at org.hibernate.cfg.Configuration.addInputStream(Configuration.java:403)
at org.hibernate.cfg.Configuration.addResource(Configuration.java:444)
... 7 more
Caused by: org.dom4j.DocumentException: Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.
at org.dom4j.io.SAXReader.read(SAXReader.java:353)
at org.hibernate.cfg.Configuration.addInputStream(Configuration.java:393)
... 8 more   
 

What should i do? Kindly advise.

Thanks,
Subhash

[Paul Sturrock]

It would appear you have saved your hbm.xml file in an encoding other than UTF-8. Make sure you save the file as UTF-8.

[subhashchandra medhiassam]

Well,
My hibernate.cfg.xml looks like the following now:

  <?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD//EN"
"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
 
<hibernate-configuration>
<session-factory>
      <property name="hibernate.connection.driver_class">
 
com.mysql.jdbc.Driver</property>
      <property name="hibernate.connection.url">
 
jdbc:mysql://localhost/hibernatetutorial</property>
      <property name="hibernate.connection.username">root</property>
      <property name="hibernate.connection.password">root</property>
      <property name="hibernate.connection.pool_size">10</property>
      <property name="show_sql">true</property>
      <property name="dialect">org.hibernate.dialect.MySQLDialect</property>
      <property name="hibernate.hbm2ddl.auto">update</property>
      <!-- Persistent classes -->
      <!-- <mapping class="Schema1" /> --> 
      <!-- Mapping files -->
      <mapping resource="Schema1.hbm.xml"/>
      <mapping resource="Schema1.class" />
 </session-factory>
</hibernate-configuration>  

And, i have saved it as UTF-8. when i run my program, however, i am getting the following message:

  org.hibernate.MappingException: Error reading resource: Schema1.class
at org.hibernate.cfg.Configuration.addResource(Configuration.java:447)
at org.hibernate.cfg.Configuration.parseMappingElement(Configuration.java:1381)
at org.hibernate.cfg.Configuration.parseSessionFactory(Configuration.java:1353)
at org.hibernate.cfg.Configuration.doConfigure(Configuration.java:1335)
at org.hibernate.cfg.Configuration.doConfigure(Configuration.java:1302)
at org.hibernate.cfg.Configuration.configure(Configuration.java:1230)
at org.hibernate.cfg.Configuration.configure(Configuration.java:1216)
at UpdateSchema.main(UpdateSchema.java:19)
Caused by: org.hibernate.MappingException: org.dom4j.DocumentException: Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.
at org.hibernate.cfg.Configuration.addInputStream(Configuration.java:403)
at org.hibernate.cfg.Configuration.addResource(Configuration.java:444)
... 7 more
Caused by: org.dom4j.DocumentException: Invalid byte 2 of 2-byte UTF-8 sequence. Nested exception: Invalid byte 2 of 2-byte UTF-8 sequence.
at org.dom4j.io.SAXReader.read(SAXReader.java:353)
at org.hibernate.cfg.Configuration.addInputStream(Configuration.java:393)
... 8 more  

What should i do? Kindly help.

Thanks,
Subhash

[Paul Sturrock]

<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE hibernate-configuration PUBLIC
"-//Hibernate/Hibernate Configuration DTD//EN"
"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
<session-factory>
<property name="hibernate.connection.driver_class">

com.mysql.jdbc.Driver</property>
<property name="hibernate.connection.url">

jdbc:mysql://localhost/hibernatetutorial</property>
<property name="hibernate.connection.username">root</property>
<property name="hibernate.connection.password">root</property>
<property name="hibernate.connection.pool_size">10</property>
<property name="show_sql">true</property>
<property name="dialect">org.hibernate.dialect.MySQLDialect</property>
<property name="hibernate.hbm2ddl.auto">update</property>
<!-- Persistent classes -->
<!-- <mapping class="Schema1" /> -->
<!-- Mapping files -->
<mapping resource="Schema1.hbm.xml"/>
<mapping resource="Schema1.class" />
</session-factory>
</hibernate-configuration>

Why are you mapping both the mapping file and the class? This may be frustrating to hear again, but I really strongly recommend you stop what you are doing and take a few moments to read the documentation. This is basic configuration; make sure you understand this concept before pushing on to more involved topics (otherwise you'll just have a horrible time trying to get this working).

And, i have saved it as UTF-8. when i run my program, however, i am getting the following message:

Ah. I was too quick to suggest its your mapping file - the non UTF-8 thing is the class file. Sort out your configuration and this error will go away.