web-dev-qa-db-ja.com

JPAアノテーション付きエンティティクラスからデータスキーマを自動生成

JPA（Hibernateの実装）を使用してエンティティクラスに注釈を付け、リレーショナルデータベース（MySQLまたはSQL Server）に永続化しています。注釈付きクラスからデータベーススキーマ（テーブル作成スクリプト）を自動生成する簡単な方法はありますか？

私はまだプロトタイプ作成段階にあり、頻繁にスキーマが変更されることを予想しています。注釈付きコードからデータモデルを指定および変更できるようにしたいと思います。 Grailsは、ドメインクラスからデータベースを生成するという点で似ています。

javadatabasehibernatejpajava-ee
41
Steve Kuo

Hibernateから hbm2ddl を使用できます。ドキュメントは here です。

14
Vincent Ramdhanie

指定されたJPAエンティティの作成およびドロップスクリプトを生成

このコードを使用して、dropおよびcreateステートメントを生成します。すべてのエンティティクラスでこのクラスを構築し、create/dropTableScriptを呼び出します。

必要に応じて、代わりにpersitence.xmlおよびパーシスタンスユニット名を使用できます。何か言うだけで、私もコードを投稿します。

import Java.util.Collection;
import Java.util.Properties;

import org.hibernate.cfg.AnnotationConfiguration;
import org.hibernate.dialect.Dialect;
import org.hibernate.ejb.Ejb3Configuration;

/**
 * SQL Creator for Tables according to JPA/Hibernate annotations.
 *
 * Use:
 *
 * {@link #createTablesScript()} To create the table creationg script
 *
 * {@link #dropTablesScript()} to create the table destruction script
 * 
 */
public class SqlTableCreator {

    private final AnnotationConfiguration hibernateConfiguration;
    private final Properties dialectProps;

    public SqlTableCreator(final Collection<Class<?>> entities) {

        final Ejb3Configuration ejb3Configuration = new Ejb3Configuration();
        for (final Class<?> entity : entities) {
            ejb3Configuration.addAnnotatedClass(entity);
        }

        dialectProps = new Properties();
        dialectProps.put("hibernate.dialect", "org.hibernate.dialect.SQLServerDialect");

        hibernateConfiguration = ejb3Configuration.getHibernateConfiguration();
    }

    /**
     * Create the SQL script to create all tables.
     * 
     * @return A {@link String} representing the SQL script.
     */
    public String createTablesScript() {
        final StringBuilder script = new StringBuilder();

        final String[] creationScript = hibernateConfiguration.generateSchemaCreationScript(Dialect
                .getDialect(dialectProps));
        for (final String string : creationScript) {
            script.append(string).append(";\n");
        }
        script.append("\ngo\n\n");

        return script.toString();
    }

    /**
     * Create the SQL script to drop all tables.
     * 
     * @return A {@link String} representing the SQL script.
     */
    public String dropTablesScript() {
        final StringBuilder script = new StringBuilder();

        final String[] creationScript = hibernateConfiguration.generateDropSchemaScript(Dialect
                .getDialect(dialectProps));
        for (final String string : creationScript) {
            script.append(string).append(";\n");
        }
        script.append("\ngo\n\n");

        return script.toString();
    }
}
13
H2000

関連するメモ：EclipseLink JPAを使用してデータベーススキーマを生成するためのドキュメントは、 here にあります。

9
hohonuuli

Hibernate 4.3+はJPA 2.1を実装するようになったため、DDLスクリプトを生成する適切な方法は、次の一連のJPA 2.1プロパティを使用することです。

<property name="javax.persistence.schema-generation.scripts.action" value="create"/>
<property name="javax.persistence.schema-generation.create-source" value="metadata"/>
<property name="javax.persistence.schema-generation.scripts.create-target" value="target/jpa/sql/create-schema.sql"/>

実行時に実行されるため、ビルド時にこのDDL生成を実行できます。 おそらくHibernateチームがGradleに移行しているため、Hibernate4でサポートされている公式のMavenプラグインはもうありません。

とにかく、これはこのスクリプトをプログラムで生成するJPA 2.1のアプローチです。

import Java.io.IOException;
import Java.util.Properties;

import javax.persistence.Persistence;

import org.hibernate.jpa.AvailableSettings;

public class JpaSchemaExport {

    public static void main(String[] args) throws IOException {
        execute(args[0], args[1]);
        System.exit(0);
    }

