Home > Articles > Programming

📄 Contents

  1. Updating an Existing Schema
  2. Generating Update and Drop Scripts
  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

Generating Update and Drop Scripts

Hibernate also includes the net.sf.hibernate.tool.hbm2ddl .SchemaExport tool, which allows you to generate scripts for generating a schema (optionally generating DROP statements as well). The SchemaExport tool has several advantages over the SchemaUpdate:

  • It can be run at development time, even if you don't have access to the target database.
  • It doesn't rely on driver metadata.
  • It may be necessary if your application's database connection is not allowed to perform DDL.
  • It allows you to send the application's database requirements to a database administrator.

Like SchemaUpdate, SchemaExport can be run from the command line or from Ant. An example is also shown of how to use SchemaExport to simultaneously generate scripts for several databases.

Command-Line Script Generation

You can run SchemaExport from the command line using the command java net.sf.hibernate.tool.hbm2ddl.SchemaExport options mapping_files. The possible options are as shown in Table 11.2.

Table 11.2. SchemaExport Command-Line Options

Option

Description

--quiet

Don't output the script to the console.

--drop

Only generate drop-table statements.

--text

Generate script but don't perform against the database.

--output=my_schema.sql

Specify the file name to output the script.

--config=hibernate.cfg.xml

Specify the Hibernate configuration XML file.

--properties=hibernate.properties

Specify the Hibernate configuration properties from a file.

--format

Format the generated SQL nicely in the script.

--delimiter=;

Set an end-of-line delimiter for the script.

Ant Task Script Generation

Listing 11.3 shows an Ant task that can be used to generate a script. The meaning of the options is as shown in Table 11.2.

Example 11.3. SchemaExport Ant Task

<target name="schemaexport">
    <taskdef name="schemaexport"
        classname="net.sf.hibernate.tool.hbm2ddl
             .SchemaExportTask"
        classpathref="class.path"/>

    <schemaexport
        properties="hibernate.properties"
        quiet="no"
        text="no"
        drop="no"
        delimiter=";"
        output="schema-export.sql">
        <fileset dir="src">
            <include name="**/*.hbm.xml"/>
        </fileset>
    </schemaexport>
</target>

Generating Multiple Scripts

Hibernate has the advantageous ability of making it easier to support a wide range of databases. By taking advantage of SchemaExport, you can generate schema generation scripts for a wide variety of databases at development time and include them in the application distribution. This is obviously no substitute for testing, as Hibernate relies on the underlying database for a wide variety of features, but it can be helpful if you are interested in using an application with a new database.

Table 6.5 shows the list of dialects included with Hibernate 2.1.2. The sample code shown in Listing 11.4 takes advantage of this list to generate a set of schema generation scripts for a wide suite of databases. The suite of dialects is looped through, with an attempt made to generate scripts for the sample application shown in Chapter 3.

Example 11.4. Generating Multiple Scripts

package com.cascadetg.ch11;

/** Various Hibernate-related imports */
import net.sf.hibernate.*;
import net.sf.hibernate.cfg.*;
import net.sf.hibernate.tool.hbm2ddl.SchemaExport;
import java.util.Properties;

public class SchemaGeneratorExample
{
    // System constants for the current platform directory
         token
    static String fileSep =
         System.getProperty("file.separator");

    /** We use this session factory to create our sessions */
    public static SessionFactory sessionFactory;

    static String[] db_dialects =
    { "DB2", //
            "net.sf.hibernate.dialect.DB2Dialect", //
            "DB2400", //
            "net.sf.hibernate.dialect.DB2400Dialect", //
            "Firebird", //
            "net.sf.hibernate.dialect.FirebirdDialect", //
            "FrontBase", //
            "net.sf.hibernate.dialect.FrontBaseDialect", //
            "Generic", //
            "net.sf.hibernate.dialect.GenericDialect", //
            "HypersonicSQL", //
            "net.sf.hibernate.dialect.HSQLDialect", //
            "Informix", //
            "net.sf.hibernate.dialect.InformixDialect", //
            "Informix9", //
            "net.sf.hibernate.dialect.Informix9Dialect", //
            "Ingres", //
            "net.sf.hibernate.dialect.IngresDialect", //
            "Interbase", //
            "net.sf.hibernate.dialect.InterbaseDialect", //
            "Mckoi SQL", //
            "net.sf.hibernate.dialect.MckoiDialect", //
            "Microsoft SQL Server", //
            "net.sf.hibernate.dialect.SQLServerDialect", //
            "MySQL", //
            "net.sf.hibernate.dialect.MySQLDialect", //
            "Oracle 9", //
            "net.sf.hibernate.dialect.Oracle9Dialect", //
            "Oracle", //
            "net.sf.hibernate.dialect.OracleDialect", //
            "Pointbase", //
            "net.sf.hibernate.dialect.PointbaseDialect", //
            "PostgreSQL", //
            "net.sf.hibernate.dialect.PostgreSQLDialect", //
            "Progress", //
            "net.sf.hibernate.dialect.ProgressDialect", //
            "SAP DB", //
            "net.sf.hibernate.dialect.SAPDBDialect", //
            "Sybase Anywhere", //
            "net.sf.hibernate.dialect.SybaseAnywhereDialect",
            "Sybase 11.9.2", //
            "net.sf.hibernate.dialect.Sybase11_9_2Dialect", //
            "Sybase", //
            "net.sf.hibernate.dialect.SybaseDialect",};

