impex:create

Full name:

org.kuali.maven.plugins:maven-impex-plugin:1.0.30:create

Description:

Authenticates to a database server using credentials with DBA authority and creates an empty database along with a default user for accessing the newly created database. See also impex:drop

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
command String - The database command to execute
Default value is: CREATE.
forceMojoExecution boolean - Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.
Default value is: false.

Optional Parameters

Name Type Since Description
append boolean - If writing output to a file, append to an existing file or overwrite it?
Default value is: false.
autocommit boolean - Set to true to execute non-transactional SQL.
Default value is: false.
database String - The name of the database to DROP/CREATE. If not specified, this defaults to a database name that is compatible with ${targetDatabase} based on platform specific logic that converts the artifact id.

For example:
ks-embedded-db is converted to KSEMBEDDED for Oracle, and ksembedded for MySQL)
databasePassword String - The password for the user that is DROPPED/CREATED. If not specified, this defaults to a password that is compatible with ${targetDatabase} based on platform specific logic that converts the artifact id.

For example:
ks-embedded-db is converted to KSEMBEDDED for Oracle, and ksembedded for MySQL
databaseUser String - The user to DROP/CREATE when issuing DBA commands for creating/dropping a user. If not specified, this defaults to a user that is compatible with ${targetDatabase} based on platform specific logic that converts the artifact id.

For example:
ks-embedded-db is converted to KSEMBEDDED for Oracle, and ksembedded for MySQL
dbaSettingsKey String - Lookup DBA credentials in settings.xml using this key. If nothing is found under impex.dba.${project.artifactId} a second attempt will be made to locate a set of credentials under impex.dba.${url}
Default value is: impex.dba.${project.artifactId}.
delimiter String - Set the delimiter that separates SQL statements.
Default value is: /.
delimiterType String - The delimiter type takes two values - "normal" and "row". Normal means that any occurrence of the delimiter terminate the SQL command whereas with row, only a line containing just the delimiter is recognized as the end of the command.

For example, set this to "go" and delimiterType to "row" for Sybase ASE or MS SQL Server.
Default value is: row.
driver String - Database driver classname. This parameter is optional, as the correct JDBC driver to use is detected from the url in almost all cases (works for Oracle, MySQL, Derby, PostGresSQL, DB2, H2, HSQL, SQL Server). If a driver is explicitly supplied, it will be used in place of the JDBC driver the automatic detection logic would have chosen.
driverProperties String - Additional key=value pairs separated by a comma to be passed to JDBC driver.
enableAnonymousPassword boolean - Ignore the password and use anonymous access.
Default value is: false.
enableAnonymousUsername boolean - Ignore the username and use anonymous access.
Default value is: false.
encoding String - The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on.
Default value is: ${project.build.sourceEncoding}.
escapeProcessing boolean - Argument to Statement.setEscapeProcessing If you want the driver to use regular SQL syntax then set this to false.
Default value is: true.
keepFormat boolean - Keep the format of an SQL block.
Default value is: true.
onError String - Action to perform if an error is found. Possible values are abort and continue.
Default value is: abort.
password String - Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
serverUrl String - URL to connect directly to the database server itself (ie: no database specified). This is optional as it is automatically detected in almost all cases from the url. If serverUrl is explicitly supplied it overrides the serverUrl chosen by the automatic detection logic.
settingsKey String - The id of the server in settings.xml containing the username/password to use.
Default value is: impex.${project.artifactId}.
showPassword boolean - If set to true the password being used to connect to the database will be displayed in log messages.
Default value is: false.
showheaders boolean - Print header columns.
Default value is: true.
skip boolean - When true, skip the execution of this mojo
Default value is: false.
skipOnConnectionError boolean - Skip execution if there is an error obtaining a connection. If this is set to true, the build will continue even if there is an error obtaining a connection
Default value is: false.
sqlCommand String - SQL input commands separated by ${delimiter}.
srcFiles File[] - List of files containing SQL statements to load.
startMavenLogger boolean - When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system
Default value is: true.
targetDatabase String - The type of database we are targeting (eg oracle, mysql). This is optional if url is supplied as the database type will be automatically detected based on the url. If targetDatabase is explicitly supplied it will override the type selected by the automatic detection logic.
url String - Database URL.
username String - Database username. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.

Parameter Details

append:

If writing output to a file, append to an existing file or overwrite it?
  • Type: boolean
  • Required: No
  • Expression: ${append}
  • Default: false

autocommit:

Set to true to execute non-transactional SQL.
  • Type: boolean
  • Required: No
  • Expression: ${autocommit}
  • Default: false

command:

The database command to execute
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${command}
  • Default: CREATE

database:

The name of the database to DROP/CREATE. If not specified, this defaults to a database name that is compatible with ${targetDatabase} based on platform specific logic that converts the artifact id.

For example:
ks-embedded-db is converted to KSEMBEDDED for Oracle, and ksembedded for MySQL)
  • Type: java.lang.String
  • Required: No
  • Expression: ${database}

databasePassword:

The password for the user that is DROPPED/CREATED. If not specified, this defaults to a password that is compatible with ${targetDatabase} based on platform specific logic that converts the artifact id.

