Fork me on GitHub

sql:execute

Full name:

org.codehaus.mojo:sql-maven-plugin:3.0.0-SNAPSHOT:execute

Description:

Executes SQL against a database.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
driver String 1.0 Database driver classname.
User property is: driver.
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.
User property is: forceOpenJpaExecution.
url String 1.0-beta-1 Database URL.
User property is: url.

Optional Parameters

Name Type Since Description
autocommit boolean 1.0 Set to true to execute none-transactional SQL.
Default value is: false.
User property is: autocommit.
delimiter String 1.0 Set the delimiter that separates SQL statements.
Default value is: ;.
User property is: delimiter.
delimiterType String 1.2

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: normal.
User property is: delimiterType.
driverProperties String 1.0 Additional key=value pairs separated by comma to be passed into JDBC driver.
User property is: driverProperties.
enableAnonymousPassword boolean 1.4 Ignore the password and use anonymous access. This may be useful for databases like MySQL which do not allow empty password parameters in the connection initialization.
Default value is: false.
enableFiltering boolean 1.4 Set to true if you want to filter the srcFiles using system-, user- and project properties
Default value is: false.
User property is: enableFiltering.
encoding String 1.1 Encoding to use when reading SQL statements from a file.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
escapeProcessing boolean 1.4 Argument to Statement.setEscapeProcessing If you want the driver to use regular SQL syntax then set this to false.
Default value is: true.
User property is: escapeProcessing.
fileset Fileset 1.0 File(s) containing SQL statements to load. Only use a Fileset if you want to use ant-like filepatterns, otherwise use srcFiles. The order is based on a matching occurrence while scanning the directory (not the order of includes!).
keepFormat boolean 1.1 Keep the format of an SQL block.
Default value is: false.
User property is: keepFormat.
onError String 1.0 Action to perform if an error is found. Possible values are abort and continue.
Default value is: abort.
User property is: onError.
orderFile String 1.1 Set the order in which the SQL files will be executed. Possible values are ascending and descending. Any other value means that no sorting will be performed. Refers to fileset and srcFiles
User property is: orderFile.
outputDelimiter String 1.4 The delimiter used to separate fields in the output when using printResultSet.
Default value is: ,.
outputFile File 1.3 Dump the SQL execution's output to a file.
Default value is: System.out.
password String 1.0 Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
User property is: password.
postExecuteHookScript File 1.6 (no description)
preExecuteHookScript File 1.6 (no description)
printResultSet boolean 1.3 Print SQL results.
Default value is: false.
User property is: printResultSet.
settingsKey String 1.0 Server's id in settings.xml to look up username and password. Defaults to ${url} if not given.
User property is: settingsKey.
skip boolean 1.0 When true, skip the execution.
Default value is: false.
skipOnConnectionError boolean 1.1 Skip execution when there is an error obtaining a connection. This is a special case to support databases, such as embedded Derby, that can shutdown the database via the URL (i.e. shutdown=true).
Default value is: false.
User property is: skipOnConnectionError.
sqlCommand String 1.0 SQL input commands separated by ${delimiter}.
User property is: sqlCommand.
srcFiles File[] 1.0 List of files containing SQL statements to load.
username String 1.0 Database username. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
User property is: username.

Parameter Details

autocommit:

Set to true to execute none-transactional SQL.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: autocommit
  • Default: false

delimiter:

Set the delimiter that separates SQL statements.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: 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
  • Since: 1.2
  • Required: No
  • User Property: delimiterType
  • Default: normal

driver:

Database driver classname.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • User Property: driver

driverProperties:

Additional key=value pairs separated by comma to be passed into JDBC driver.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: driverProperties

enableAnonymousPassword:

Ignore the password and use anonymous access. This may be useful for databases like MySQL which do not allow empty password parameters in the connection initialization.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • Default: false

enableFiltering:

Set to true if you want to filter the srcFiles using system-, user- and project properties
  • Type: boolean
  • Since: 1.4
  • Required: No
  • User Property: enableFiltering
  • Default: false

encoding:

Encoding to use when reading SQL statements from a file.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: 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
  • Since: 1.4
  • Required: No
  • User Property: escapeProcessing
  • Default: true

fileset:

File(s) containing SQL statements to load. Only use a Fileset if you want to use ant-like filepatterns, otherwise use srcFiles. The order is based on a matching occurrence while scanning the directory (not the order of includes!).
  • Type: org.codehaus.mojo.sql.Fileset
  • Since: 1.0
  • Required: No

forceMojoExecution:

Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.
  • Type: boolean
  • Required: Yes
  • User Property: forceOpenJpaExecution
  • Default: false

keepFormat:

Keep the format of an SQL block.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: keepFormat
  • Default: false

onError:

Action to perform if an error is found. Possible values are abort and continue.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: onError
  • Default: abort

orderFile:

Set the order in which the SQL files will be executed. Possible values are ascending and descending. Any other value means that no sorting will be performed. Refers to fileset and srcFiles
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: orderFile

outputDelimiter:

The delimiter used to separate fields in the output when using printResultSet.
  • Type: java.lang.String
  • Since: 1.4
  • Required: No
  • Default: ,

outputFile:

Dump the SQL execution's output to a file.
Default value is: System.out.
  • Type: java.io.File
  • Since: 1.3
  • Required: No

password:

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

postExecuteHookScript:

(no description)
  • Type: java.io.File
  • Since: 1.6
  • Required: No

preExecuteHookScript:

(no description)
  • Type: java.io.File
  • Since: 1.6
  • Required: No

printResultSet:

Print SQL results.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • User Property: printResultSet
  • Default: false

settingsKey:

Server's id in settings.xml to look up username and password. Defaults to ${url} if not given.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: settingsKey

skip:

When true, skip the execution.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

skipOnConnectionError:

Skip execution when there is an error obtaining a connection. This is a special case to support databases, such as embedded Derby, that can shutdown the database via the URL (i.e. shutdown=true).
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: skipOnConnectionError
  • Default: false

sqlCommand:

SQL input commands separated by ${delimiter}.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: sqlCommand

srcFiles:

List of files containing SQL statements to load.
  • Type: java.io.File[]
  • Since: 1.0
  • Required: No

url:

Database URL.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: Yes
  • User Property: 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
  • Since: 1.0
  • Required: No
  • User Property: username