    public static void main(String[] args)
    {
        initialization();
    }

    /**
     * Loads the Hibernate configuration information, sets up the
     * database and the Hibernate session factory.
     */
    public static void initialization()
    {
        System.out.println("initialization");
        try
        {
            Configuration myConfiguration = new
                 Configuration();

            myConfiguration
                    .addClass(com.cascadetg.ch03.Owner.class);
            myConfiguration
                    .addClass(com.cascadetg.ch03.Artifact
                         .class);

            Properties myProperties = new Properties();

            for (int i = 0; i < db_dialects.length; i = i + 2)
            {
                String dialect_name = db_dialects[i];
                String dialect_class = db_dialects[i + 1];

                String dialect_file =
                     dialect_name.toLowerCase();
                dialect_file = dialect_file.replace(' ', '_');
                dialect_file += (".sql");

                String path = "com" + fileSep + "cascadetg"
                        + fileSep + "ch11" + fileSep;

                System.out.println("Generating " +
                     dialect_name);

                // Note that this is the only Hibernate property
                // set.  In particular, there is no JDBC
                // connectivity data, nor are we specifying a
                // driver!
                myProperties.put("hibernate.dialect",
                        dialect_class);
                try
                {
                    // Load the *.hbm.xml files as set in the
                    // config, and set the dialect.
                    SchemaExport mySchemaExport = new
                         SchemaExport(
                            myConfiguration, myProperties);

                    mySchemaExport.setDelimiter(";");

                    // Despite the name, the generated create
                    // scripts WILL include drop statements at
                    // the top of the script!
                    mySchemaExport.setOutputFile(path + "create_"
                            + dialect_file);
                    mySchemaExport.create(false, false) ;

                    // Generates DROP statements only
                    mySchemaExport.setOutputFile(path + "drop_"
                            + dialect_file);
                    mySchemaExport.drop(false, false);

                    System.out.println(dialect_name + " OK.");

                } catch (Exception e)
                {
                    System.out.println(e.getMessage());
                }
            }

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

Running the application in Listing 11.4 produces the results shown in Listing 11.5. As can be seen, the native identity generator is not supported by many databases. For broader support, a Hibernate-driven identity generator would be a better choice to support a wider range of databases (for more information on identity generation, see Chapter 6). Figure 11.1 shows the resulting schema script files.

Example 11.5. Generating Multiple Scripts

initialization
Generating DB2
DB2 OK.
Generating DB2400
DB2400 OK.
Generating Firebird
Dialect does not support identity-key generation
Generating FrontBase
Dialect does not support identity-key generation
Generating Generic
Dialect does not support identity-key generation
Generating HypersonicSQL
HypersonicSQL OK.
Generating Informix
Informix OK.
Generating Informix9
Informix9 OK.
Generating Ingres
Dialect does not support identity-key generation
Generating Interbase
Dialect does not support identity-key generation
Generating Mckoi SQL
Dialect does not support identity-key generation
Generating Microsoft SQL Server
Microsoft SQL Server OK.
Generating MySQL
MySQL OK.
Generating Oracle 9
Dialect does not support identity-key generation
Generating Oracle
Dialect does not support identity-key generation
Generating Pointbase
Dialect does not support identity-key generation
Generating PostgreSQL
Dialect does not support identity-key generation
Generating Progress
Dialect does not support identity-key generation
Generating SAP DB
Dialect does not support identity-key generation
Generating Sybase Anywhere
Sybase Anywhere OK.
Generating Sybase 11.9.2
Sybase 11.9.2 OK.
Generating Sybase
Sybase OK.
11fig01.gif

Figure 11.1 Generated Schema Scripts

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020