You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

sql.html 16 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. <!--
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. -->
  15. <html>
  16. <head>
  17. <meta http-equiv="Content-Language" content="en-us">
  18. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
  19. <title>SQL Task</title>
  20. </head>
  21. <body>
  22. <h2><a name="sql">Sql</a></h2>
  23. <h3>Description</h3>
  24. <p>Executes a series of SQL statements via JDBC to a database. Statements can
  25. either be read in from a text file using the <i>src</i> attribute or from
  26. between the enclosing SQL tags.</p>
  27. <p>Multiple statements can be provided, separated by semicolons (or the
  28. defined <i>delimiter</i>). Individual lines within the statements can be
  29. commented using either --, // or REM at the start of the line.</p>
  30. <p>The <i>autocommit</i> attribute specifies whether auto-commit should be
  31. turned on or off whilst executing the statements. If auto-commit is turned
  32. on each statement will be executed and committed. If it is turned off the
  33. statements will all be executed as one transaction.</p>
  34. <p>The <i>onerror</i> attribute specifies how to proceed when an error occurs
  35. during the execution of one of the statements.
  36. The possible values are: <b>continue</b> execution, only show the error;
  37. <b>stop</b> execution, log the error but don't fail the task
  38. and <b>abort</b> execution and transaction and fail task.</p>
  39. <p>
  40. <b>Proxies</b>. Some JDBC drivers (including the Oracle thin driver),
  41. use the JVM's proxy settings to route their JDBC operations to the database.
  42. Since Ant1.7, Ant running on Java1.5 or later defaults to
  43. <a href="../proxy.html">using
  44. the proxy settings of the operating system</a>.
  45. Accordingly, the OS proxy settings need to be valid, or Ant's proxy
  46. support disabled with <code>-noproxy</code> option.
  47. </p>
  48. <h3>Parameters</h3>
  49. <table border="1" cellpadding="2" cellspacing="0">
  50. <tr>
  51. <td width="12%" valign="top"><b>Attribute</b></td>
  52. <td width="78%" valign="top"><b>Description</b></td>
  53. <td width="10%" valign="top"><b>Required</b></td>
  54. </tr>
  55. <tr>
  56. <td width="12%" valign="top">driver</td>
  57. <td width="78%" valign="top">Class name of the jdbc driver</td>
  58. <td width="10%" valign="top">Yes</td>
  59. </tr>
  60. <tr>
  61. <td width="12%" valign="top">url</td>
  62. <td width="78%" valign="top">Database connection url</td>
  63. <td width="10%" valign="top">Yes</td>
  64. </tr>
  65. <tr>
  66. <td width="12%" valign="top">userid</td>
  67. <td width="78%" valign="top">Database user name</td>
  68. <td width="10%" valign="top">Yes</td>
  69. </tr>
  70. <tr>
  71. <td width="12%" valign="top">password</td>
  72. <td width="78%" valign="top">Database password</td>
  73. <td width="10%" valign="top">Yes</td>
  74. </tr>
  75. <tr>
  76. <td width="12%" valign="top">src</td>
  77. <td width="78%" valign="top">File containing SQL statements</td>
  78. <td width="10%" valign="top">Yes, unless statements enclosed within tags</td>
  79. </tr>
  80. <tr>
  81. <td valign="top">encoding</td>
  82. <td valign="top">The encoding of the files containing SQL statements</td>
  83. <td align="center">No - defaults to default JVM encoding</td>
  84. </tr>
  85. <tr>
  86. <td width="12%" valign="top">delimiter</td>
  87. <td width="78%" valign="top">String that separates SQL statements</td>
  88. <td width="10%" valign="top">No, default &quot;;&quot;</td>
  89. </tr>
  90. <tr>
  91. <td width="12%" valign="top">autocommit</td>
  92. <td width="78%" valign="top">Auto commit flag for database connection (default false)</td>
  93. <td width="10%" valign="top">No, default &quot;false&quot;</td>
  94. </tr>
  95. <tr>
  96. <td width="12%" valign="top">print</td>
  97. <td width="78%" valign="top">Print result sets from the statements (default false)</td>
  98. <td width="10%" valign="top">No, default &quot;false&quot;</td>
  99. </tr>
  100. <tr>
  101. <td width="12%" valign="top">showheaders</td>
  102. <td width="78%" valign="top">Print headers for result sets from the statements (default true)</td>
  103. <td width="10%" valign="top">No, default &quot;true&quot;</td>
  104. </tr>
  105. <tr>
  106. <td width="12%" valign="top">showtrailers</td>
  107. <td width="78%" valign="top">Print trailer for number of rows affected (default true)</td>
  108. <td width="10%" valign="top">No, default &quot;true&quot;</td>
  109. </tr>
  110. <tr>
  111. <td width="12%" valign="top">output</td>
  112. <td width="78%" valign="top">Output file for result sets (defaults to System.out)
  113. <b>Since Ant 1.8</b> can specify any Resource that supports output (see
  114. <a href="../develop.html#set-magic">note</a>).
  115. </td>
  116. <td width="10%" valign="top">No (print to System.out by default)</td>
  117. </tr>
  118. <tr>
  119. <td valign="top">append</td>
  120. <td valign="top">whether output should be appended to or overwrite
  121. an existing file. Defaults to false.</td>
  122. <td align="center" valign="top">No</td>
  123. </tr>
  124. <tr>
  125. <td width="12%" valign="top">classpath</td>
  126. <td width="78%" valign="top">Classpath used to load driver</td>
  127. <td width="10%" valign="top">No (use system classpath)</td>
  128. </tr>
  129. <tr>
  130. <td width="12%" valign="top">classpathref</td>
  131. <td width="78%" valign="top">The classpath to use, given as a <a href="../using.html#references">reference</a> to a path defined elsewhere.</td>
  132. <td width="10%" valign="top">No (use system classpath)</td>
  133. </tr>
  134. <tr>
  135. <td width="12%" valign="top">onerror</td>
  136. <td width="78%" valign="top">Action to perform when statement fails: continue, stop, abort</td>
  137. <td width="10%" valign="top">No, default &quot;abort&quot;</td>
  138. </tr>
  139. <tr>
  140. <td width="12%" valign="top">rdbms</td>
  141. <td width="78%" valign="top">Execute task only if this rdbms</td>
  142. <td width="10%" valign="top">No (no restriction)</td>
  143. </tr>
  144. <tr>
  145. <td width="12%" valign="top">version</td>
  146. <td width="78%" valign="top">Execute task only if rdbms version match</td>
  147. <td width="10%" valign="top">No (no restriction)</td>
  148. </tr>
  149. <tr>
  150. <td width="12%" valign="top">caching</td>
  151. <td width="78%" valign="top">Should the task cache loaders and the driver?</td>
  152. <td width="10%" valign="top">No (default=true)</td>
  153. </tr>
  154. <tr>
  155. <td width="12%" valign="top">delimitertype</td>
  156. <td width="78%" valign="top">Control whether the delimiter will only be recognized on a line by itself.<br>
  157. Can be "normal" -anywhere on the line, or "row", meaning it must be on a line by itself</td>
  158. <td width="10%" valign="top">No (default:normal)</td>
  159. </tr>
  160. <tr>
  161. <td width="12%" valign="top">keepformat</td>
  162. <td width="78%" valign="top">Control whether the format of the sql will be preserved.<br>
  163. Useful when loading packages and procedures.
  164. <td width="10%" valign="top">No (default=false)</td>
  165. </tr>
  166. <tr>
  167. <td width="12%" valign="top">escapeprocessing</td>
  168. <td width="78%" valign="top">Control whether the Java statement
  169. object will perform escape substitution.<br>
  170. See <a
  171. href="http://java.sun.com/j2se/1.4.2/docs/api/java/sql/Statement.html#setEscapeProcessing(boolean)">Statement's
  172. API docs</a> for details. <em>Since Ant 1.6</em>.
  173. <td width="10%" valign="top">No (default=true)</td>
  174. </tr>
  175. <tr>
  176. <td width="12%" valign="top">expandproperties</td>
  177. <td width="78%" valign="top">Set to true to turn on property expansion in
  178. nested SQL, inline in the task or nested transactions. <em>Since Ant 1.7</em>.
  179. <td width="10%" valign="top">No (default=true)</td>
  180. </tr>
  181. <tr>
  182. <td width="12%" valign="top">rawblobs</td>
  183. <td width="78%" valign="top">If true, will write raw streams rather than hex encoding when
  184. printing BLOB results. <em>Since Ant 1.7.1</em>.</td>
  185. <td width="10%" valign="top">No, default <em>false</em></td>
  186. </tr>
  187. <tr>
  188. <td width="12%" valign="top">failOnConnectionError</td>
  189. <td width="78%" valign="top">If false, will only print a warning
  190. message and not execute any statement if the task fails to connect
  191. to the database. <em>Since Ant 1.8.0</em>.</td>
  192. <td width="10%" valign="top">No, default <em>true</em></td>
  193. </tr>
  194. <tr>
  195. <td width="12%" valign="top">strictDelimiterMatching</td>
  196. <td width="78%" valign="top">If false, delimiters will be searched
  197. for in a case-insesitive manner (i.e. delimer="go" matches "GO")
  198. and surrounding whitespace will be ignored (delimter="go" matches
  199. "GO "). <em>Since Ant 1.8.0</em>.</td>
  200. <td width="10%" valign="top">No, default <em>true</em></td>
  201. </tr>
  202. <tr>
  203. <td width="12%" valign="top">showWarnings</td>
  204. <td width="78%" valign="top">If true, SQLWarnings will be logged at
  205. the WARN level. <em>Since Ant 1.8.0</em>.<br/>
  206. <b>Note:</b> even if the attribute is set to false, warnings that
  207. apply to the connection will be logged at the verbose level.</td>
  208. <td width="10%" valign="top">No, default <em>false</em></td>
  209. </tr>
  210. <tr>
  211. <td width="12%" valign="top">treatWarningsAsErrors</td>
  212. <td width="78%" valign="top">If true, SQLWarnings will be treated
  213. like errors - and the logic selected via the onError attribute
  214. applies.
  215. <em>Since Ant 1.8.0</em>.</td>
  216. <td width="10%" valign="top">No, default <em>false</em></td>
  217. </tr>
  218. <tr>
  219. <td width="12%" valign="top">csvColumnSeparator</td>
  220. <td width="78%" valign="top">The column separator used when printing
  221. the results.
  222. <em>Since Ant 1.8.0</em>.</td>
  223. <td width="10%" valign="top">No, default <em>','</em></td>
  224. </tr>
  225. <tr>
  226. <td width="12%" valign="top">csvQuoteCharacter</td>
  227. <td width="78%" valign="top">The character used to quote column
  228. values.<br/>
  229. If set, columns that contain either the column separator or the
  230. quote character itself will be surrounded by the quote character.
  231. The quote character itself will be doubled if it appears inside of
  232. the column's value.<br/>
  233. <b>Note:</b> BLOB values will never be quoted.
  234. <em>Since Ant 1.8.0</em>.</td>
  235. <td width="10%" valign="top">No, default is not set (i.e. no quoting
  236. ever occurs)</td>
  237. </tr>
  238. </table>
  239. <h3>Parameters specified as nested elements</h3>
  240. <h4>transaction</h4>
  241. <p>Use nested <code>&lt;transaction&gt;</code>
  242. elements to specify multiple blocks of commands to the executed
  243. executed in the same connection but different transactions. This
  244. is particularly useful when there are multiple files to execute
  245. on the same schema.</p>
  246. <table border="1" cellpadding="2" cellspacing="0">
  247. <tr>
  248. <td valign="top"><b>Attribute</b></td>
  249. <td valign="top"><b>Description</b></td>
  250. <td align="center" valign="top"><b>Required</b></td>
  251. </tr>
  252. <tr>
  253. <td valign="top">src</td>
  254. <td valign="top">File containing SQL statements</td>
  255. <td valign="top" align="center">Yes, unless statements enclosed within tags</td>
  256. </tr>
  257. </table>
  258. <p>The <code>&lt;transaction&gt;</code> element supports any <a
  259. href="../CoreTypes/resources.html">resource</a> or single element
  260. resource collection as nested element to specify the resource
  261. containing the SQL statements.</p>
  262. <h4>any <a href="../CoreTypes/resources.html">resource</a> or resource
  263. collection</h4>
  264. <p>You can specify multiple sources via nested resource collection
  265. elements. Each resource of the collection will be run in a
  266. transaction of its own. Prior to Ant 1.7 only filesets were
  267. supported. Use a sort resource collection to get a predictable order
  268. of transactions. </p>
  269. <h4>classpath</h4>
  270. <p><code>Sql</code>'s <em>classpath</em> attribute is a <a
  271. href="../using.html#path">PATH like structure</a> and can also be set via a nested
  272. <em>classpath</em> element. It is used to load the JDBC classes.</p>
  273. <h3>Examples</h3>
  274. <blockquote><pre>&lt;sql
  275. driver=&quot;org.database.jdbcDriver&quot;
  276. url=&quot;jdbc:database-url&quot;
  277. userid=&quot;sa&quot;
  278. password=&quot;pass&quot;
  279. src=&quot;data.sql&quot;
  280. /&gt;
  281. </pre></blockquote>
  282. <p>Connects to the database given in <i>url</i> as the sa user using the
  283. org.database.jdbcDriver and executes the SQL statements contained within
  284. the file data.sql</p>
  285. <blockquote><pre>&lt;sql
  286. driver=&quot;org.database.jdbcDriver&quot;
  287. url=&quot;jdbc:database-url&quot;
  288. userid=&quot;sa&quot;
  289. password=&quot;pass&quot;
  290. &gt;
  291. insert
  292. into table some_table
  293. values(1,2,3,4);
  294. truncate table some_other_table;
  295. &lt;/sql&gt;
  296. </pre></blockquote>
  297. <p>Connects to the database given in <i>url</i> as the sa
  298. user using the org.database.jdbcDriver and executes the two SQL statements
  299. inserting data into some_table and truncating some_other_table. Ant Properties
  300. in the nested text will not be expanded.</p>
  301. <p>Note that you may want to enclose your statements in
  302. <code>&lt;![CDATA[</code> ... <code>]]&gt;</code> sections so you don't
  303. need to escape <code>&lt;</code>, <code>&gt;</code> <code>&amp;</code>
  304. or other special characters. For example:</p>
  305. <blockquote><pre>&lt;sql
  306. driver=&quot;org.database.jdbcDriver&quot;
  307. url=&quot;jdbc:database-url&quot;
  308. userid=&quot;sa&quot;
  309. password=&quot;pass&quot;
  310. &gt;&lt;![CDATA[
  311. update some_table set column1 = column1 + 1 where column2 &lt; 42;
  312. ]]&gt;&lt;/sql&gt;
  313. </pre></blockquote>
  314. The following command turns property expansion in nested text on (it is off purely for backwards
  315. compatibility), then creates a new user in the HSQLDB database using Ant properties.
  316. <blockquote><pre>&lt;sql
  317. driver="org.hsqldb.jdbcDriver";
  318. url="jdbc:hsqldb:file:${database.dir}"
  319. userid="sa"
  320. password=""
  321. expandProperties="true"
  322. &gt;
  323. &lt;transaction&gt;
  324. CREATE USER ${newuser} PASSWORD ${newpassword}
  325. &lt;/transaction&gt;
  326. &lt;/sql&gt;
  327. </pre></blockquote>
  328. <p>The following connects to the database given in url as the sa user using
  329. the org.database.jdbcDriver and executes the SQL statements contained within
  330. the files data1.sql, data2.sql and data3.sql and then executes the truncate
  331. operation on <i>some_other_table</i>.</p>
  332. <blockquote><pre>&lt;sql
  333. driver=&quot;org.database.jdbcDriver&quot;
  334. url=&quot;jdbc:database-url&quot;
  335. userid=&quot;sa&quot;
  336. password=&quot;pass&quot; &gt;
  337. &lt;transaction src=&quot;data1.sql&quot;/&gt;
  338. &lt;transaction src=&quot;data2.sql&quot;/&gt;
  339. &lt;transaction src=&quot;data3.sql&quot;/&gt;
  340. &lt;transaction&gt;
  341. truncate table some_other_table;
  342. &lt;/transaction&gt;
  343. &lt;/sql&gt;
  344. </pre></blockquote>
  345. <p>The following example does the same as (and may execute additional
  346. SQL files if there are more files matching the pattern
  347. <code>data*.sql</code>) but doesn't guarantee that data1.sql will be
  348. run before <code>data2.sql</code>.</p>
  349. <blockquote><pre>&lt;sql
  350. driver=&quot;org.database.jdbcDriver&quot;
  351. url=&quot;jdbc:database-url&quot;
  352. userid=&quot;sa&quot;
  353. password=&quot;pass&quot;&gt;
  354. &lt;path&gt;
  355. &lt;fileset dir=&quot;.&quot;&gt;
  356. &lt;include name=&quot;data*.sql&quot;/&gt;
  357. &lt;/fileset&gt;
  358. &lt;path&gt;
  359. &lt;transaction&gt;
  360. truncate table some_other_table;
  361. &lt;/transaction&gt;
  362. &lt;/sql&gt;
  363. </pre></blockquote>
  364. <p>The following connects to the database given in url as the sa user using the
  365. org.database.jdbcDriver and executes the SQL statements contained within the
  366. file data.sql, with output piped to outputfile.txt, searching /some/jdbc.jar
  367. as well as the system classpath for the driver class.</p>
  368. <blockquote><pre>&lt;sql
  369. driver=&quot;org.database.jdbcDriver&quot;
  370. url=&quot;jdbc:database-url&quot;
  371. userid=&quot;sa&quot;
  372. password=&quot;pass&quot;
  373. src=&quot;data.sql&quot;
  374. print=&quot;yes&quot;
  375. output=&quot;outputfile.txt&quot;
  376. &gt;
  377. &lt;classpath&gt;
  378. &lt;pathelement location=&quot;/some/jdbc.jar&quot;/&gt;
  379. &lt;/classpath&gt;
  380. &lt;/sql&gt;
  381. </pre></blockquote>
  382. <p>The following will only execute if the RDBMS is &quot;oracle&quot; and the version
  383. starts with &quot;8.1.&quot;</p>
  384. <blockquote><pre>&lt;sql
  385. driver=&quot;org.database.jdbcDriver&quot;
  386. url=&quot;jdbc:database-url&quot;
  387. userid=&quot;sa&quot;
  388. password=&quot;pass&quot;
  389. src=&quot;data.sql&quot;
  390. rdbms=&quot;oracle&quot;
  391. version=&quot;8.1.&quot;
  392. &gt;
  393. insert
  394. into table some_table
  395. values(1,2,3,4);
  396. truncate table some_other_table;
  397. &lt;/sql&gt;
  398. </pre></blockquote>
  399. </body>
  400. </html>