Changes

Jump to navigation Jump to search

SQL Module (edit)

Revision as of 18:39, 1 December 2023

709 bytes added ,  18:39, 1 December 2023
m
Text replacement - "syntaxhighlight" to "pre"
=Conventions=
 
{{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/>
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:init|( $class as xs:string|) as empty-sequence()}}</pre>|-valign="top"
| '''Summary'''
|This function initializes a JDBC driver specified via {{Code|$class}}. This step might be superfluous if the SQL database is not embedded.<br/ >
|-valign="top"
| '''Errors'''
|{{Error|init|#Errors}} the specified driver is not found.
==sql:connect==
 
{{Announce|Updated with Version 11:}} Optional credentials.
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|sql:connect|$url as xs:string|xs:anyURI}}<br/ pre>{{Func|sql:connect|( $url as xs:string, $user as xs:string, $password as xs:string|xs:anyURI}}<br/ >{{Func|sql:connect|$url as xs:string, $user as xs:string, $password as xs:string, $options as map(xs*)? :string, item(= map { }))|as xs:anyURI}}<br/ pre>|-valign="top"
| '''Summary'''
|This function establishes a connection to a relational database and returns a connection id. 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 Values specified for {{Code|$userusername}} 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.|-valign="top"
| '''Errors'''
|{{Error|error|#Errors}} an SQL exception occurs, e.g. missing JDBC driver or not existing relationoccurred when connecting to the database.|-valign="top"
| '''Examples'''
|Connects to an SQL Server and sets autocommit to {{Code|true}}:
<pre classlang="brush:'xquery"'>
sql:connect('dbc:sqlserver://DBServer', map { 'autocommit': true() })
</pre>
==sql:execute==
 
{{Mark|Updated with Version 9.0}}: Return update count for updating statements.
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:execute|( $id as xs:anyURI, $statement as xs:string|, $options as map(*)? := map { }) as item()*}}</pre>|-valign="top"
| '''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:
* If an update statement was executed, the number of updated rows will be returned as integer.
* Otherwise, an XML representation of all results will be returned.
With {{Code|$options}}, the following parameter can be set:* {{Code|timeout}}: query execution will be interrupted after the specified number of seconds.|-valign="top"
| '''Errors'''
|{{Error|error|#Errors}} an error occurred while executing SQL exception occurs, e.g. not existing relation is retrieved.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/>{{Error|timeout|#Errors}} query execution exceeded timeout.<br/ >
|}
==sql:execute-prepared==
 
{{Mark|Updated with Version 9.0}}: Return update count for updating statements.
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:execute-prepared|( $id as xs:anyURI, $params as element(sql:parameters)|, $options as map(*)? := map { }) as item()*}}</pre>|-valign="top"
| '''Summary'''
| This function executes a prepared statement:* with the specified {{Code|$id}}. The output format is identical to [[#sql:execute{{Function||sql:execute]].* The parameter {{Code|$id}} refers to the prepared statement.* The optional parameter {{Code|$params}} is an element {{Code|<sql:parameters/>}} representing the parameters for a prepared statement along with their types and values. The following schema shall be used:<br/ ><pre classlang="brush:'xquery"'>
element sql:parameters {
element sql:parameter {
attribute type { "intbigdecimal" | "stringboolean" | "booleanbyte" | "date" | "double" | "float" | "floatint" | "long" | "short" | "timesqlxml" | "string" | "timestamptime" | "sqlxmltimestamp" },
attribute null { "true" | "false" }?,
text
}?
</pre>
With {{Code|$options}}, the following parameter can be set:* {{Code|timeout}}: query execution will be interrupted after the specified number of seconds.|-valign="top"
| '''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 exception occurs, e.g. not existing relation is retrieved.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >{{Error|parameters|#Errors}} wrong number of no parameter type specified.<br/>{{CodeError|<sql:parameter/>timeout|#Errors}} elements, or parameter type is not specifiedquery execution exceeded timeout.<br/>{{Error|type|#Errors}} the value of a parameter cannot be converted to the specified format.
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:prepare|( $id as xs:anyURI, $statement as xs:string|) as xs:anyURI}}</pre>|-valign="top"
| '''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}}.
|-valign="top"
| '''Errors'''
|{{Error|error|#Errors}} an error occurred while executing SQL exception occurs.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:commit|( $id as xs:anyURI|) as empty-sequence()}}</pre>|-valign="top"
| '''Summary'''
| This function commits the changes made to a relational database, using the specified connection {{Code|$id}}.
|-valign="top"
| '''Errors'''
|{{Error|error|#Errors}} an error occurred while executing SQL exception occurs.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:rollback|( $id as xs:anyURI|) as empty-sequence()}}</pre>|-valign="top"
| '''Summary'''
| This function rolls back the changes made to a relational database, using the specified connection {{Code|$id}}.
|-valign="top"
| '''Errors'''
|{{Error|error|#Errors}} an error occurred while executing SQL exception occurs.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>sql:close|( $id as xs:anyURI|) as empty-sequence()}}</pre>|-valign="top"
| '''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.
|-valign="top"
| '''Errors'''
|{{Error|error|#Errors}} an error occurred while executing SQL exception occurs.<br/ >{{Error|id|#Errors}} the specified connection does not exist.<br/ >
|}
A simple select statement can be executed as follows:
<pre classlang="brush:'xquery"'>
let $id := sql:connect("jdbc:postgresql://localhost:5432/coffeehouse")
return sql:execute($id, "SELECT * FROM coffees WHERE price < 10")
The result may look like:
<pre classlang="brush:xml">
<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="price">93.5</sql:column>
<sql:column name="sales">15</sql:column>
<sql:column name="total">30</sql:column>
A prepared select statement can be executed in the following way:
<pre classlang="brush:'xquery"'>
(: Establish a connection :)
let $conn := sql:connect("jdbc:postgresql://localhost:5432/coffeehouse")
==SQLite==
The following expression demonstrates how SQLite can be addressed using with the [httphttps://bitbucket.org/xerial/sqlite-jdbc / Xerial SQLite JDBC driver]:
<pre classlang="brush:'xquery"'>
(: Initialize driver :)
sql:init("org.sqlite.JDBC"),
=Errors=
 
{{Mark|Updated with Version 9.0}}:
{| class="wikitable" width="100%"
! width="110"|Code
|Description
|-valign="top"
|{{Code|attribute}}
|An attribute different from {{Code|type}} and {{Code|null}} is set for a {{Code|&lt;sql:parameter/&gt;}} element.
|-valign="top"
|{{Code|error}}
|An SQL exception occurred.
|-valign="top"
|{{Code|id}}
|A connection does not exist.
|-valign="top"
|{{Code|init}}
|A database driver is not found.
|-valign="top"
|{{Code|parameters}}
|Wrong number of No parameter type specified.|- valign="top"|{{Code|&lt;sql:parameter/&gt;timeout}} elements, or parameter type is not specified|Query execution exceeded timeout.|-valign="top"
|{{Code|type}}
|The value of a parameter cannot be converted to the specified format.
=Changelog=
 
;Version 11
* Updated: {{Function||sql:connect}}: Optional credentials.
 
;Version 9.6
* Updated: {{Function||sql:execute-prepared}}, additional types added
;Version 9.0
 * Updated: [[#sql:execute{{Function||sql:execute]]}}, [[#sql:execute-prepared{{Function||sql:execute-prepared]]}}: Return update count for updating statements. {{Code|$options}} argument added.
* Updated: Connection ids are URIs now.
* Updated: error codes updated; errors now use the module namespace
;Version 7.5
 * Updated: prepared statements are now executed via [[#sql:execute-prepared{{Function||sql:execute-prepared]]}}
The module was introduced with Version 7.0.
CG
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Retrieved from "https://old.docs.basex.org/wiki/Special:MobileDiff/13559...16903"

Navigation menu