├── LICENSE ├── README.md ├── ScriptRunner.java └── pom.xml /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ScriptRunner 2 | Allows to virtually use `source script.sql` with your JDBC 3 | 4 | Initial code was duplicated from: http://pastebin.com/f10584951 5 | 6 | Initial code was found using: http://stackoverflow.com/a/1044837/334493 7 | 8 | The initial code didn't allow custom delimiters (at least not dynamically) so it was not suited for procedure declarations. 9 | 10 | Possible alternative: http://www.mybatis.org/mybatis-3/getting-started.html (see #13) 11 | 12 | # Example 13 | 14 | Here is an example of a supported script: 15 | 16 | ```sql 17 | drop procedure if exists RecordStep; 18 | 19 | delimiter $$ 20 | 21 | CREATE PROCEDURE `p2` (in txt varchar(100)) 22 | LANGUAGE SQL 23 | DETERMINISTIC 24 | SQL SECURITY DEFINER 25 | COMMENT 'A procedure' 26 | BEGIN 27 | SELECT concat('Hello World: ', txt); 28 | END$$ 29 | 30 | delimiter ; 31 | 32 | call p2("test"); 33 | call p("this will work too"); 34 | ``` 35 | 36 | # Usage 37 | 38 | It is used pretty straightforwardly: 39 | 40 | ```java 41 | try { 42 | Class.forName("com.mysql.jdbc.Driver"); 43 | mConnection = DriverManager.getConnection("jdbc:mysql://" + SERVER + "/" + DATABASE + "?" + "user=" + USER + "&password=" + PASSWORD); 44 | } catch (ClassNotFoundException e) { 45 | System.err.println("Unable to get mysql driver: " + e); 46 | } catch (SQLException e) { 47 | System.err.println("Unable to connect to server: " + e); 48 | } 49 | ScriptRunner runner = new ScriptRunner(mConnection, false, false); 50 | String file = "~/path/to/script.sql"; 51 | runner.runScript(new BufferedReader(new FileReader(file))); 52 | ``` 53 | 54 | -------------------------------------------------------------------------------- /ScriptRunner.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Slightly modified version of the com.ibatis.common.jdbc.ScriptRunner class 3 | * from the iBATIS Apache project. Only removed dependency on Resource class 4 | * and a constructor 5 | * GPSHansl, 06.08.2015: regex for delimiter, rearrange comment/delimiter detection, remove some ide warnings. 6 | */ 7 | 8 | /* 9 | * Copyright 2004 Clinton Begin 10 | * 11 | * Licensed under the Apache License, Version 2.0 (the "License"); 12 | * you may not use this file except in compliance with the License. 13 | * You may obtain a copy of the License at 14 | * 15 | * http://www.apache.org/licenses/LICENSE-2.0 16 | * 17 | * Unless required by applicable law or agreed to in writing, software 18 | * distributed under the License is distributed on an "AS IS" BASIS, 19 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20 | * See the License for the specific language governing permissions and 21 | * limitations under the License. 22 | */ 23 | 24 | import java.io.*; 25 | import java.sql.*; 26 | import java.text.SimpleDateFormat; 27 | import java.util.regex.Matcher; 28 | import java.util.regex.Pattern; 29 | 30 | /** 31 | * Tool to run database scripts 32 | */ 33 | public class ScriptRunner { 34 | 35 | private static final String DEFAULT_DELIMITER = ";"; 36 | private static final Pattern SOURCE_COMMAND = Pattern.compile("^\\s*SOURCE\\s+(.*?)\\s*$", Pattern.CASE_INSENSITIVE); 37 | 38 | /** 39 | * regex to detect delimiter. 40 | * ignores spaces, allows delimiter in comment, allows an equals-sign 41 | */ 42 | public static final Pattern delimP = Pattern.compile("^\\s*(--)?\\s*delimiter\\s*=?\\s*([^\\s]+)+\\s*.*$", Pattern.CASE_INSENSITIVE); 43 | 44 | private final Connection connection; 45 | 46 | private final boolean stopOnError; 47 | private final boolean autoCommit; 48 | 49 | @SuppressWarnings("UseOfSystemOutOrSystemErr") 50 | private PrintWriter logWriter = null; 51 | @SuppressWarnings("UseOfSystemOutOrSystemErr") 52 | private PrintWriter errorLogWriter = null; 53 | 54 | private String delimiter = DEFAULT_DELIMITER; 55 | private boolean fullLineDelimiter = false; 56 | 57 | private String userDirectory = System.getProperty("user.dir"); 58 | 59 | /** 60 | * Default constructor 61 | */ 62 | public ScriptRunner(Connection connection, boolean autoCommit, 63 | boolean stopOnError) { 64 | this.connection = connection; 65 | this.autoCommit = autoCommit; 66 | this.stopOnError = stopOnError; 67 | File logFile = new File("create_db.log"); 68 | File errorLogFile = new File("create_db_error.log"); 69 | try { 70 | if (logFile.exists()) { 71 | logWriter = new PrintWriter(new FileWriter(logFile, true)); 72 | } else { 73 | logWriter = new PrintWriter(new FileWriter(logFile, false)); 74 | } 75 | } catch(IOException e){ 76 | System.err.println("Unable to access or create the db_create log"); 77 | } 78 | try { 79 | if (errorLogFile.exists()) { 80 | errorLogWriter = new PrintWriter(new FileWriter(errorLogFile, true)); 81 | } else { 82 | errorLogWriter = new PrintWriter(new FileWriter(errorLogFile, false)); 83 | } 84 | } catch(IOException e){ 85 | System.err.println("Unable to access or create the db_create error log"); 86 | } 87 | String timeStamp = new SimpleDateFormat("dd/mm/yyyy HH:mm:ss").format(new java.util.Date()); 88 | println("\n-------\n" + timeStamp + "\n-------\n"); 89 | printlnError("\n-------\n" + timeStamp + "\n-------\n"); 90 | } 91 | 92 | public void setDelimiter(String delimiter, boolean fullLineDelimiter) { 93 | this.delimiter = delimiter; 94 | this.fullLineDelimiter = fullLineDelimiter; 95 | } 96 | 97 | /** 98 | * Setter for logWriter property 99 | * 100 | * @param logWriter - the new value of the logWriter property 101 | */ 102 | public void setLogWriter(PrintWriter logWriter) { 103 | this.logWriter = logWriter; 104 | } 105 | 106 | /** 107 | * Setter for errorLogWriter property 108 | * 109 | * @param errorLogWriter - the new value of the errorLogWriter property 110 | */ 111 | public void setErrorLogWriter(PrintWriter errorLogWriter) { 112 | this.errorLogWriter = errorLogWriter; 113 | } 114 | 115 | /** 116 | * Set the current working directory. Source commands will be relative to this. 117 | */ 118 | public void setUserDirectory(String userDirectory) { 119 | this.userDirectory = userDirectory; 120 | } 121 | 122 | /** 123 | * Runs an SQL script (read in using the Reader parameter) 124 | * 125 | * @param filepath - the filepath of the script to run. May be relative to the userDirectory. 126 | */ 127 | public void runScript(String filepath) throws IOException, SQLException { 128 | File file = new File(userDirectory, filepath); 129 | this.runScript(new BufferedReader(new FileReader(file))); 130 | } 131 | 132 | /** 133 | * Runs an SQL script (read in using the Reader parameter) 134 | * 135 | * @param reader - the source of the script 136 | */ 137 | public void runScript(Reader reader) throws IOException, SQLException { 138 | try { 139 | boolean originalAutoCommit = connection.getAutoCommit(); 140 | try { 141 | if (originalAutoCommit != this.autoCommit) { 142 | connection.setAutoCommit(this.autoCommit); 143 | } 144 | runScript(connection, reader); 145 | } finally { 146 | connection.setAutoCommit(originalAutoCommit); 147 | } 148 | } catch (IOException | SQLException e) { 149 | throw e; 150 | } catch (Exception e) { 151 | throw new RuntimeException("Error running script. Cause: " + e, e); 152 | } 153 | } 154 | 155 | /** 156 | * Runs an SQL script (read in using the Reader parameter) using the 157 | * connection passed in 158 | * 159 | * @param conn - the connection to use for the script 160 | * @param reader - the source of the script 161 | * @throws SQLException if any SQL errors occur 162 | * @throws IOException if there is an error reading from the Reader 163 | */ 164 | private void runScript(Connection conn, Reader reader) throws IOException, 165 | SQLException { 166 | StringBuffer command = null; 167 | try { 168 | LineNumberReader lineReader = new LineNumberReader(reader); 169 | String line; 170 | while ((line = lineReader.readLine()) != null) { 171 | if (command == null) { 172 | command = new StringBuffer(); 173 | } 174 | String trimmedLine = line.trim(); 175 | final Matcher delimMatch = delimP.matcher(trimmedLine); 176 | if (trimmedLine.length() < 1 177 | || trimmedLine.startsWith("//")) { 178 | // Do nothing 179 | } else if (delimMatch.matches()) { 180 | setDelimiter(delimMatch.group(2), false); 181 | } else if (trimmedLine.startsWith("--")) { 182 | println(trimmedLine); 183 | } else if (trimmedLine.length() < 1 184 | || trimmedLine.startsWith("--")) { 185 | // Do nothing 186 | } else if (!fullLineDelimiter 187 | && trimmedLine.endsWith(getDelimiter()) 188 | || fullLineDelimiter 189 | && trimmedLine.equals(getDelimiter())) { 190 | command.append(line.substring(0, line 191 | .lastIndexOf(getDelimiter()))); 192 | command.append(" "); 193 | this.execCommand(conn, command, lineReader); 194 | command = null; 195 | } else { 196 | command.append(line); 197 | command.append("\n"); 198 | } 199 | } 200 | if (command != null) { 201 | this.execCommand(conn, command, lineReader); 202 | } 203 | if (!autoCommit) { 204 | conn.commit(); 205 | } 206 | } 207 | catch (IOException e) { 208 | throw new IOException(String.format("Error executing '%s': %s", command, e.getMessage()), e); 209 | } finally { 210 | conn.rollback(); 211 | flush(); 212 | } 213 | } 214 | 215 | private void execCommand(Connection conn, StringBuffer command, 216 | LineNumberReader lineReader) throws IOException, SQLException { 217 | 218 | if (command.length() == 0) { 219 | return; 220 | } 221 | 222 | Matcher sourceCommandMatcher = SOURCE_COMMAND.matcher(command); 223 | if (sourceCommandMatcher.matches()) { 224 | this.runScriptFile(conn, sourceCommandMatcher.group(1)); 225 | return; 226 | } 227 | 228 | this.execSqlCommand(conn, command, lineReader); 229 | } 230 | 231 | private void runScriptFile(Connection conn, String filepath) throws IOException, SQLException { 232 | File file = new File(userDirectory, filepath); 233 | this.runScript(conn, new BufferedReader(new FileReader(file))); 234 | } 235 | 236 | private void execSqlCommand(Connection conn, StringBuffer command, 237 | LineNumberReader lineReader) throws SQLException { 238 | 239 | Statement statement = conn.createStatement(); 240 | 241 | println(command); 242 | 243 | boolean hasResults = false; 244 | try { 245 | hasResults = statement.execute(command.toString()); 246 | } catch (SQLException e) { 247 | final String errText = String.format("Error executing '%s' (line %d): %s", 248 | command, lineReader.getLineNumber(), e.getMessage()); 249 | printlnError(errText); 250 | System.err.println(errText); 251 | if (stopOnError) { 252 | throw new SQLException(errText, e); 253 | } 254 | } 255 | 256 | if (autoCommit && !conn.getAutoCommit()) { 257 | conn.commit(); 258 | } 259 | 260 | ResultSet rs = statement.getResultSet(); 261 | if (hasResults && rs != null) { 262 | ResultSetMetaData md = rs.getMetaData(); 263 | int cols = md.getColumnCount(); 264 | for (int i = 1; i <= cols; i++) { 265 | String name = md.getColumnLabel(i); 266 | print(name + "\t"); 267 | } 268 | println(""); 269 | while (rs.next()) { 270 | for (int i = 1; i <= cols; i++) { 271 | String value = rs.getString(i); 272 | print(value + "\t"); 273 | } 274 | println(""); 275 | } 276 | } 277 | 278 | try { 279 | statement.close(); 280 | } catch (Exception e) { 281 | // Ignore to workaround a bug in Jakarta DBCP 282 | } 283 | } 284 | 285 | private String getDelimiter() { 286 | return delimiter; 287 | } 288 | 289 | @SuppressWarnings("UseOfSystemOutOrSystemErr") 290 | 291 | private void print(Object o) { 292 | if (logWriter != null) { 293 | logWriter.print(o); 294 | } 295 | } 296 | 297 | private void println(Object o) { 298 | if (logWriter != null) { 299 | logWriter.println(o); 300 | } 301 | } 302 | 303 | private void printlnError(Object o) { 304 | if (errorLogWriter != null) { 305 | errorLogWriter.println(o); 306 | } 307 | } 308 | 309 | private void flush() { 310 | if (logWriter != null) { 311 | logWriter.flush(); 312 | } 313 | if (errorLogWriter != null) { 314 | errorLogWriter.flush(); 315 | } 316 | } 317 | } 318 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.github.BenoitDuffez 8 | ScriptRunner 9 | 1.0-SNAPSHOT 10 | com.github.BenoitDuffez:ScriptRunner 11 | Allows to virtually use `source script.sql` with your JDBC 12 | https://github.com/BenoitDuffez/ScriptRunner 13 | 14 | 15 | The Apache Software License, Version 2.0 16 | http://www.apache.org/license/LICENSE-2.0.txt 17 | 18 | 19 | 20 | 21 | Benoit Duffez 22 | BenoitDuffez 23 | 24 | 25 | 26 | scm:git:git@github.com:BenoitDuffez/ScriptRunner.git 27 | scm:git:git@github.com:BenoitDuffez/ScriptRunner.git 28 | https://github.com/BenoitDuffez/ScriptRunner 29 | 30 | 31 | --------------------------------------------------------------------------------