sql:execute

Full name:

org.codehaus.mojo:sql-maven-plugin:1.2:execute

Description:

Executes SQL against a database.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
driver String 1.0 Database driver classname.
url String 1.0-beta-1 Database URL.

Optional Parameters

Name Type Since Description
autocommit boolean 1.0 Set to true to execute none-transactional SQL. Default value is: false.
delimiter String 1.0 Set the delimiter that separates SQL statements. Default value is: ;.
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.
driverProperties String 1.0 Additional key=value pairs separated by comma to be passed into JDBC driver.
enableBlockMode boolean 1.1 Deprecated. used delimiterType instead.
encoding String 1.1 Encoding to use when reading SQL statements from a file.
fileset Fileset 1.0 File(s) containing SQL statements to load.
keepFormat boolean 1.1 Keep the format of an SQL block. Default value is: false.
onError String 1.0 Action to perform if an error is found. Possible values are abort and continue. Default value is: abort.
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.
password String 1.0 Database password. If not given, it will be looked up through settings.xml's server with ${settingsKey} as key.
settingsKey String 1.0 Server's id in settings.xml to look up username and password. Defaults to ${url} if not given.
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.
sqlCommand String 1.0 SQL input commands separated by ${delimiter}.
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.

Parameter Details

autocommit:

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

delimiter:

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

driver:

Database driver classname.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Expression: ${driver}

driverProperties:

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

enableBlockMode:

Deprecated. used delimiterType instead.
When true, the whole SQL content in sqlCommand, srcFiles and fileset are sent directly to JDBC in one SQL statement. This option is for executing database stored procedures/functions.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Expression: ${enableBlockMode}

encoding:

Encoding to use when reading SQL statements from a file.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${encoding}

fileset:

File(s) containing SQL statements to load.
  • Type: org.codehaus.mojo.sql.Fileset
  • Since: 1.0
  • Required: No

keepFormat:

Keep the format of an SQL block.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Expression: ${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
  • Expression: ${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.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${orderFile}

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
  • Expression: ${password}

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
  • Expression: ${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
  • Expression: ${skipOnConnectionError}
  • Default: false

sqlCommand:

SQL input commands separated by ${delimiter}.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${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
  • 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
  • Since: 1.0
  • Required: No
  • Expression: ${username}