For example:
ks-embedded-db is converted to KSEMBEDDED for Oracle, and ksembedded for MySQL
  • Type: java.lang.String
  • Required: No
  • Expression: ${databasePassword}

databaseUser:

The user to DROP/CREATE when issuing DBA commands for creating/dropping a user. If not specified, this defaults to a user that is compatible with ${targetDatabase} based on platform specific logic that converts the artifact id.

For example:
ks-embedded-db is converted to KSEMBEDDED for Oracle, and ksembedded for MySQL
  • Type: java.lang.String
  • Required: No
  • Expression: ${databaseUser}

dbaSettingsKey:

Lookup DBA credentials in settings.xml using this key. If nothing is found under impex.dba.${project.artifactId} a second attempt will be made to locate a set of credentials under impex.dba.${url}
  • Type: java.lang.String
  • Required: No
  • Expression: ${dbaSettingsKey}
  • Default: impex.dba.${project.artifactId}

delimiter:

Set the delimiter that separates SQL statements.
  • Type: java.lang.String
  • Required: No
  • Expression: ${delimiter}
  • Default: /

delimiterType:

The delimiter type takes two values - "normal" and "row". Normal means that any occurrence of the delimiter terminate the SQL command whereas with row, only a line containing just the delimiter is recognized as the end of the command.

For example, set this to "go" and delimiterType to "row" for Sybase ASE or MS SQL Server.
  • Type: java.lang.String
  • Required: No
  • Expression: ${delimiterType}
  • Default: row

driver:

Database driver classname. This parameter is optional, as the correct JDBC driver to use is detected from the url in almost all cases (works for Oracle, MySQL, Derby, PostGresSQL, DB2, H2, HSQL, SQL Server). If a driver is explicitly supplied, it will be used in place of the JDBC driver the automatic detection logic would have chosen.
  • Type: java.lang.String
  • Required: No
  • Expression: ${driver}

driverProperties:

Additional key=value pairs separated by a comma to be passed to JDBC driver.
  • Type: java.lang.String
  • Required: No
  • Expression: ${driverProperties}

enableAnonymousPassword:

Ignore the password and use anonymous access.
  • Type: boolean
  • Required: No
  • Expression: ${enableAnonymousPassword}
  • Default: false

enableAnonymousUsername:

Ignore the username and use anonymous access.
  • Type: boolean
  • Required: No
  • Expression: ${enableAnonymousUsername}
  • Default: false

encoding:

The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

escapeProcessing:

Argument to Statement.setEscapeProcessing If you want the driver to use regular SQL syntax then set this to false.
  • Type: boolean
  • Required: No
  • Expression: ${escapeProcessing}
  • Default: true

forceMojoExecution:

Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.
  • Type: boolean
  • Required: Yes
  • Expression: ${forceMojoExecution}
  • Default: false

keepFormat:

Keep the format of an SQL block.
  • Type: boolean
  • Required: No
  • Expression: ${keepFormat}
  • Default: true

onError:

Action to perform if an error is found. Possible values are abort and continue.
  • Type: java.lang.String
  • Required: No
  • Expression: ${onError}
  • Default: abort

password:

Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
  • Type: java.lang.String
  • Required: No
  • Expression: ${password}

serverUrl:

URL to connect directly to the database server itself (ie: no database specified). This is optional as it is automatically detected in almost all cases from the url. If serverUrl is explicitly supplied it overrides the serverUrl chosen by the automatic detection logic.
  • Type: java.lang.String
  • Required: No
  • Expression: ${serverUrl}

settingsKey:

The id of the server in settings.xml containing the username/password to use.
  • Type: java.lang.String
  • Required: No
  • Expression: ${settingsKey}
  • Default: impex.${project.artifactId}

showPassword:

If set to true the password being used to connect to the database will be displayed in log messages.
  • Type: boolean
  • Required: No
  • Expression: ${showPassword}
  • Default: false

showheaders:

Print header columns.
  • Type: boolean
  • Required: No
  • Expression: ${showheaders}
  • Default: true

skip:

When true, skip the execution of this mojo
  • Type: boolean
  • Required: No
  • Default: false

skipOnConnectionError:

Skip execution if there is an error obtaining a connection. If this is set to true, the build will continue even if there is an error obtaining a connection
  • Type: boolean
  • Required: No
  • Expression: ${skipOnConnectionError}
  • Default: false

sqlCommand:

SQL input commands separated by ${delimiter}.
  • Type: java.lang.String
  • Required: No
  • Expression: ${sqlCommand}

srcFiles:

List of files containing SQL statements to load.
  • Type: java.io.File[]
  • Required: No
  • Expression: ${srcFiles}

startMavenLogger:

When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system
  • Type: boolean
  • Required: No
  • Expression: ${startMavenLogger}
  • Default: true

targetDatabase:

The type of database we are targeting (eg oracle, mysql). This is optional if url is supplied as the database type will be automatically detected based on the url. If targetDatabase is explicitly supplied it will override the type selected by the automatic detection logic.
  • Type: java.lang.String
  • Required: No
  • Expression: ${targetDatabase}

url:

Database URL.
  • Type: java.lang.String
  • Required: No
  • Expression: ${url}

username:

Database username. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
  • Type: java.lang.String
  • Required: No
  • Expression: ${username}