Skip navigation links

Package io.vertx.ext.sql

== Vert.x Common SQL interface The common SQL interface is used to interact with Vert.x SQL services.

See: Description

Package io.vertx.ext.sql Description

== Vert.x Common SQL interface The common SQL interface is used to interact with Vert.x SQL services. You obtain a connection to the database via the service interface for the specific SQL service that you are using (e.g. JDBC/MySQL/PostgreSQL). To use this project, add the following dependency to the _dependencies_ section of your build descriptor: * Maven (in your `pom.xml`): [source,xml,subs="+attributes"] ---- ${maven.groupId} ${maven.artifactId} ${maven.version} ---- * Gradle (in your `build.gradle` file): [source,groovy,subs="+attributes"] ---- compile '${maven.groupId}:${maven.artifactId}:${maven.version}' ---- == The SQL Connection A connection to the database is represented by SQLConnection. === Auto-commit When you obtain a connection auto commit is set to `true`. This means that each operation you perform will effectively execute in its own transaction. If you wish to perform multiple operations in a single transaction you should set auto commit to false with SQLConnection.setAutoCommit(boolean, io.vertx.core.Handler). When the operation is complete, the handler will be called: [source,java] ---- examples.SQLExamples#example1 ---- === Executing queries To execute a query use SQLConnection.query(java.lang.String, io.vertx.core.Handler) The query string is raw SQL that is passed through without changes to the actual database. The handler will be called with the results, represented by ResultSet when the query has been run. [source,java] ---- examples.SQLExamples#example2 ---- The ResultSet instance represents the results of a query. The list of column names are available with ResultSet.getColumnNames(), and the actual results available with ResultSet.getResults() The results are a list of JsonArray instances, one for each row of the results. [source,java] ---- examples.SQLExamples#example3 ---- You can also retrieve the rows as a list of Json object instances with ResultSet.getRows() - this can give you a somewhat simpler API to work with, but please be aware that SQL results can contain duplicate column names - if that's the case you should use ResultSet.getResults() instead. Here's an example of iterating through the results as Json object instances: [source,java] ---- examples.SQLExamples#example3__1 ---- === Prepared statement queries To execute a prepared statement query you can use SQLConnection.queryWithParams(java.lang.String, io.vertx.core.json.JsonArray, io.vertx.core.Handler). This takes the query, containing the parameter place holders, and a JsonArray or parameter values. [source,java] ---- examples.SQLExamples#example3_1 ---- === Executing INSERT, UPDATE or DELETE To execute an operation which updates the database use SQLConnection.update(java.lang.String, io.vertx.core.Handler). The update string is raw SQL that is passed through without changes to the actual database. The handler will be called with the results, represented by UpdateResult when the update has been run. The update result holds the number of rows updated with UpdateResult.getUpdated(), and if the update generated keys, they are available with UpdateResult.getKeys(). [source,java] ---- examples.SQLExamples#example4 ---- === Prepared statement updates To execute a prepared statement update you can use SQLConnection.updateWithParams(java.lang.String, io.vertx.core.json.JsonArray, io.vertx.core.Handler). This takes the update, containing the parameter place holders, and a JsonArray or parameter values. [source,java] ---- examples.SQLExamples#example5 ---- === Callable statements To execute a callable statement (either SQL functions or SQL procedures) you can use SQLConnection.callWithParams(java.lang.String, io.vertx.core.json.JsonArray, io.vertx.core.json.JsonArray, io.vertx.core.Handler). This takes the callable statement using the standard JDBC format `{ call func_proc_name() }`, optionally including parameter place holders e.g.: `{ call func_proc_name(?, ?) }`, a JsonArray containing the parameter values and finally a JsonArray containing the output types e.g.: `[null, 'VARCHAR']`. Note that the index of the output type is as important as the params array. If the return value is the second argument then the output array must contain a null value as the first element. A SQL function returns some output using the `return` keyword, and in this case one can call it like this: [source,java] ---- examples.SQLExamples#example8 ---- When working with Procedures you and still return values from your procedures via its arguments, in the case you do not return anything the usage is as follows: [source,java] ---- examples.SQLExamples#example9 ---- However you can also return values like this: [source,java] ---- examples.SQLExamples#example10 ---- Note that the index of the arguments matches the index of the `?` and that the output parameters expect to be a String describing the type you want to receive. To avoid ambiguation the implementations are expected to follow the following rules: * When a place holder in the `IN` array is `NOT NULL` it will be taken * When the `IN` value is NULL a check is performed on the OUT * When the `OUT` value is not null it will be registered as a output parameter * When the `OUT` is also null it is expected that the IN value is the `NULL` value. The registered `OUT` parameters will be available as an array in the result set under the output property. === Batch operations The SQL common interface also defines how to execute batch operations. There are 3 types of batch operations: * Batched statements SQLConnection.batch(java.util.List, io.vertx.core.Handler) * Batched prepared statements SQLConnection.batchWithParams(java.lang.String, java.util.List, io.vertx.core.Handler) * Batched callable statements SQLConnection.batchCallableWithParams(java.lang.String, java.util.List, java.util.List, io.vertx.core.Handler) A batches statement will exeucte a list of sql statements as for example: [source,java] ---- examples.SQLExamples#example12 ---- While a prepared or callable statement batch will reuse the sql statement and take an list of arguments as for example: [source,java] ---- examples.SQLExamples#example11 ---- === Executing other operations To execute any other database operation, e.g. a `CREATE TABLE` you can use SQLConnection.execute(java.lang.String, io.vertx.core.Handler). The string is passed through without changes to the actual database. The handler is called when the operation is complete [source,java] ---- examples.SQLExamples#example6 ---- === Multiple ResultSet responses In some cases your query might return more than one result set, in this case and to preserve the compatibility when the returned result set object is converted to pure json, the next result sets are chained to the current result set under the property `next`. A simple walk of all result sets can be achieved like this: [source,$lang] ---- examples.SQLExamples#example13 ---- === Streaming When dealing with large data sets, it is not advised to use API just described but to stream data since it avoids inflating the whole response into memory and JSON and data is just processed on a row by row basis, for example: [source,$lang] ---- examples.SQLExamples#example14 ---- You still have full control on when the stream is pauses, resumed and ended. For cases where your query returns multiple result sets you should use the result set ended event to fetch the next one if available. If there is more data the stream handler will receive the new data, otherwise the end handler is invoked. [source,$lang] ---- examples.SQLExamples#example15 ---- === Using transactions To use transactions first set auto-commit to false with SQLConnection.setAutoCommit(boolean, io.vertx.core.Handler). You then do your transactional operations and when you want to commit or rollback use SQLConnection.commit(io.vertx.core.Handler) or SQLConnection.rollback(io.vertx.core.Handler). Once the commit/rollback is complete the handler will be called and the next transaction will be automatically started. [source,java] ---- examples.SQLExamples#example7 ---- === Closing connections When you've done with the connection you should return it to the pool with SQLConnection.close(io.vertx.core.Handler).
Skip navigation links

Copyright © 2018. All rights reserved.