Client Module - Revision history

CG: Text replacement - "" to ""

2023-12-01T16:36:07Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:30:32Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

2023-11-01T19:36:21Z

2023-11-01T19:36:15Z

2023-10-31T17:53:57Z

2023-07-03T11:11:52Z

client:connect remove <br/>

2023-03-09T13:24:05Z

2023-03-09T13:05:05Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T11:03:41Z

2023-03-09T08:21:23Z

Text replacement - "<br />" to "<br/>"

@@ Line 9: / Line 9: @@
 (: Create database with same name :)
 return db:create('conflict', $docs, $docs ! db:path(.))
-</syntaxhighlight>
+</pre>
 The read-only query cannot be processed, because the <code>conflict</code> database is currently write-locked by the main query. See [[Transaction Management]] for more background information.
@@ Line 59: / Line 59: @@
 client:connect('basex.server.org', 8080, 'admin', '...') !
    client:execute(., 'create database TEST')
-</syntaxhighlight>
+</pre>
 |}
@@ Line 101: / Line 101: @@
 let $c := client:connect('localhost', 1984, 'admin', '...')
 return client:query($c, "declare variable $n external; $n * 2", map { 'n': 123 })
-</syntaxhighlight>
+</pre>
 The following query performs a query on a first server, the results of which are passed on to a second server:
 <pre lang='xquery'>
@@ Line 108: / Line 108: @@
 for $it in client:query($c1, '1 to 10')
 return client:query($c2, $it || '* 2')
-</syntaxhighlight>
+</pre>
 |}

@@ Line 3: / Line 3: @@
 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:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 (: Retrieve documents from database :)
 let $client-id := client:connect('localhost', 1984, 'admin', '...')
@@ Line 56: / Line 56: @@
 | '''Examples'''
 |The following query creates a new database {{Code|TEST}} on a remote BaseX server:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 client:connect('basex.server.org', 8080, 'admin', '...') !
    client:execute(., 'create database TEST')
@@ Line 98: / Line 98: @@
 | '''Examples'''
 |The following query sends a query on a local server instance, binds the integer {{Code|123}} to the variable {{Code|$n}} and returns {{Code|246}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $c := client:connect('localhost', 1984, 'admin', '...')
 return client:query($c, "declare variable $n external; $n * 2", map { 'n': 123 })
 </syntaxhighlight>
 The following query performs a query on a first server, the results of which are passed on to a second server:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $c1 := client:connect('basex1.server.org', 8080, 'jack', 'C0S19tt2X')
 let $c2 := client:connect('basex2.server.org', 8080, 'john', '465wFHe26')

@@ Line 4: / Line 4: @@
 <syntaxhighlight lang="xquery">
-(: Retrieve documents from database  :)
+(: Retrieve documents from database :)
 let $client-id := client:connect('localhost', 1984, 'admin', '...')
 let $docs := client:query($client-id, 'db:get("conflict")')

@@ Line 4: / Line 4: @@
 <syntaxhighlight lang="xquery">
-(: Retrieve documents from database :)
+(: Retrieve documents from database  :)
 let $client-id := client:connect('localhost', 1984, 'admin', '...')
 let $docs := client:query($client-id, 'db:get("conflict")')

@@ Line 76: / Line 76: @@
 ==client:query==
 {| width='100%'
@@ Line 89: / Line 91: @@
 |Evaluates a query and returns the result as sequence. The parameter {{Code|$id}} contains the session id returned by {{Function||client:connect}}, and {{Code|$query}} represents the query string, which will be evaluated by the server.<br/>Variables and the context item can be declared via {{Code|$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 [http://www.jclark.com/xml/xmlns.htm Clark Notation]. If the specified string is empty, the value will be bound to the context item.
+* If a key is a string, it may be prefixed with a dollar sign. A namespace can be specified using the [[XQuery 3.0#Expanded QNames|Expanded QNames]] notation. If the specified string is empty, the value will be bound to the context item.
 |- valign="top"
 |'''Errors'''
@@ Line 151: / Line 153: @@
 =Changelog=
 ;Version 9.0

@@ Line 29: / Line 29: @@
    $username  as xs:string,
    $password  as xs:string
-) as xs:anyURI<br/ ></pre>
+) as xs:anyURI</pre>
 |- valign="top"
 |'''Summary'''

@@ Line 25: / Line 25: @@
 | width='120' | '''Signature'''
 |<pre>client:connect(
-   $host      as xs:string
+   $host      as xs:string,
-   $port      as xs:integer
+   $port      as xs:integer,
-   $username  as xs:string
+   $username  as xs:string,
    $password  as xs:string
 ) as xs:anyURI<br/ ></pre>
@@ Line 44: / Line 44: @@
 | width='120' | '''Signature'''
 |<pre>client:execute(
-   $id       as xs:anyURI
+   $id       as xs:anyURI,
    $command  as xs:string
 ) as xs:string</pre>
@@ Line 81: / Line 81: @@
 | width='120' | '''Signature'''
 |<pre>client:query(
-   $id        as xs:anyURI
+   $id        as xs:anyURI,
-   $query     as xs:string
+   $query     as xs:string,
    $bindings  as map(*)?    := ()
 ) as item()*</pre>

@@ Line 24: / Line 24: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|client:connect|$host as xs:string, $port as xs:integer, $username as xs:string, $password as xs:string|xs:anyURI}}<br/ >
+|<pre>client:connect(
 |- valign="top"
 |'''Summary'''
@@ Line 38: / Line 43: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|client:execute|$id as xs:anyURI, $command as xs:string|xs:string}}
+|<pre>client:execute(
 |- valign="top"
 | '''Summary'''
@@ Line 59: / Line 67: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|client:info|$id as xs:anyURI|xs:string}}
+|<pre>client:info(
 |- valign="top"
 | '''Summary'''
@@ Line 70: / Line 80: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|client:query|$id as xs:anyURI, $query as xs:string|item()*}}<br/>{{Func|client:query|$id as xs:anyURI, $query as xs:string, $bindings as map(*)?|item()*}}
+|<pre>client:query(
 |- valign="top"
 | '''Summary'''
@@ Line 100: / Line 114: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|client:close|$id as xs:anyURI|empty-sequence()}}
+|<pre>client:close(
 |- valign="top"
 | '''Summary'''