Changes

{{Mark|Updated with Version 9.0}}: All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/sql</nowiki></code> namespace, which is statically bound to the {{Code|sql}} prefix.<br/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.

|{{Error|BXSQ0007init|XQuery Errors#SQL Functions Errors}} the specified driver class is not found.

|{{Func|sql:connect|$url as xs:string|xs:integeranyURI}}<br/ >{{Func|sql:connect|$url as xs:string, $user as xs:string, $password as xs:string|xs:integeranyURI}}<br/ >{{Func|sql:connect|$url as xs:string, $user as xs:string, $password as xs:string, $options as map(xs:string, item())|xs:integeranyURI}}<br/ >

|This function establishes a connection to a relational database. As a result and returns a connection handle is returnedid. The parameter {{Code|$url}} is the URL of the database and shall be of the form: {{Code|jdbc:<driver name>:[//<server>[/<database>]]}}. If the parameters {{Code|$user}} and {{Code|$password}} are specified, they are used as credentials for connecting to the database. The {{Code|$options}} parameter can be used to set connection options.

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs, e.g. missing JDBC driver or not existing relation.

|{{Func|sql:execute|$connection id as xs:integeranyURI, $query statement as xs:string|item()*}}

| This function executes a query or update statement. The parameter an SQL {{Code|$connectionstatement}} specifies a , using the connection handle. The parameter with the specified {{Code|$queryid}} is a string representing an SQL statement. The returned result depends on the kind of statement:* If the result is updatingan update statement was executed, the number of updated rows will be returned as integer.

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs, e.g. not existing relation is retrieved.<br/ >{{Error|BXSQ0002id|XQuery Errors#SQL Functions Errors}} a wrong the specified connection handle is passeddoes not exist.<br/ >

|{{Func|sql:execute-prepared|$id as xs:integeranyURI, $params as element(sql:parameters)|item()*}}

* The parameter {{Code|$id}} specifies a refers to the prepared statement handle.

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs, e.g. not existing relation is retrieved.<br/ >{{Error|BXSQ0002id|XQuery Errors#SQL Functions Errors}} a wrong prepared statement handle is passedthe specified connection does not exist.<br/ >{{Error|BXSQ0003parameters|XQuery Errors#SQL Functions Errors}} the number of {{Code|<sql:parameter/>}} elements in {{Code|<sql:parameters/>}} differs from the number of placeholders in the prepared statement.<br/ >{{Error|BXSQ0004|XQuery Errors#SQL Functions Errors}} the type of a parameter for a prepared statement is not specified.<br/ >{{Error|BXSQ0005attribute|XQuery Errors#SQL Functions Errors}} an attribute different from {{Code|type}} and {{Code|null}} is set for a {{Code|<sql:parameter/>}} element.<br/ >{{Error|BXSQ0006type|XQuery Errors#SQL Functions Errors}} a parameter is from type date, time or timestamp and its value is in an invalid format.<br/ >

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

|This function prepares a statement and returns a handle to it. The parameter an SQL {{Code|$connectionstatement}} indicates , using the specified connection handle to be used. The parameter {{Code|$statementid}} , and returns the id reference to this statement. The statement is a string representing an SQL statement 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 element {{Code|<sql:parameter/>}} has to element must be {{Code|true}}.

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs.<br/ >{{Error|BXSQ0002id|XQuery Errors#SQL Functions Errors}} a wrong the specified connection handle is passeddoes not exist.<br/ >

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

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

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs.<br/ >{{Error|BXSQ0002id|XQuery Errors#SQL Functions Errors}} a wrong the specified connection handle is passeddoes not exist.<br/ >

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

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

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs.<br/ >{{Error|BXSQ0002id|XQuery Errors#SQL Functions Errors}} a wrong the specified connection handle is passeddoes not exist.<br/ >

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

| This function closes a database connection to a relational database. with the specified {{Code|$connectionid}} specifies the connection handle.<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 explicitly close them with this function if you open many connectionsthat are not used anymore.

|{{Error|BXSQ0001error|XQuery Errors#SQL Functions Errors}} an SQL exception occurs.<br/ >{{Error|BXSQ0002id|XQuery Errors#SQL Functions Errors}} a wrong the specified connection handle is passeddoes not exist.<br/ >

let $conn id := sql:connect("jdbc:postgresql://localhost:5432/coffeehouse")return sql:execute($connid, "SELECT * FROM coffees WHERE price < 10")

|{{Code|BXSQ0001attribute}}|An SQL exception occurred (e.g.attribute different from {{Code|type}} and {{Code|null}} is set for a {{Code|&lt;sql: a non-existing relation is retrieved)parameter/&gt;}} element.

|{{Code|BXSQ0002error}}|A wrong connection handle or prepared statement handle is passedAn SQL exception occurred.

|{{Code|BXSQ0003init}}|The number of {{Code|&lt;sql:parameter/&gt;}} elements in {{Code|&lt;sql:parameters/&gt;}} differs from the number of placeholders in the prepared statementA database driver is not found.

|{{Code|BXSQ0004id}}|The type of a parameter for a prepared statement is A connection does not specifiedexist.

|{{Code|BXSQ0005parameters}}|An attribute different from {{Code|type}} and {{Code|null}} is set for a Wrong number of {{Code|&lt;sql:parameter/&gt;}} elementelements, or parameter type is not specified.  

|{{Code|BXSQ0006type}}