$title

## ## Licensed to the Apache Software Foundation (ASF) under one ## or more contributor license agreements. See the NOTICE file ## distributed with this work for additional information ## regarding copyright ownership. The ASF licenses this file ## to you under the Apache License, Version 2.0 (the ## "License"); you may not use this file except in compliance ## with the License. You may obtain a copy of the License at ## ## http://www.apache.org/licenses/LICENSE-2.0 ## ## Unless required by applicable law or agreed to in writing, ## software distributed under the License is distributed on an ## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY ## KIND, either express or implied. See the License for the ## specific language governing permissions and limitations ## under the License. ## ## ## This is an Velocity template for generating the overview page $title

$title - Documentation

DdlUtils comes with two Ant tasks that allow you to manipulate the database structure, insert data into the database, dump the database structure and data contained in it, to XML, etc.

Using the Tasks

Lets see examples for how to use them:

<path id="runtime-classpath">
  <fileset dir="lib">
    <include name="**/*.jar"/>
    <include name="**/*.zip"/>

  </fileset>
</path>


<target name="database-setup"
        description="Creates the database structure and inserts data into the database">
  <taskdef name="ddlToDatabase"
           classname="org.apache.ddlutils.task.DdlToDatabaseTask">
    <classpath refid="runtime-classpath"/>
  </taskdef>

  <ddlToDatabase>
    <database url="jdbc:postgresql://localhost/test"
              driverClassName="org.postgresql.Driver"
              username="someuser"
              password="somepassword"/>
    <fileset dir="src/schema">
      <include name="project-schema.xml"/>
    </fileset>

    <createDatabase failonerror="false"/>

    <writeSchemaToDatabase/> 
    <writeDataToDatabase datafile="src/data/data.xml"/> 
  </ddlToDatabase>
</target>

This snippet essentially uses the DdlToDatabaseTask task to create a PostgreSQL database at //localhost/test, establish the database structure (tables, foreign keys etc.) defined in the file src/schema/project-schema.xml in this new database, and then insert the data contained in src/data/data.xml.

In order for this to work, both DdlUtils and the JDBC driver have to be available in the path specified by runtime-classpath. In the above snippet, this path contains all JARs and ZIPs in sub-directory lib.

Note

Not every database platform supports creation of new databases via JDBC. Please refer to the documentation here for details of what is supported with individual databases.

The opposite direction is achieved via the DatabaseToDdlTask task:

<path id="runtime-classpath">
  <fileset dir="lib">
    <include name="**/*.jar"/>

    <include name="**/*.zip"/>
  </fileset>
</path>

<target name="database-dump" description="Dumps the database structure">
  <taskdef name="databaseToDdl"
           classname="org.apache.ddlutils.task.DatabaseToDdlTask">
    <classpath refid="runtime-classpath"/>

  </taskdef>
  <databaseToDdl modelName="MyModel">
    <database url="jdbc:derby:ddlutils"
              driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
              username=""
              password=""/>

    <writeSchemaToFile outputFile="db-schema.xml"/>
    <writeDataToFile outputFile="data.xml"/>
  </databaseToDdl>

</target>

Here, the database schema is retrieved using the specified JDBC driver, and then written to the file db-schema.xml. Likewise, the data in the database is written to the file data.xml.

Requirements

The DdlUtils tasks require Ant version 1.5 or newer.

Reference

The reference documentation for the Ant tasks can be found here.