README.md

postgresql-maven-plugin

A Maven plugin for controlling PostgreSQL. There are goals for starting, stopping, initializing a DB, etc. The main purpose is running integration tests.

The project is in a very early stage. It requires JDK 7 to run. Currently there are 6 goals with very few options.

Usage example:

<plugin>
    <groupId>com.github.adrianboimvaser</groupId>
    <artifactId>postgresql-maven-plugin</artifactId>
    <version>0.2-SNAPSHOT</version>
    <configuration>
        <pgsqlHome>${project.build.directory}/pgsql</pgsqlHome>
        <dataDir>${project.build.directory}/data</dataDir>
        <skip>${skipITs}</skip>
        <databaseName>postgres</databaseName>
        <username>postgres</username>
    </configuration>
    <executions>
        <execution>
            <id>version-check</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>version</goal>
            </goals>
            <configuration>
                <mandatoryVersionRange>[9.2,)</mandatoryVersionRange>
            </configuration>
        </execution>
        <execution>
            <id>init-db</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>initdb</goal>
            </goals>
            <configuration>
                <username>postgres</username>
                <passwordFile>${basedir}/password.txt</passwordFile>
                <encoding>UTF8</encoding>
                <locale>en_US</locale>
            </configuration>
        </execution>
        <execution>
            <id>start-postgresql</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>start</goal>
            </goals>
        </execution>
        <execution>
            <id>create-db</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>createdb</goal>
            </goals>
            <configuration>
                <username>postgres</username>
                <databaseName>products</databaseName>
            </configuration>
        </execution>
        <execution>
            <id>drop-db</id>
            <phase>pre-integration-test</phase>
            <goals>
                <goal>dropdb</goal>
            </goals>
            <configuration>
                <username>postgres</username>
                <databaseName>products</databaseName>
            </configuration>
        </execution>
        <execution>
            <id>stop-postgresql</id>
            <phase>post-integration-test</phase>
            <goals>
                <goal>stop</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Goals

1. version -- display (and enforce) version information
2. initdb -- initialize a database root (cluster)
3. start -- start the server
4. createdb -- connect to the server and create a database
5. dropdb -- connect to the server and drop a database
6. stop -- stop the server