Changes

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:init|$class as xs:string|empty-sequence()}}

| '''Summary'''

|This function initializes a JDBC driver specified via {{Code|$class}}. This step might be superfluous if the SQL database is not embedded.<br/ >

| '''Errors'''

|{{Error|init|#Errors}} the specified driver is not found.

{| width='100%'

| width='120' | '''Signatures'''

| '''Summary'''

| '''Errors'''

|{{Error|error|#Errors}} an SQL exception occurred when connecting to the database.

| '''Examples'''

|Connects to an SQL Server and sets autocommit to {{Code|true}}:

sql:connect('dbc:sqlserver://DBServer', map { 'autocommit': true() })

|}

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:execute|$id as xs:anyURI, $statement as xs:string|item()*}}<br/>{{Func|sql:execute|$id as xs:anyURI, $statement as xs:string, $options as map(*)?|item()*}}

| '''Summary'''

| This function executes an SQL {{Code|$statement}}, using the connection with the specified {{Code|$id}}. The returned result depends on the kind of statement:

With {{Code|$options}}, the following parameter can be set:

* {{Code|timeout}}: query execution will be interrupted after the specified number of seconds.

| '''Errors'''

|{{Error|error|#Errors}} an error occurred while executing SQL.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/>

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:execute-prepared|$id as xs:anyURI, $params as element(sql:parameters)|item()*}}<br/>{{Func|sql:execute-prepared|$id as xs:anyURI, $params as element(sql:parameters), $options as map(*)?|item()*}}

| '''Summary'''

element sql:parameters {

element sql:parameter {

attribute null { "true" | "false" }?,

text

}+

}?

With {{Code|$options}}, the following parameter can be set:

* {{Code|timeout}}: query execution will be interrupted after the specified number of seconds.

| '''Errors'''

|{{Error|attribute|#Errors}} an attribute different from {{Code|type}} and {{Code|null}} is set for a {{Code|<sql:parameter/>}} element.<br/ >{{Error|error|#Errors}} an error occurred while executing SQL.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >{{Error|parameters|#Errors}} no parameter type specified.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/>{{Error|type|#Errors}} the value of a parameter cannot be converted to the specified format.

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:prepare|$id as xs:anyURI, $statement as xs:string|xs:anyURI}}

| '''Summary'''

|This function prepares an SQL {{Code|$statement}}, using the specified connection {{Code|$id}}, and returns the id reference to this statement. The statement is a string with one or more '?' placeholders. If the value of a field has to be set to {{Code|NULL}}, then the attribute {{Code|null}} of the {{Code|<sql:parameter/>}} element must be {{Code|true}}.

| '''Errors'''

|{{Error|error|#Errors}} an error occurred while executing SQL.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:commit|$id as xs:anyURI|empty-sequence()}}

| '''Summary'''

| This function commits the changes made to a relational database, using the specified connection {{Code|$id}}.

| '''Errors'''

|{{Error|error|#Errors}} an error occurred while executing SQL.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:rollback|$id as xs:anyURI|empty-sequence()}}

| '''Summary'''

| This function rolls back the changes made to a relational database, using the specified connection {{Code|$id}}.

| '''Errors'''

|{{Error|error|#Errors}} an error occurred while executing SQL.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >

{| width='100%'

| width='120' | '''Signatures'''

|{{Func|sql:close|$id as xs:anyURI|empty-sequence()}}

| '''Summary'''

| This function closes a database connection with the specified {{Code|$id}}.<br/>Opened connections will automatically be closed after the XQuery expression has been evaluated, but in order to save memory, it is always recommendable to close connections that are not used anymore.

| '''Errors'''

|{{Error|error|#Errors}} an error occurred while executing SQL.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >

A simple select statement can be executed as follows:

let $id := sql:connect("jdbc:postgresql://localhost:5432/coffeehouse")

return sql:execute($id, "SELECT * FROM coffees WHERE price < 10")

The result may look like:

<sql:row xmlns:sql="http://basex.org/modules/sql">

<sql:column name="cof_name">French_Roast</sql:column>

<sql:column name="sup_id">49</sql:column>

<sql:column name="sales">15</sql:column>

<sql:column name="total">30</sql:column>

<sql:column name="total">14</sql:column>

</sql:row>

==Prepared Statements==

A prepared select statement can be executed in the following way:

(: Establish a connection :)

let $conn := sql:connect("jdbc:postgresql://localhost:5432/coffeehouse")

(: Execute prepared statement :)

return sql:execute-prepared($prep, $params)

==SQLite==

(: Initialize driver :)

sql:init("org.sqlite.JDBC"),

sql:execute($conn, "select * from person")

)

=Errors=

! width="110"|Code

|Description

|{{Code|attribute}}

|An attribute different from {{Code|type}} and {{Code|null}} is set for a {{Code|&lt;sql:parameter/&gt;}} element.

|{{Code|error}}

|An SQL exception occurred.

|{{Code|id}}

|A connection does not exist.

|{{Code|init}}

|A database driver is not found.

|{{Code|parameters}}

|No parameter type specified.

|{{Code|timeout}}

|Query execution exceeded timeout.

|{{Code|type}}

|The value of a parameter cannot be converted to the specified format.

=Changelog=

;Version 9.0

* Updated: Connection ids are URIs now.

* Updated: error codes updated; errors now use the module namespace

;Version 7.5

The module was introduced with Version 7.0.