zonky:start

Full name:

de.funfried.maven.plugins:zonky-maven-plugin:0.7-SNAPSHOT:start

Description:

Goal which starts an embedded postgres database.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: initialize.

Optional Parameters

Name Type Since Description
<createDatabase> boolean - If true, a create database statement with the given database name will be executed on startup.
Default: true
User Property: createDatabase
<dataDirectory> String - The data directory for the embedded database.
Default: ${project.build.directory}/embedded-postgres/data
User Property: dataDirectory
<databaseName> String - The database name to write your data. Should not be postgres!
Default: data
User Property: databaseName
<onAlreadyStarted> AlreadyStartedPolicy - Define what should be done when the database is already started and the start goal is called again. Choose between:
  • fail (lets the build fail)
  • reinit (drops the database and if "createDatabase" is true recreates the database again)
  • restart (stops the database and starts it again)
  • ignore (just keeps the current database and does not start a new one)

Default: reinit
User Property: onAlreadyStarted
<port> int - The port on which the database will be accessible. A value less than or equal to 0 means auto detect a free port. The port is available through the property ${zonky.port}.
Default: 0
User Property: port
<singleInstance> boolean - If true, only one database instance is used for all multimodule projects, otherwise all projects get their own instance.
Default: true
User Property: singleInstance
<workingDirectory> String - The working directory for the embedded database.
Default: ${project.build.directory}/embedded-postgres/work
User Property: workingDirectory

Parameter Details

<createDatabase>

If true, a create database statement with the given database name will be executed on startup.
  • Type: boolean
  • Required: No
  • User Property: createDatabase
  • Default: true

<dataDirectory>

The data directory for the embedded database.
  • Type: java.lang.String
  • Required: No
  • User Property: dataDirectory
  • Default: ${project.build.directory}/embedded-postgres/data

<databaseName>

The database name to write your data. Should not be postgres!
  • Type: java.lang.String
  • Required: No
  • User Property: databaseName
  • Default: data

<onAlreadyStarted>

Define what should be done when the database is already started and the start goal is called again. Choose between:
  • fail (lets the build fail)
  • reinit (drops the database and if "createDatabase" is true recreates the database again)
  • restart (stops the database and starts it again)
  • ignore (just keeps the current database and does not start a new one)
  • Type: de.funfried.maven.plugin.zonky.utils.AlreadyStartedPolicy
  • Required: No
  • User Property: onAlreadyStarted
  • Default: reinit

<port>

The port on which the database will be accessible. A value less than or equal to 0 means auto detect a free port. The port is available through the property ${zonky.port}.
  • Type: int
  • Required: No
  • User Property: port
  • Default: 0

<singleInstance>

If true, only one database instance is used for all multimodule projects, otherwise all projects get their own instance.
  • Type: boolean
  • Required: No
  • User Property: singleInstance
  • Default: true

<workingDirectory>

The working directory for the embedded database.
  • Type: java.lang.String
  • Required: No
  • User Property: workingDirectory
  • Default: ${project.build.directory}/embedded-postgres/work