By default the sql-maven-plugin will check if a line contains the specified delimiter, which is by default a semicolon(;).
7 | More complex statements, such as a trigger creation, may contain semi-colons too, although these are not yet the end of the sql-statement.
8 | In such case you have to change the delimiterType to 'row'.
9 | Now the plugin will check if the complete row matches the delimiter, in order to recognize the end of the sql statement.
10 |
An example when to use <delimiterType>row</delimiterType>: 12 |
13 | CREATE OR REPLACE FUNCTION my_trig() 14 | RETURNS "trigger" AS 15 | $BODY$ 16 | declare 17 | t text; 18 | begin 19 | -- any plpgsql code here, where each line ends with a semicolon 20 | return NEW; 21 | end$BODY$ 22 | LANGUAGE 'plpgsql' VOLATILE; 23 |24 | Note: Delimiters within values or comments are not a problem, these will be ignored.
indexOfValue(String) always return the same index for the same value.
45 | */
46 | public String[] getValues() {
47 | return new String[] {NORMAL, ROW};
48 | }
49 |
50 | /** bean constructor */
51 | protected DelimiterType() {}
52 |
53 | /**
54 | * Set the delimiterValue. Use DelimiterType.NORMAL or DelimiterType.ROW
55 | *
56 | * @param value
57 | */
58 | public final void setValue(String value) {
59 | int index = indexOfValue(value);
60 | if (index == -1) {
61 | throw new IllegalArgumentException(value + " is not a legal value for this attribute");
62 | }
63 | this.index = index;
64 | this.value = value;
65 | }
66 |
67 | /**
68 | * Is this value included in the enumeration?
69 | *
70 | * @param value
71 | * @return true if this value is supported
72 | */
73 | public final boolean containsValue(String value) {
74 | return (indexOfValue(value) != -1);
75 | }
76 |
77 | /**
78 | * get the index of a value in this enumeration.
79 | *
80 | * @param value the string value to look for.
81 | * @return the index of the value in the array of strings or -1 if it cannot be found.
82 | * @see #getValues()
83 | */
84 | public final int indexOfValue(String value) {
85 | String[] values = getValues();
86 | if (values == null || value == null) {
87 | return -1;
88 | }
89 | for (int i = 0; i < values.length; i++) {
90 | if (value.equals(values[i])) {
91 | return i;
92 | }
93 | }
94 | return -1;
95 | }
96 |
97 | /**
98 | * @return the selected value.
99 | */
100 | public final String getValue() {
101 | return value;
102 | }
103 |
104 | /**
105 | * @return the index of the selected value in the array.
106 | * @see #getValues()
107 | */
108 | public final int getIndex() {
109 | return index;
110 | }
111 |
112 | /**
113 | * Convert the value to its string form.
114 | *
115 | * @return the string form of the value.
116 | */
117 | public String toString() {
118 | return getValue();
119 | }
120 | }
121 |
--------------------------------------------------------------------------------
/src/site/apt/examples/execute.apt.vm:
--------------------------------------------------------------------------------
1 | ------
2 | Executions
3 | ------
4 | Dan T. Tran
5 | true if the given character is either a lower or an upperchase alphanumerical character
211 | */
212 | private static boolean isAlpha(char c) {
213 | return Character.isUpperCase(c) || Character.isLowerCase(c);
214 | }
215 | }
216 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 | settings.xml's server with
113 | * ${settingsKey} as key.
114 | *
115 | * @since 1.0
116 | */
117 | @Parameter(property = "username")
118 | private String username;
119 |
120 | /**
121 | * Database password. If not given, it will be looked up through settings.xml's server with
122 | * ${settingsKey} as key.
123 | *
124 | * @since 1.0
125 | */
126 | @Parameter(property = "password")
127 | private String password;
128 |
129 | /**
130 | * Ignore the password and use anonymous access. This may be useful for databases like MySQL which do not allow
131 | * empty password parameters in the connection initialization.
132 | *
133 | * @since 1.4
134 | */
135 | @Parameter(defaultValue = "false")
136 | private boolean enableAnonymousPassword;
137 |
138 | /**
139 | * Additional key=value pairs separated by comma to be passed into JDBC driver.
140 | *
141 | * @since 1.0
142 | */
143 | @Parameter(defaultValue = "", property = "driverProperties")
144 | private String driverProperties;
145 |
146 | /**
147 | * @since 1.0
148 | */
149 | @Parameter(defaultValue = "${settings}", readonly = true, required = true)
150 | private Settings settings;
151 |
152 | /**
153 | * Server's id in settings.xml to look up username and password. Defaults to
154 | * ${url} if not given.
155 | *
156 | * @since 1.0
157 | */
158 | @Parameter(property = "settingsKey")
159 | private String settingsKey;
160 |
161 | /**
162 | * MNG-4384
163 | *
164 | * @since 1.5
165 | */
166 | @Component(role = SecDispatcher.class, hint = "default")
167 | private SecDispatcher securityDispatcher;
168 |
169 | /**
170 | * Skip execution when there is an error obtaining a connection. This is a special case to support databases, such
171 | * as embedded Derby, that can shutdown the database via the URL (i.e. shutdown=true).
172 | *
173 | * @since 1.1
174 | */
175 | @Parameter(defaultValue = "false", property = "skipOnConnectionError")
176 | private boolean skipOnConnectionError;
177 |
178 | /**
179 | * Skip missing files defined by {@link #setSrcFiles(File[])}. This behavior allows to define a full fledged list
180 | * of all sql files in a single {@code pom.xml} without failing if used by modules for which some sql files are not
181 | * available on the classpath.
182 | */
183 | @Parameter(defaultValue = "false", property = "skipMissingFiles")
184 | private boolean skipMissingFiles;
185 |
186 | /**
187 | * Setting this parameter to true will force the execution of this mojo, even if it would get skipped
188 | * usually.
189 | */
190 | @Parameter(defaultValue = "false", property = "forceOpenJpaExecution", required = true)
191 | private boolean forceMojoExecution;
192 |
193 | /**
194 | * The Maven Project Object
195 | */
196 | @Parameter(defaultValue = "${project}", readonly = true, required = true)
197 | private MavenProject project;
198 |
199 | /**
200 | */
201 | @Parameter(defaultValue = "${session}", readonly = true, required = true)
202 | private MavenSession mavenSession;
203 |
204 | //////////////////////////////// Source info /////////////////////////////
205 |
206 | /**
207 | * SQL input commands separated by ${delimiter}.
208 | *
209 | * @since 1.0
210 | */
211 | @Parameter(property = "sqlCommand")
212 | private String sqlCommand;
213 |
214 | /**
215 | * List of files containing SQL statements to load.
216 | *
217 | * @since 1.0
218 | * @see #fileset
219 | */
220 | @Parameter
221 | private File[] srcFiles;
222 |
223 | /**
224 | * File(s) containing SQL statements to load. Only use a Fileset if you want to use ant-like filepatterns, otherwise
225 | * use srcFiles. The order is based on a matching occurrence while scanning the directory (not the order of
226 | * includes!).
227 | *
228 | * @since 1.0
229 | * @see #srcFiles
230 | */
231 | @Parameter
232 | private Fileset fileset;
233 |
234 | /**
235 | * When true, skip the execution.
236 | *
237 | * @since 1.0
238 | */
239 | @Parameter(defaultValue = "false")
240 | private boolean skip;
241 |
242 | ////////////////////////////////// Database info /////////////////////////
243 | /**
244 | * Database URL.
245 | *
246 | * @since 1.0-beta-1
247 | */
248 | @Parameter(property = "url", required = true)
249 | private String url;
250 |
251 | /**
252 | * Database driver classname.
253 | *
254 | * @since 1.0
255 | */
256 | @Parameter(property = "driver", required = true)
257 | private String driver;
258 |
259 | ////////////////////////////// Operation Configuration ////////////////////
260 | /**
261 | * Set to true to execute none-transactional SQL.
262 | *
263 | * @since 1.0
264 | */
265 | @Parameter(defaultValue = "false", property = "autocommit")
266 | private boolean autocommit;
267 |
268 | /**
269 | * Set to true to execute immediately rollback transactional SQL.
270 | *
271 | * @since 3.0.0
272 | */
273 | @Parameter(defaultValue = "false", property = "rollbackTransactions")
274 | private boolean rollbackTransactions;
275 |
276 | /**
277 | * Action to perform if an error is found. Possible values are abort and continue.
278 | *
279 | * @since 1.0
280 | */
281 | @Parameter(defaultValue = ON_ERROR_ABORT, property = "onError")
282 | private String onError;
283 |
284 | /**
285 | * List of connection validation SQLs. If the value is given, the SQL files
286 | * are processed after all validation have been executed successfully.
287 | * The validation SQLs can be used to verify that required tables or data
288 | * exists before the SQLs are processed.
289 | *
290 | * @since 3.0.0
291 | */
292 | @Parameter(defaultValue = "", property = "connectionValidationSqls")
293 | private List324 | * The delimiter type takes two values - "normal" and "row". Normal means that any occurrence of the delimiter 325 | * terminate the SQL command whereas with row, only a line containing just the delimiter is recognized as the end of 326 | * the command. 327 | *
328 | *329 | * For example, set this to "go" and delimiterType to "row" for Sybase ASE or MS SQL Server. 330 | *
331 | * 332 | * @since 1.2 333 | */ 334 | @Parameter(defaultValue = DelimiterType.NORMAL, property = "delimiterType") 335 | private String delimiterType; 336 | 337 | /** 338 | * Set the order in which the SQL files will be executed. Possible values areascending and
339 | * descending. Any other value means that no sorting will be performed. Refers to {@link #fileset} and
340 | * {@link #srcFiles}
341 | *
342 | * @since 1.1
343 | */
344 | @Parameter(property = "orderFile")
345 | private String orderFile;
346 |
347 | /**
348 | * Keep the format of an SQL block.
349 | *
350 | * @since 1.1
351 | */
352 | @Parameter(defaultValue = "false", property = "keepFormat")
353 | private boolean keepFormat;
354 |
355 | ///////////////////////////////////////////////////////////////////////////////////////
356 | /**
357 | * Print SQL results.
358 | *
359 | * @since 1.3
360 | */
361 | @Parameter(defaultValue = "false", property = "printResultSet")
362 | private boolean printResultSet;
363 |
364 | /**
365 | * Print header columns.
366 | */
367 | @Parameter(property = "showheaders", defaultValue = "true")
368 | private boolean showHeaders;
369 |
370 | /**
371 | * Print footer value, informing on the number of rows
372 | */
373 | @Parameter(property = "showFooter", defaultValue = "true")
374 | private boolean showFooter;
375 |
376 | /**
377 | * Dump the SQL execution's output to a file.System.out.
379 | *
380 | * @since 1.3
381 | */
382 | @Parameter
383 | private File outputFile;
384 |
385 | /**
386 | * The delimiter used to separate fields in the output when using printResultSet.
387 | *
388 | * @since 1.4
389 | */
390 | @Parameter(defaultValue = ",")
391 | private String outputDelimiter;
392 |
393 | /**
394 | * Encoding to use while writing queried data to a file.
395 | *
396 | * @since 3.0.0
397 | */
398 | @Parameter(defaultValue = "${project.build.sourceEncoding}", property = "outputEncoding")
399 | private String outputEncoding;
400 |
401 | /**
402 | * Encoding to use when reading SQL statements from a file.
403 | *
404 | * @since 1.1
405 | */
406 | @Parameter(defaultValue = "${project.build.sourceEncoding}", property = "encoding")
407 | private String encoding;
408 |
409 | /**
410 | * Append to an existing file or overwrite it?
411 | */
412 | private boolean append = false;
413 |
414 | /**
415 | * Argument to Statement.setEscapeProcessing If you want the driver to use regular SQL syntax then set this to
416 | * false.
417 | *
418 | * @since 1.4
419 | */
420 | @Parameter(defaultValue = "true", property = "escapeProcessing")
421 | private boolean escapeProcessing;
422 |
423 | ////////////////////////////////// Internal properties//////////////////////
424 |
425 | /**
426 | * number of successful executed statements
427 | */
428 | private int successfulStatements = 0;
429 |
430 | /**
431 | * number of total executed statements
432 | */
433 | private int totalStatements = 0;
434 |
435 | /**
436 | * Database connection
437 | */
438 | private Connection conn = null;
439 |
440 | /**
441 | * SQL statement
442 | */
443 | private Statement statement = null;
444 |
445 | /**
446 | * SQL transactions to perform
447 | */
448 | private Listtrue to print the resultset, otherwise false
540 | */
541 | public void setPrintResultSet(boolean print) {
542 | this.printResultSet = print;
543 | }
544 |
545 | /**
546 | * Print headers for result sets from the statements; optional, default true.
547 | *
548 | * @param showHeaders true to show the headers, otherwise false
549 | */
550 | public void setShowHeaders(boolean showHeaders) {
551 | this.showHeaders = showHeaders;
552 | }
553 |
554 | /**
555 | * Set the output file;
556 | *
557 | * @param output the output file
558 | */
559 | public void setOutputFile(File output) {
560 | this.outputFile = output;
561 | }
562 |
563 | /**
564 | * whether output should be appended to or overwrite an existing file. Defaults to false.
565 | *
566 | * @param append true to append, otherwise false to overwrite
567 | */
568 | public void setAppend(boolean append) {
569 | this.append = append;
570 | }
571 |
572 | /**
573 | * whether or not format should be preserved. Defaults to false.
574 | *
575 | * @param keepformat {@code true} to keep the format {@code false} otherwise.
576 | */
577 | public void setKeepFormat(boolean keepformat) {
578 | this.keepFormat = keepformat;
579 | }
580 |
581 | /**
582 | * Set escape processing for statements.
583 | *
584 | * @param enable true to escape, otherwise false
585 | */
586 | public void setEscapeProcessing(boolean enable) {
587 | escapeProcessing = enable;
588 | }
589 |
590 | /**
591 | * 592 | * Determine if the mojo execution should get skipped. 593 | *
594 | * This is the case if: 595 | *truefalsetrue if the mojo execution should be skipped.
602 | */
603 | protected boolean skipMojo() {
604 | if (skip) {
605 | getLog().info("User has requested to skip execution.");
606 | return true;
607 | }
608 |
609 | if (!forceMojoExecution && project != null && "pom".equals(project.getPackaging())) {
610 | getLog().info("Skipping sql execution for project with packaging type 'pom'");
611 | return true;
612 | }
613 |
614 | return false;
615 | }
616 |
617 | /**
618 | * Load the sql file and then execute it
619 | *
620 | * @throws MojoExecutionException
621 | */
622 | @Override
623 | public void execute() throws MojoExecutionException {
624 |
625 | if (skipMojo()) {
626 | return;
627 | }
628 |
629 | executeScriptPlusSql();
630 | }
631 |
632 | private void executeScriptPlusSql() throws MojoExecutionException {
633 | // prepare scriptrunner
634 | scriptRunner = new ScriptRunner();
635 | scriptRunner.setScriptEncoding(encoding);
636 | // scriptRunner.setGlobalVariable( "localRepositoryPath", localRepositoryPath );
637 | // scriptRunner.setClassPath( scriptClassPath );
638 |
639 | MapconnectionRetryInterval.
1372 | *
1373 | * @throws MojoExecutionException
1374 | */
1375 | private void waitToRetryConnectionValidation() throws MojoExecutionException {
1376 | try {
1377 | Thread.sleep(this.connectionRetryInterval * 1000);
1378 | } catch (InterruptedException e) {
1379 | throw new MojoExecutionException(e.getMessage(), e);
1380 | }
1381 | }
1382 |
1383 | /**
1384 | * Closes the database connection.
1385 | */
1386 | void closeConnection() {
1387 | if (conn != null) {
1388 | try {
1389 | conn.close();
1390 | } catch (SQLException e) {
1391 | getLog().debug("Failed to close connection: " + e.getMessage());
1392 | }
1393 | }
1394 | }
1395 |
1396 | /**
1397 | * Closes the database statement.
1398 | */
1399 | private void closeStatement() {
1400 | if (statement != null) {
1401 | try {
1402 | statement.close();
1403 | } catch (SQLException e) {
1404 | getLog().debug("Failed to close statement: " + e.getMessage());
1405 | }
1406 | }
1407 | }
1408 |
1409 | /**
1410 | * Check is the database connection closed.
1411 | *
1412 | * @return true if the connection is closed, otherwise false
1413 | */
1414 | protected boolean isConnectionClosed() {
1415 | try {
1416 | return conn == null || conn.isClosed();
1417 | } catch (SQLException e) {
1418 | return false;
1419 | }
1420 | }
1421 |
1422 | protected void clear() {
1423 | sqlCommand = null;
1424 | if (transactions != null) {
1425 | transactions.clear();
1426 | }
1427 | }
1428 |
1429 | protected int getConnectionRetryAttempts() {
1430 | return this.connectionRetryAttempts;
1431 | }
1432 |
1433 | public void setConnectionValidationSqls(List