Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.82 KB

quickstart.markdown

File metadata and controls

78 lines (53 loc) · 3.82 KB
Raw

====== Liquibase Quick-Start ======

===== Step 1: Create a Changelog File: =====

The [[manual/databasechangelog|database changelog file]] is where all database changes are listed. It is XML based, so start with an empty XML file:

===== Step 2: Add a ChangeSet =====

Each [[manual/changeset|change set]] is uniquely identified by an "id" attribute and an "author" attribute. These two tags, along with the name and package of the changelog file uniquely identify the change. If only an "id" needed to be specified, it would be too easy to accidentally duplicate them, especially when dealing with multiple developers and code branches. Including an "author" attribute minimizes the chances of duplications.

Think of each change set as an atomic change that you want to apply to your database. It's usually best to include just one change in your change set, but more are allowed and can make sense if you are inserting multiple rows that should be added as a single transaction. Liquibase will attempt to run each change set as a single transaction, but many databases will silently commit and resume transactions for certain commands (create table, drop table, etc.)

<changeSet id="1" author="bob">
    <createTable tableName="department">
        <column name="id" type="int">
            <constraints primaryKey="true" nullable="false"/>
        </column>
        <column name="name" type="varchar(50)">
            <constraints nullable="false"/>
        </column>
        <column name="active" type="boolean" defaultValueBoolean="true"/>
    </createTable>
</changeSet>

===== Step 3: Run the ChangeSet =====

There are many ways to execute your change log including via [[manual/command line]], [[manual/Ant]], [[manual/Maven]], [[manual/Grails]], Spring and a [[manual/servlet listener]].

Here is an example for mysql via jdbc:

liquibase --driver=com.mysql.jdbc.Driver \ --classpath=/path/to/classes \ --changeLogFile=com/example/db.changelog.xml \ --url="jdbc:mysql://localhost/example" \ --username=user \ --password=asdf \ migrate

There are many more databases supported by liquibase. For a list of them and which jdbc driver, url, classpath etc. they need, please visit the [[databases]] section.

===== Step 4: Check Your Database =====

You will see that your database now contains a table called "department". Two other tables are created as well: "databasechangelog" and "databasechangeloglock". The databasechangelog table contains a list of all the statements that have been run against the database. The databasechangeloglock table is used to make sure two machines don't attempt to modify the database at the same time.

===== Next Steps =====

This quick-start guide is designed to get you started with Liquibase. For a full description of all its capabilities, see the [[manual/home|Liquibase Manual]]. Read [[bestpractices|the best practices]]. For an extensive scenario, see the [[tutorial-using-oracle|tutorial using Oracle]].

You can also view [[training|recorded sessions]] on Liquibase or visit the [[community|forums]].