    public static void execute(String persistenceUnitName, String destination) {
        System.out.println("Generating DDL create script to : " + destination);

        final Properties persistenceProperties = new Properties();

        // XXX force persistence properties : remove database target
        persistenceProperties.setProperty(org.hibernate.cfg.AvailableSettings.HBM2DDL_AUTO, "");
        persistenceProperties.setProperty(AvailableSettings.SCHEMA_GEN_DATABASE_ACTION, "none");

        // XXX force persistence properties : define create script target from metadata to destination
        // persistenceProperties.setProperty(AvailableSettings.SCHEMA_GEN_CREATE_SCHEMAS, "true");
        persistenceProperties.setProperty(AvailableSettings.SCHEMA_GEN_SCRIPTS_ACTION, "create");
        persistenceProperties.setProperty(AvailableSettings.SCHEMA_GEN_CREATE_SOURCE, "metadata");
        persistenceProperties.setProperty(AvailableSettings.SCHEMA_GEN_SCRIPTS_CREATE_TARGET, destination);

        Persistence.generateSchema(persistenceUnitName, persistenceProperties);
    }

}

ご覧のとおり、非常に簡単です！

これをAntTaskで使用したり、MAVENビルドを次のようにしたりできます（MAVENの場合）。

            <plugin>
                <artifactId>maven-antrun-plugin</artifactId>
                <version>1.7</version>
                <executions>
                    <execution>
                        <id>generate-ddl-create</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                        <configuration>
                            <target>
                                <!-- ANT Task definition -->
                                <Java classname="com.orange.tools.jpa.JpaSchemaExport"
                                    fork="true" failonerror="true">
                                    <arg value="${persistenceUnitName}" />
                                    <arg value="target/jpa/sql/schema-create.sql" />
                                    <!-- reference to the passed-in classpath reference -->
                                    <classpath refid="maven.compile.classpath" />
                                </Java>
                            </target>
                        </configuration>

                    </execution>
                </executions>
            </plugin>
8
Donatello

Hibernate SchemaExportクラスを使用して正確に必要なことを行う方法について説明します。

http://jandrewthompson.blogspot.com/2009/10/how-to-generate-ddl-scripts-from.html

6
Andrew Thompson

Springでの構成を希望する場合、これは役立つはずです。

 <!-- CONTAINER-MANAGED JPA Entity manager factory (No need for persistence.xml)-->
    <bean id="emf" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="jpaVendorAdapter" ref="jpaVendorAdapter"/>
    <!-- Fine Grained JPA properties Create-Drop Records -->
    <property name="jpaProperties">
    <props>
    <prop key="hibernate.hbm2ddl.auto">create</prop>
    </props>
    </property> 
    </bean> 
     <!-- The JPA vendor -->
    <bean id="jpaVendorAdapter" class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
    <!-- <property name="database" value="MySQL"/> -->
    <property name="showSql" value="true"/>
    <!--  <property name="generateDdl" value="true"/>  -->
    <property name="databasePlatform" value="org.hibernate.dialect.MySQLDialect"/>      
    </bean> 
     <bean id="transactionManager" class="org.springframework.orm.jpa.JpaTransactionManager">
        <property name="entityManagerFactory" ref="emf" />
     </bean>
2
George Papatheodorou

これを実現するには、mavenプラグインを使用できます。

       <plugin>
            <!-- run command "mvn hibernate3:hbm2ddl" to generate DLL -->
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>hibernate3-maven-plugin</artifactId>
            <version>3.0</version>
            <configuration>
                <hibernatetool>
                    <classpath>
                        <path location="${project.build.directory}/classes" />
                        <path location="${project.basedir}/src/main/resources/META-INF/" />                                               
                    </classpath>   

                    <jpaconfiguration persistenceunit="galleryPersistenceUnit" />                     
                    <hbm2ddl create="true" export="false" destdir="${project.basedir}/target" drop="true" outputfilename="mysql.sql" format="true" console="true"/>
                </hibernatetool>
            </configuration>
        </plugin>
2
sendon1982

EclipseLinkでは、プロパティを追加する必要があります。

<property name="eclipselink.ddl-generation" value="create-tables"/>

ここにあるように： http://www.Eclipse.org/eclipselink/documentation/2.4/jpa/extensions/p_ddl_generation.htm

私のpersistence.xml：

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.1" xmlns="http://xmlns.jcp.org/xml/ns/persistence"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_2_1.xsd">
    <persistence-unit name="appDB" transaction-type="JTA">
        <provider>org.Eclipse.persistence.jpa.PersistenceProvider</provider>
        <jta-data-source>LocalMySQL</jta-data-source>
        <class>entity.Us</class>
        <class>entity.Btl</class>
        <class>entity.Co</class>
        <properties>
            <property name="eclipselink.ddl-generation" value="create-tables"/>
        </properties>
    </persistence-unit>
</persistence>
1
Krystian
<property name="hibernate.hbm2ddl.auto" value="update"/>

プロパティタグの下のpersistence.xmlに上記のコードを追加します。 「更新」は、コードを初めて実行したときにテーブルを作成し、その後、ドメインオブジェクトに変更があった場合にのみテーブル構造を更新します。

1
sendon1982