Difference between revisions of "Client Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 15: Line 15:
 
=Conventions=
 
=Conventions=
  
All functions in this module are assigned to the <code><nowiki>http://basex.org/modules/client</nowiki></code> namespace, which is statically bound to the {{Code|client}} prefix.<br/>
+
{{Mark|Updated with Version 9.0}}:
All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
+
 
 +
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/client</nowiki></code> namespace, which is statically bound to the {{Code|client}} prefix.<br/>
  
 
=Functions=
 
=Functions=
  
 
==client:connect==
 
==client:connect==
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
Line 30: Line 32:
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
|{{Error|BXCL0001|#Errors}} an error occurs while creating the session (possible reasons: server not available, access denied).<br/>
+
|{{Error|connect|#Errors}} an error occurs while creating the session (possible reasons: server not available, access denied).<br/>
 
|}
 
|}
  
 
==client:execute==
 
==client:execute==
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
Line 43: Line 46:
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
|{{Error|BXCL0003|#Errors}} an I/O error occurs while transferring data from or to the server.<br/>{{Error|BXCL0004|#Errors}} an error occurs while executing a command.
+
|{{Error|error|#Errors}} an I/O error occurs while transferring data from or to the server.<br/>{{Error|command|#Errors}} an error occurs while executing a command.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 77: Line 80:
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
|{{Error|BXCL0003|#Errors}} an I/O error occurs while transferring data from or to the server.<br/>{{Error|BXCL0005|#Errors}} an error occurs while evaluating a query, and if the original error cannot be extracted from the returned error string.<br/>{{Error|BXCL0006|#Errors}} function items (including maps and arrays) cannot be returned.
+
|{{Error|error|#Errors}} an I/O error occurs while transferring data from or to the server.<br/>{{Error|query|#Errors}} an error occurs while evaluating a query, and if the original error cannot be extracted from the returned error string.<br/>{{Error|function|#Errors}} function items (including maps and arrays) cannot be returned.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 95: Line 98:
  
 
==client:close==
 
==client:close==
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
Line 104: Line 108:
 
|-
 
|-
 
|'''Errors'''
 
|'''Errors'''
|{{Error|BXCL0003|#Errors}} an I/O error occurs while transferring data from or to the server.
+
|{{Error|error|#Errors}} an I/O error occurs while transferring data from or to the server.
 
|}
 
|}
  
 
=Errors=
 
=Errors=
 +
 +
{{Mark|Updated with Version 9.0}}:
  
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
Line 113: Line 119:
 
|Description
 
|Description
 
|-
 
|-
|{{Code|BXCL0001}}
+
|{{Code|connect}}
 
| An error occurred while creating a new session (possible reasons: server not available, access denied).
 
| An error occurred while creating a new session (possible reasons: server not available, access denied).
 
|-
 
|-
|{{Code|BXCL0002}}
+
|{{Code|id}}
| The specified session is unknown, or has already been closed.
+
| The id with the specified session is unknown, or has already been closed.
 
|-
 
|-
|{{Code|BXCL0003}}
+
|{{Code|error}}
 
| An I/O error occurred while transferring data from or to the server.
 
| An I/O error occurred while transferring data from or to the server.
 
|-
 
|-
|{{Code|BXCL0004}}
+
|{{Code|command}}
 
| An error occurred while executing a command.
 
| An error occurred while executing a command.
 
|-
 
|-
|{{Code|BXCL0005}}
+
|{{Code|query}}
 
| An error occurred while evaluating a query. Will only be raised if the XQuery error cannot be extracted from the returned error string.
 
| An error occurred while evaluating a query. Will only be raised if the XQuery error cannot be extracted from the returned error string.
 
|-
 
|-
|{{Code|BXCL0006}}
+
|{{Code|function}}
 
| Function items (including maps and arrays) cannot be returned.
 
| Function items (including maps and arrays) cannot be returned.
 
|}
 
|}
  
 
=Changelog=
 
=Changelog=
 +
 +
;Version 9.0
 +
 +
* Updated: error codes updates; errors now use the module namespace
  
 
;Version 8.0
 
;Version 8.0

Revision as of 18:07, 20 November 2017

This XQuery Module contains functions to access BaseX server instances from XQuery. With this module, you can execute database commands and evaluate XQuery expressions.

Please note that the client module should always be used to address independent BaseX server instances. You can create deadlocks if you evaluate a query with a server instance, and if you are addressing the same server instance in your query. See the following example:

(: Retrieve documents from database :)
let $client-id := client:connect('localhost', 1984, 'admin', 'admin')
let $docs := client:query($client-id, 'db:open("conflict")')
(: Create database with same name :)
return db:create('conflict', $docs, $docs ! db:path(.)) 

The read-only query cannot be processed, because the conflict database is currently write-locked by the main query. See Transaction Management for more background information.

Conventions

Template:Mark:

All functions and errors in this module are assigned to the http://basex.org/modules/client namespace, which is statically bound to the client prefix.

Functions

client:connect

Signatures client:connect($host as xs:string, $port as xs:integer, $user as xs:string, $password as xs:string) as xs:anyURI
Summary This function establishes a connection to a remote BaseX server, creates a new client session, and returns a session id. The parameter $host is the name of the database server, $port specifies the server port, and $user and $password represent the login data.
Errors connect: an error occurs while creating the session (possible reasons: server not available, access denied).

client:execute

Signatures client:execute($id as xs:anyURI, $command as xs:string) as xs:string
Summary This function executes a command and returns the result as string. The parameter $id contains the session id returned by client:connect. The $command argument represents a single command, which will be executed by the server.
Errors error: an I/O error occurs while transferring data from or to the server.
command: an error occurs while executing a command.
Examples The following query creates a new database TEST on a remote BaseX server:
client:connect('basex.server.org', 8080, 'admin', 'admin') !
  client:execute(., 'create database TEST')

client:info

Signatures client:info($id as xs:anyURI) as xs:string
Summary This function returns an information string, created by the last call of client:execute. $id specifies the session id.

client:query

Signatures client:query($id as xs:anyURI, $query as xs:string) as item()*
client:query($id as xs:anyURI, $query as xs:string, $bindings as map(*)?) as item()*
Summary Evaluates a query and returns the result as sequence. The parameter $id contains the session id returned by client:connect, and $query represents the query string, which will be evaluated by the server.
Variables and the context item can be declared via $bindings. The specified keys must be QNames or strings:
  • If a key is a QName, it will be directly adopted as variable name.
  • If a key is a string, it may be prefixed with a dollar sign. A namespace can be specified using the Clark Notation. If the specified string is empty, the value will be bound to the context item.
Errors error: an I/O error occurs while transferring data from or to the server.
query: an error occurs while evaluating a query, and if the original error cannot be extracted from the returned error string.
function: function items (including maps and arrays) cannot be returned.
Examples The following query sends a query on a local server instance, binds the integer 123 to the variable $n and returns 246:
let $c := client:connect('localhost', 1984, 'admin', 'admin')
return client:query($c, "declare variable $n external; $n * 2", map { 'n': 123 })

The following query performs a query on a first server, the results of which are passed on to a second server:

let $c1 := client:connect('basex1.server.org', 8080, 'jack', 'C0S19tt2X')
let $c2 := client:connect('basex2.server.org', 8080, 'john', '465wFHe26')
for $it in client:query($c1, '1 to 10')
return client:query($c2, $it || '* 2')

client:close

Signatures client:close($id as xs:anyURI) as empty-sequence()
Summary This function closes a client session. $id specifies the session id.
Opened connections will automatically be closed after the XQuery expression has been evaluated, but it is recommendable to explicitly close them with this function if you open many connections.
Errors error: an I/O error occurs while transferring data from or to the server.

Errors

Template:Mark:

Code Description
connect An error occurred while creating a new session (possible reasons: server not available, access denied).
id The id with the specified session is unknown, or has already been closed.
error An I/O error occurred while transferring data from or to the server.
command An error occurred while executing a command.
query An error occurred while evaluating a query. Will only be raised if the XQuery error cannot be extracted from the returned error string.
function Function items (including maps and arrays) cannot be returned.

Changelog

Version 9.0
  • Updated: error codes updates; errors now use the module namespace
Version 8.0
  • Updated: Bound values may now contain no or more than one item in client:query.
Version 7.5

The module was introduced with Version 7.3.