Full name:
org.codehaus.mojo:sql-maven-plugin:3.0.0-SNAPSHOT:execute
Description:
Attributes:
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. |
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. |
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.
skip:
url: