Difference between revisions of "Database Module"

From BaseX Documentation
Jump to navigation Jump to search
 
(246 intermediate revisions by 7 users not shown)
Line 3: Line 3:
 
=Conventions=
 
=Conventions=
  
All functions in this module are assigned to the {{Code|http://basex.org/modules/db}} namespace, which is statically bound to the {{Code|db}} prefix.<br/>
+
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/db</nowiki></code> namespace, which is statically bound to the {{Code|db}} prefix.<br/>
All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
 
  
 
==Database Nodes==
 
==Database Nodes==
  
Many function signatures in this and other modules share {{Code|$db}} as argument to reference an existing database. The argument may either be a string, denoting the name of the addressed database, or a single node from an already opened database. The following errors may be raised by these functions:
+
In BaseX, two internal representations exist for nodes.
  
* {{Error|BXDB0001|#Errors}} {{Code|$db}} references an XML node that is not stored in a database, or is no database fragment.
+
* XML fragments are generated by XQuery node constructors.
* {{Error|BXDB0002|#Errors}} the addressed database cannot be opened.
+
* Database nodes are:
 +
** stored in a persistent database on disk;
 +
** nodes of a document that has been generated temporarily with {{Code|fn:doc}}, {{Code|fn:parse-xml}} and other functions; or
 +
** result of a main-memory update operation.
  
Last not but least, the argument may also reference a BaseX-specific ''database fragment''. All XML fragments can be converted to database fragments by applying the [[XQuery_Update#transform|transform]] expression on an XML fragment:
+
Some operations are restricted to database nodes, but you can convert XML fragments to database nodes by applying an empty [[XQuery_Update#update|update]] or [[XQuery_Update#transform|transform]] operation to a node. Two examples:
  
<pre class="brush:xquery">
+
* Retrieve the internal node id of an XML fragment:
copy $c := element hello { 'world' }
+
 
 +
<syntaxhighlight lang="xquery">
 +
let $xml := <xml>hello world</xml> update {}
 +
return db:node-id($xml/text())
 +
</syntaxhighlight>
 +
 
 +
* Puts a marker element around the result of a full-text request (see {{Function|Full-Text|ft:mark}} for more details):
 +
 
 +
<syntaxhighlight lang="xquery">
 +
copy $p := <xml>hello world</xml>
 
modify ()
 
modify ()
return db:text($c, 'world')
+
return ft:mark($p[text() contains text 'word'], 'b')
</pre>
+
</syntaxhighlight>
  
 
=General Functions=
 
=General Functions=
  
==db:info==
+
==db:system==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:info|$db as item()|element(database)}}
+
|{{Func|db:system||element(system)}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns meta information on the database specified by the [[#Database Nodes|database node]] {{Code|$db}}.
+
|Returns general information on the database system the current values of all global and local [[Options]]. The {{Command|INFO}} command returns similar output.
 
|}
 
|}
  
==db:list==
+
==db:option==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:list||xs:string*}}<br/>{{Func|db:list|$db as item()|xs:string*}}<br/>{{Func|db:list|$db as item(), $path as xs:string|xs:string*}}
+
|{{Func|db:option|$name as xs:string|xs:string}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns a string sequence with the names of all databases.<br/>If a [[#Database Nodes|database node]] {{Code|$db}} is specified, all documents and raw files of the specified database are returned.<br/>The list of resources can be further restricted by the {{Code|$path}} argument.
+
|Returns the current value (string, integer, boolean, map) of a global or local [[Options|Option]] with the specified {{Code|$name}}. The {{Command|GET}} command works similar.
 +
|-
 +
| '''Errors'''
 +
|{{Error|option|#Errors}} the specified option is unknown.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:list("docs")}} returns the names of all documents from the database named {{Code|docs}}.
+
* <code>db:option('dbpath')</code> returns the database path string.
 +
* <code>db:option('serializer')</code> returns a map with the current serialization parameters.
 +
* <code>declare option db:chop 'true'; db:option('chop')</code> returns {{Code|true}} (irrespective of the global value).
 
|}
 
|}
  
==db:list-details==
+
==db:info==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:list-details||element(database)*}}<br/>{{Func|db:list-details|$db as item()|element(resource)*}}<br/>{{Func|db:list-details|$db as item(), $path as xs:string|element(resource)*}}
+
|{{Func|db:info|$db as xs:string|element(database)}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns an element sequence with the names of all databases together with their database path, the number of stored resources and the date of modification.<br/>If a [[#Database Nodes|database node]] {{Code|$db}} is specified, all documents and raw files of the specified database together with their content-type, the modification date and the resource type are returned.<br/>The list of resources can be further restricted by the {{Code|$path}} argument.
+
|Returns meta information on the database {{Code|$db}}. The output is similar to the {{Command|INFO DB}} command.
 
|-
 
|-
| '''Examples'''
+
| '''Errors'''
|
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
* {{Code|db:list-details("docs")}} returns the names plus additional data of all documents from the database named {{Code|docs}}.
 
 
|}
 
|}
  
==db:open==
+
==db:property==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:open|$db as item()|document-node()*}}<br />{{Func|db:open|$db as item(), $path as xs:string|document-node()*}}
+
|{{Func|db:property|$db as xs:string, $name as xs:string|xs:anyAtomicType}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns a sequence with all document nodes contained in the database specified by the [[#Database Nodes|database node]] {{Code|$db}}.<br/>The document nodes to be returned can be restricted by the {{Code|$path}} argument.
+
|Returns the value (string, boolean, integer) of a property with the specified {{Code|$name}} in the database {{Code|$db}}. The available properties are the ones returned by [[#db:info|db:info]].
 +
|-
 +
| '''Errors'''
 +
|{{Error|property|#Errors}} the specified property is unknown.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:open("docs")}} returns all documents from the database named {{Code|docs}}.
+
* <code>db:property('db', 'size')</code> returns the number of bytes occupied by the database <code>db</code>.
* {{Code|db:open("docs", "one")}} returns all documents from the database named {{Code|docs}} in the subpath {{Code|one}}.
+
* <code>db:property('xmark', 'textindex')</code> indicates if the <code>xmark</code> database has a text index.
 +
* <code>db:property('discogs', 'uptodate')</code> indicates if the database statistics and index structures of the <code>discogs</code> database are up-to-date.
 
|}
 
|}
  
==db:open-id==
+
==db:list==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:open-id|$db as item(), $id as xs:integer|node()}}
+
|{{Func|db:list||xs:string*}}<br/>{{Func|db:list|$db as xs:string|xs:string*}}<br/>{{Func|db:list|$db as xs:string, $path as xs:string|xs:string*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Opens the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and returns the node with the specified {{Code|$id}} value.<br />Each database node has a persistent ''id'', which remains valid after update operations. If no updates are performed, the ''pre'' value can be requested, which provides access to database nodes in constant time.
+
|The result of this function is dependent on the number of arguments:
 +
* Without arguments, the names of all databases are returned that are accessible to the current user.
 +
* If a database {{Code|$db}} is specified, all documents and raw files of the specified database are returned.
 +
* The list of returned resources can be restricted by the {{Code|$path}} argument.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0009|XQuery Errors#BaseX Errors}} the specified id value does not exist in the database.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:list("docs")}} returns the names of all documents of a database named {{Code|docs}}.
 
|}
 
|}
  
==db:open-pre==
+
==db:list-details==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:open-pre|$db as item(), $pre as xs:integer|node()}}
+
|{{Func|db:list-details||element(database)*}}<br/>{{Func|db:list-details|$db as xs:string|element(resource)*}}<br/>{{Func|db:list-details|$db as xs:string, $path as xs:string|element(resource)*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Opens the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and returns the node with the specified {{Code|$pre}} value.<br />The ''pre'' value provides access to a database node in constant time, but it is ''transient'', i.e., it may change when database updates are performed.
+
|Without arguments, an element is returned for each database that is accessible to the current user:
 +
* An element has a value, which is the name of the database, and several attributes, which contain the number of stored resources, the modification date, the database size on disk (measured in bytes), and a path to the original database input.
 +
If a database {{Code|$db}} is specified, an element for each documents and raw file of the specified database is returned:
 +
* An element has a value, which is the name of the resource, and several attributes, which contain the content type, the modification date, the raw flag (which indicates if the resource is binary or XML), and the size of a resource.
 +
* The value of the size attribute depends on the resource type: for documents, it represents the number of nodes; for binary data, it represents the file size (measured in bytes).
 +
* Returned databases resources can be further restricted by the {{Code|$path}} argument.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0009|XQuery Errors#BaseX Errors}} the specified pre value does not exist in the database.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:open-pre("docs", 0)}} returns the first database node from the database named {{Code|docs}}.
+
* {{Code|db:list-details("shop")}} returns the names plus additional info on all resources of a database named {{Code|shop}}.
 
|}
 
|}
  
==db:system==
+
==db:dir==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:system||element(system)}}
+
|{{Func|db:dir|$db as xs:string, $path as xs:string|element()*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns information on the database system, such as the database path and current database settings.
+
|Returns meta data on all directories and resources of the database {{Code|$db}} in the specified directory {{Code|$path}}. Two types of elements are returned:
 +
* {{Code|resource}} represents a resource. The element value is the directory path; content type, modification date, raw flag (which indicates if the resource is binary or XML), and size of the resource are returned as attributes.
 +
* {{Code|dir}} represents a directory. The element value is the directory path; the modification date is returned as attribute.
 +
Please note that directories are not stored in BaseX. Instead, they result implicitly from the paths of stored resources.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|path|#Errors}} the specified path is invalid.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:dir('shop', 'books')}} returns all entries of the {{Code|books}} directory of a {{Code|shop}} database.
 
|}
 
|}
  
 
==db:backups==
 
==db:backups==
{{Mark|Introduced with Version 7.5:}}
+
 
{|
+
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:backups||element(backup)*}}<br/>{{Func|db:backups|$db as item()|element(backup)*}}
+
|{{Func|db:backups||element(backup)*}}<br/>{{Func|db:backups|$db as xs:string|element(backup)*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns an element sequence containing all available database backups.<br/>If a [[#Database Nodes|database node]] {{Code|$db}} is specified, the sequence will be restricted to the backups matching this database.
+
|Returns an element sequence containing all available database backups.<br/>If a database {{Code|$db}} is specified, the sequence will be restricted to the backups matching this database.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 133: Line 181:
 
=Read Operations=
 
=Read Operations=
  
==db:attribute==
+
==db:open==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:attribute|$db as item(), $string as item()|attribute()*}}<br/>{{Func|db:attribute|$db as item(), $string as item(), $attname as xs:string|attribute()*}}
+
|{{Func|db:open|$db as xs:string|document-node()*}}<br />{{Func|db:open|$db as xs:string, $path as xs:string|document-node()*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns all attribute nodes of the database specified by the [[#Database Nodes|database node]] {{Code|$db}} that have {{Code|$string}} as string value. If available, the value index is used to speed up evaluation.<br />If {{Code|$attname}} is specified, the resulting attribute nodes are filtered by their attribute name.
+
|Opens the database {{Code|$db}} and returns all document nodes.<br/>The document nodes to be returned can be filtered with the {{Code|$path}} argument.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:attribute("DB", "QUERY", "id")/..}} returns the parents of all {{Code|id}} attribute nodes of the database {{Code|DB}} that have {{Code|QUERY}} as string value.
+
* {{Code|db:open("docs")}} returns all documents from the database named {{Code|docs}}.
 +
* {{Code|db:open("db", "one")}} returns all documents from the database named {{Code|db}} located in the path {{Code|one}}.
 +
* <code>for $i in 1 to 3 return db:open("db" || $i)//item</code> returns all item elements from the databases {{Code|db1}}, {{Code|db2}} and {{Code|db3}}.
 
|}
 
|}
  
==db:attribute-range==
+
==db:open-pre==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:attribute-range|$db as item(), $min as xs:string, $max as xs:string|attribute()*}}<br/>{{Func|db:attribute-range|$db as item(), $min as xs:string, $max as xs:string, $attname as xs:string|attribute()*}}
+
|{{Func|db:open-pre|$db as xs:string, $pres as xs:integer*|node()*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns all attributes of the database specified by the [[#Database Nodes|database node]] {{Code|$db}}, the string values of which are larger than or equal to {{Code|$min}} and smaller than or equal to {{Code|$max}}. If available, the value index is used to speed up evaluation.
+
|Opens the database {{Code|$db}} and returns all distinct nodes with the pre values {{Code|$pres}} in document order.<br/>The [[Node Storage#PRE Value|PRE value]] provides very fast access to an existing database node, but it will change whenever a node with a smaller ''pre'' values is added to or deleted from a database.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|range|#Errors}} the specified pre value does not exist in the database.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:attribute-range("DB", "id456", "id473", 'id')}} returns all {{Code|@id}} attributes of the database {{Code|DB}} that have a string value in between {{Code|id456}} and {{Code|id473}}.
+
* {{Code|db:open-pre("docs", 0)}} returns the first database node from the database named {{Code|docs}}.
 +
|}
 +
 
 +
==db:open-id==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:open-id|$db as xs:string, $ids as xs:integer*|node()*}}
 +
|-
 +
| '''Summary'''
 +
|Opens the database {{Code|$db}} and returns all distinct nodes with the specified {{Code|$ids}} in document order.<br />Each database node has a ''persistent'' [[Node Storage#ID Value|ID value]]. Access to the node id can be sped up by turning on the {{Option|UPDINDEX}} option.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|range|#Errors}} the specified id value does not exist in the database.
 
|}
 
|}
  
==db:fulltext==
+
==db:node-pre==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:fulltext|$db as item(), $terms as xs:string|text()*}}
+
|{{Func|db:node-pre|$nodes as node()*|xs:integer*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns all text nodes from the full-text index of the database specified by the [[#Database Nodes|database node]] {{Code|$db}} that contain the text specified as {{Code|$terms}}.<br/>The options used for building the full-text will also be applied to the search terms. As an example, if the index terms have been stemmed, the search string will be stemmed as well.
+
|Returns the ''pre'' values of the specified {{Code|$nodes}}, which must all be [[#Database Nodes|database nodes]].<br/>The [[Node Storage#PRE Value|PRE value]] provides very fast access to an existing database node, but it will change whenever a node with a smaller ''pre'' values is added to or deleted from a database.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0004|#Errors}} the full-text index is not available.
+
|{{Error|node|#Errors}} {{Code|$nodes}} contains a node which is not stored in a database.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:fulltext("DB", "QUERY")}} returns all text nodes of the database {{Code|DB}} that contain the string {{Code|QUERY}}.
+
* {{Code|db:node-pre(doc("input"))}} returns {{Code|0}} if the database {{Code|input}} contains a single document.
 
|}
 
|}
  
 
==db:node-id==
 
==db:node-id==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
 
|{{Func|db:node-id|$nodes as node()*|xs:integer*}}
 
|{{Func|db:node-id|$nodes as node()*|xs:integer*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns the ''id'' values of the nodes supplied by {{Code|$nodes}}, which must all be [[#Database Nodes|database nodes]].<br/>Each database node has a persistent ''id'', which remains valid after update operations. If so far no updates have been performed, the ''pre'' value is equal to the ''id'' value and can be requested instead, which provides access to database nodes in constant time.
+
|Returns the ''id'' values of the specified {{Code|$nodes}}, which must all be [[#Database Nodes|database nodes]].<br/>Each database node has a ''persistent'' [[Node Storage#ID Value|ID value]]. Access to the node id can be sped up by turning on the {{Option|UPDINDEX}} option.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0001|#Errors}} {{Code|$nodes}} contains a node which is not a [[#Database Nodes|database node]].
+
|{{Error|node|#Errors}} {{Code|$nodes}} contains a node which is not stored in a database.
 
|}
 
|}
  
==db:node-pre==
+
==db:retrieve==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:node-pre|$nodes as node()*|xs:integer*}}
+
|{{Func|db:retrieve|$db as xs:string, $path as xs:string|xs:base64Binary}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns the ''pre'' values of the nodes supplied by {{Code|$nodes}}, which must all be [[#Database Nodes|database nodes]]. <br/>The ''pre'' value provides access to a database node in constant time, but it is ''transient'', i.e., it may change when database updates are performed.
+
|Returns a [[Binary Data|binary resource]] addressed by the database {{Code|$db}} and {{Code|$path}} as [[Streaming Module|streamable]] {{Code|xs:base64Binary}}.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0001|#Errors}} {{Code|$nodes}} contains a node which is not a [[#Database Nodes|database node]].
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|mainmem|#Errors}} the database is not ''persistent'' (stored on disk).
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:node-pre(doc("input"))}} returns {{Code|0}} if the database {{Code|input}} contains a single document.
+
* {{Code|db:retrieve("DB", "music/01.mp3")}} returns the specified audio file as raw data.
 +
* <code><nowiki>stream:materialize(db:retrieve("DB", "music/01.mp3"))</nowiki></code> materializes the streamable result in main-memory before returning it.
 +
* <code><nowiki>convert:binary-to-string(db:retrieve("DB", "info.txt"), 'UTF-8')</nowiki></code> converts a binary database resource as UTF-8 text and returns a string.
 
|}
 
|}
  
==db:retrieve==
+
==db:export==
  
{|
+
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:retrieve|$db as item(), $path as xs:string|xs:base64Binary}}
+
|{{Func|db:export|$db as xs:string, $path as xs:string|empty-sequence()}}<br />{{Func|db:export|$db as xs:string, $path as xs:string, $params as item()|empty-sequence()}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns a binary database resource addressed by the [[#Database Nodes|database node]] {{Code|$db}} and {{Code|$path}}.
+
|Exports the specified database {{Code|$db}} to the specified file {{Code|$path}}. Existing files will be overwritten.<br />The {{Code|$params}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br />
 +
* either as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element:
 +
<syntaxhighlight lang="xml">
 +
<output:serialization-parameters>
 +
  <output:method value='xml'/>
 +
  <output:cdata-section-elements value="div"/>
 +
  ...
 +
</output:serialization-parameters>
 +
</syntaxhighlight>
 +
* or as map, which contains all key/value pairs:
 +
<syntaxhighlight lang="xquery">
 +
map { "method": "xml", "cdata-section-elements": "div", ... }
 +
</syntaxhighlight>
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0003|#Errors}} the databse is not ''persistent'' (stored on disk).<br/>{{Error|FODC0002|XQuery Errors#Functions Errors}} the addressed resource cannot be retrieved.<br/>{{Error|FODC0007|XQuery Errors#Functions Errors}} the specified path is invalid.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
|
+
| Export all files as text:<br/>
* {{Code|declare option output:method 'raw';<br/>db:retrieve("DB", "music/01.mp3")}} returns the specified audio file as raw data.
+
<syntaxhighlight lang="xquery">
 +
db:export("DB", "/home/john/xml/texts", map { 'method': 'text' })
 +
</syntaxhighlight>
 +
The following query can be used to export parts of the database:
 +
<syntaxhighlight lang="xquery">
 +
let $target := '/home/john/xml/target'
 +
for $doc in db:open('DB', 'collection')
 +
let $path := $target || db:path($doc)
 +
return (
 +
  file:create-dir(file:parent($path)),
 +
  file:write($path, $doc)
 +
)
 +
</syntaxhighlight>
 
|}
 
|}
 +
 +
=Value Indexes=
  
 
==db:text==
 
==db:text==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:text|$db as item(), $string as item()|text()*}}
+
|{{Func|db:text|$db as xs:string, $strings as xs:string*|text()*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns all text nodes of the database specified by the [[#Database Nodes|database node]] {{Code|$db}} that have {{Code|$string}} as their string value. If available, the value index is used to speed up evaluation.
+
|Returns all text nodes of the database {{Code|$db}} that have one of the specified {{Code|$strings}} as values and that are stored in the text index.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|no-index|#Errors}} the index is not available.<br/>
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 241: Line 348:
  
 
==db:text-range==
 
==db:text-range==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:text-range|$db as item(), $min as xs:string, $max as xs:string|text()*}}
+
|{{Func|db:text-range|$db as xs:string, $min as xs:string, $max as xs:string|text()*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns all text nodes of the database specified by the [[#Database Nodes|database node]] {{Code|$db}} that are located in between the {{Code|$min}} and {{Code|$max}} strings. If available, the value index is used to speed up evaluation.
+
|Returns all text nodes of the database {{Code|$db}} whose values are between {{Code|$min}} and {{Code|$max}} and that are stored in the text index.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|no-index|#Errors}} the index is not available.<br/>
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
 
* {{Code|db:text-range("DB", "2000", "2001")}} returns all text nodes of the database {{Code|DB}} that are found in between {{Code|2000}} and {{Code|2001}}.
 
* {{Code|db:text-range("DB", "2000", "2001")}} returns all text nodes of the database {{Code|DB}} that are found in between {{Code|2000}} and {{Code|2001}}.
 +
|}
 +
 +
==db:attribute==
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:attribute|$db as xs:string, $strings as xs:string*|attribute()*}}<br/>{{Func|db:attribute|$db as xs:string, $strings as xs:string*, $name as xs:string|attribute()*}}
 +
|-
 +
| '''Summary'''
 +
|Returns all attribute nodes of the database {{Code|$db}} that have one of the specified {{Code|$strings}} as values and that are stored in the attribute index.<br />If {{Code|$name}} is specified, the resulting attribute nodes are filtered by their attribute name.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|no-index|#Errors}} the index is not available.<br/>
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:attribute("DB", "QUERY", "id")/..}} returns the parents of all {{Code|id}} attribute nodes of the database {{Code|DB}} that have {{Code|QUERY}} as string value.
 +
|}
 +
 +
==db:attribute-range==
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:attribute-range|$db as xs:string, $min as xs:string, $max as xs:string|attribute()*}}<br/>{{Func|db:attribute-range|$db as xs:string, $min as xs:string, $max as xs:string, $name as xs:string|attribute()*}}
 +
|-
 +
| '''Summary'''
 +
|Returns all attributes of the database {{Code|$db}}, the string values of which are larger than or equal to {{Code|$min}} and smaller than or equal to {{Code|$max}} and that are stored in the attribute index.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|no-index|#Errors}} the index is not available.<br/>
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:attribute-range("DB", "id456", "id473", 'id')}} returns all {{Code|@id}} attributes of the database {{Code|DB}} that have a string value in between {{Code|id456}} and {{Code|id473}}.
 +
|}
 +
 +
==db:token==
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:token|$db as xs:string, $tokens as xs:string*|attribute()*}}<br/>{{Func|db:token|$db as xs:string, $tokens as xs:string*, $name as xs:string|attribute()*}}
 +
|-
 +
| '''Summary'''
 +
|Returns all attribute nodes of the database {{Code|$db}} the values of which contain one of the specified {{Code|$tokens}}.<br />If {{Code|$name}} is specified, the resulting attribute nodes are filtered by their attribute name.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|no-index|#Errors}} the index is not available.<br/>
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:token("DB", "row", "class")/parent::div}} returns all {{Code|div}} nodes of database {{Code|DB}} with a {{Code|class}} attribute that contains the token {{Code|row}}.
 
|}
 
|}
  
Line 259: Line 424:
  
 
==db:create==
 
==db:create==
{{Mark|Introduced with Version 7.5:}}
+
 
{|
+
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:create|$db as xs:string|empty-sequence()}}<br/>{{Func|db:create|$db as xs:string, $inputs as item()*|empty-sequence()}}<br/>{{Func|db:create|$db as xs:string, $inputs as item()*, $paths as xs:string*|empty-sequence()}}<br/>{{Func|db:create|$db as xs:string, $inputs as item()*, $paths as xs:string*, $options as map(*)?|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Creates a new database with name {{Code|$db}} and adds initial documents specified via {{Code|$inputs}} to the specified {{Code|$paths}}:
 +
* {{Code|$inputs}} may be strings or nodes:
 +
** nodes may be of any type except for attributes
 +
** strings can be a URI pointing to a file/directory or an XML string (which is detected by the leading <code>&lt;</code> character)
 +
** a path must be specified if the input is not a file or directory reference
 +
* The parsing and indexing behavior can be controlled via {{Code|$options}}:
 +
** allowed options are {{Option|ADDCACHE}} and the [[Options#Indexing|indexing]], [[Options#Full-Text Indexing|full-text indexing]], [[Options#Parsing|parsing]] and [[Options#XML Parsing|XML parsing]] options, all in lower case
 +
** parsing options will only impact string input (URIs, XML strings), because nodes have already been parsed.
 +
* An existing database will be overwritten.
 +
* Database creation takes place after most other update operations (see [[XQuery Update#Pending Update List|Pending Update List]]). As a consequence, a newly created database cannot be addressed in the same query.
 +
|-
 +
| '''Errors'''
 +
|{{Error|lock|#Errors}} a database is opened by another process.<br/>{{Error|name|#Errors}} the specified name is not a [[Commands#Valid_Names|valid database name]].<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.<br/>{{Error|args|#Errors}} the number of specified inputs and paths differs.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:create("DB")}} creates the empty database {{Code|DB}}.
 +
* {{Code|db:create("DB", "/home/dir/doc.xml")}} creates the database {{Code|DB}} and adds the document {{Code|/home/dir/doc.xml}} as initial content.
 +
* {{Code|db:create("DB", <a/>, "doc.xml")}} creates the database {{Code|DB}} and adds the document with content {{Code|&lt;a/&gt;}} under the name {{Code|doc.xml}}.
 +
* {{Code|db:create("DB", "/home/dir/", "docs/dir")}} creates the database {{Code|DB}} and adds the documents in {{Code|/home/dir}} to the database under the path {{Code|docs/dir}}.
 +
* <code>db:create("DB", file:list('.'), (), map { 'ftindex': true() })</code> adds all files of the current working directory to a new database, preserving relative filesystem paths and creating a full-text index.
 +
|}
 +
 
 +
==db:drop==
 +
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:create|$db as xs:string|empty-sequence()}}<br/>{{Func|db:create|$db as xs:string, $input as item()|empty-sequence()}}<br/>{{Func|db:create|$db as xs:string, $input as item(), $path as xs:string|empty-sequence()}}
+
|{{Func|db:drop|$db as xs:string|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates a new database with name {{Code|$db}} and adds the initial document {{Code|$input}} to the specified {{Code|$path}}.<br/>{{Code|$input}} may be a string or a node different than attribute. If the {{Code|$input}} source is not a file or a folder, {{Code|$path}} must be specified.
+
|Drops the database {{Code|$db}} and all connected resources.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|FODC0002|XQuery Errors#Functions Errors}} {{Code|$input}} points to an unknown resource.<br/>{{Error|FOUP0001|XQuery Errors#Update Errors}} {{Code|$input}} is neither string nor a document node.<br/>{{Error|BXDB0011|#Errors}} {{Code|$db}} is not a valid database name.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|lock|#Errors}} a database is opened by another process.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:create("DB", "/home/dir/doc.xml")}} creates the database {{Code|DB}} and adds the file {{Code|/home/dir/doc.xml}} as initial content.
+
* {{Code|db:drop("DB")}} drops the database {{Code|DB}}.
* {{Code|db:create("DB", "<a/>", "doc.xml")}} creates the database {{Code|DB}} and adds the document with content {{Code|&lt;a/&gt;}} under the name {{Code|doc.xml}}.
 
 
|}
 
|}
  
 
==db:add==
 
==db:add==
{{Mark|Updated in Version 7.5:}} Node inputs will be automatically converted to document nodes.
+
 
{|
+
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:add|$db as item(), $input as item()|empty-sequence()}}<br/>{{Func|db:add|$db as item(), $input as item(), $path as xs:string|empty-sequence()}}
+
|{{Func|db:add|$db as xs:string, $input as item()|empty-sequence()}}<br/>{{Func|db:add|$db as xs:string, $input as item(), $path as xs:string?|empty-sequence()}}<br/>{{Func|db:add|$db as xs:string, $input as item(), $path as xs:string?, $options as map(*)?|empty-sequence()|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Adds documents specified by {{Code|$input}} to the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and the specified {{Code|$path}}.<br/>{{Code|$input}} may be a string or a node different than attribute.
+
|Adds documents specified by {{Code|$input}} to the database {{Code|$db}} with the specified {{Code|$path}}:
 +
* A document with the same path may occur more than once in a database. If you want to enforce single instances, use [[#db:replace|db:replace]] instead.
 +
* See [[#db:create|db:create]] for more details on the input and path arguments.
 +
* The parsing behavior can be controlled via {{Code|$options}}:
 +
** allowed options are {{Option|ADDCACHE}} and the [[Options#Parsing|parsing]] and [[Options#XML Parsing|XML parsing]] options, all in lower case
 +
** parsing options will only impact string input (URIs, XML strings), because nodes have already been parsed
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|FODC0002|XQuery Errors#Functions Errors}} {{Code|$input}} points to an unknown resource.<br/>{{Error|FOUP0001|XQuery Errors#Update Errors}} {{Code|$input}} is neither string nor a document node.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:add("DB", "/home/dir/doc.xml")}} adds the file {{Code|/home/dir/doc.xml}} to the database {{Code|DB}}.
+
* <code>db:add("DB", "/home/dir/doc.xml")</code> adds the file {{Code|/home/dir/doc.xml}} to the database {{Code|DB}}.
* {{Code|db:add("DB", "<a/>", "doc.xml")}} adds a document with content {{Code|&lt;a/&gt;}} to the database {{Code|DB}} under the name {{Code|doc.xml}}.
+
* <code>db:add("DB", <a/>, "doc.xml")</code> adds a document node to the database {{Code|DB}} under the name {{Code|doc.xml}}.
* {{Code|db:add("DB", <a/>, "doc.xml")}} adds a document node to the database {{Code|DB}} under the name {{Code|doc.xml}}.
+
* <code>db:add("DB", "/home/dir", "docs/dir", map { 'addcache': true() })</code> adds all documents in {{Code|/home/dir}} to the database {{Code|DB}} under the path {{Code|docs/dir}}. In order to reduce memory consumption, the files will be cached before being added to the database.
* {{Code|db:add("DB", "/home/dir", "docs/dir")}} adds all documents in {{Code|/home/dir}} to the database {{Code|DB}} under the path {{Code|docs/dir}}.
 
 
|}
 
|}
  
 
==db:delete==
 
==db:delete==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:delete|$db as item(), $path as xs:string|empty-sequence()}}
+
|{{Func|db:delete|$db as xs:string, $path as xs:string|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Deletes document(s), specified by {{Code|$path}}, from the database specified by the [[#Database Nodes|database node]] {{Code|$db}}.
+
|Deletes resource(s), specified by {{Code|$path}}, from the database {{Code|$db}}.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|path|#Errors}} the specified path is invalid.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:delete("DB", "docs/dir/doc.xml")}} deletes the resource {{Code|docs/dir/doc.xml}} from {{Code|DB}}.
 +
* {{Code|db:delete("DB", "docs/dir")}} deletes all resources from {{Code|DB}} in the specified path {{Code|docs/dir}}.
 +
|}
 +
 
 +
==db:copy==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:copy|$db as xs:string, $name as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Creates a copy of the database {{Code|$db}}, which will be called {{Code|$name}}.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|lock|#Errors}} a database is opened by another process.<br/>{{Error|name|#Errors}} invalid database name.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 +
|}
 +
 
 +
==db:alter==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:alter|$db as xs:string, $name as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Renames the database {{Code|$db}} to {{Code|$name}}.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|lock|#Errors}} a database is opened by another process.<br/>{{Error|name|#Errors}} invalid database name.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 +
|}
 +
 
 +
==db:create-backup==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:create-backup|$db as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Creates a backup of the database {{Code|$db}}.
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|name|#Errors}} invalid database name.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:create-backup("DB")}} creates a backup of the database {{Code|DB}}.
 +
|}
 +
 
 +
==db:drop-backup==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:drop-backup|$name as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Drops all backups of the database with the specified {{Code|$name}}. If the given {{Code|$name}} points to a specific backup file, only this specific backup file is deleted.
 +
|-
 +
| '''Errors'''
 +
|{{Error|backup|#Errors}} No backup file found.<br/>{{Error|name|#Errors}} invalid database name.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:drop-backup("DB")}} drops all backups of the database {{Code|DB}}.
 +
* {{Code|db:drop-backup("DB-2014-03-13-17-36-44")}} drops the specific backup file {{Code|DB-2014-03-13-17-36-44.zip}} of the database {{Code|DB}}.
 +
|}
 +
 
 +
==db:alter-backup==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:alter-backup|$name as xs:string, $new-name as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Renames all backups of the database with the specified {{Code|$name}} to {{Code|$new-name}}. The directory inside the archive will be renamed as well. If the given {{Code|$name}} points to a specific backup file, only this specific backup file will be renamed.
 +
|-
 +
| '''Errors'''
 +
|{{Error|backup|#Errors}} No backup file found.<br/>{{Error|name|#Errors}} invalid database name.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|db:alter-backup("DB", "DB2)}} renames all backups of the database {{Code|DB}} to {{Code|DB2}}.
 +
|}
 +
 
 +
==db:restore==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:restore|$name as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Restores the database with the specified {{Code|$name}}. The {{Code|$name}} may include the timestamp of the backup file.
 +
|-
 +
| '''Errors'''
 +
|{{Error|lock|#Errors}} a database is opened by another process.<br/>{{Error|name|#Errors}} invalid database name.<br/>{{Error|no-backup|#Errors}} No backup found.<br/>{{Error|conflict|#Errors}} the same database was addressed more than once.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:delete("DB", "docs/dir/doc.xml")}} deletes the document {{Code|docs/dir/doc.xml}} in the database {{Code|DB}}.
+
* {{Code|db:restore("DB")}} restores the database {{Code|DB}}.
* {{Code|db:delete("DB", "docs/dir")}} deletes all documents with paths beginning with {{Code|docs/dir}} in the database {{Code|DB}}.
+
* {{Code|db:restore("DB-2014-03-13-18-05-45")}} restores the database {{Code|DB}} from the backup file with the given timestamp.
 
|}
 
|}
  
 
==db:optimize==
 
==db:optimize==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:optimize|$db as item()|empty-sequence()}}<br/>{{Func|db:optimize|$db as item(), $all as xs:boolean|empty-sequence()}}
+
|{{Func|db:optimize|$db as xs:string|empty-sequence()}}<br/>{{Func|db:optimize|$db as xs:string, $all as xs:boolean|empty-sequence()}}<br/>{{Func|db:optimize|$db as xs:string, $all as xs:boolean, $options as map(*)?|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Optimizes the meta data and indexes of the database specified by the [[#Database Nodes|database node]] {{Code|$db}}.<br/>If {{Code|$all}} is set to {{Code|true()}}, the complete database will be rebuilt.
+
|Optimizes the meta data and indexes of the database {{Code|$db}}.<br/>If {{Code|$all}} is {{Code|true}}, the complete database will be rebuilt.<br/>The {{Code|$options}} argument can be used to control indexing. The syntax is identical to the [[#db:create|db:create]] function: Allowed options are all [[Options#Indexing|indexing]] and [[Options#Full-Text|full-text]] options. {{Option|UPDINDEX}} is only supported if {{Code|$all}} is {{Code|true}}.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|FOUP0002|XQuery Errors#Update Errors}} an error occurred while optimizing the database.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
 
* {{Code|db:optimize("DB")}} optimizes the database structures of the database {{Code|DB}}.
 
* {{Code|db:optimize("DB")}} optimizes the database structures of the database {{Code|DB}}.
* {{Code|db:optimize("DB", true())}} optimizes all database structures of the database {{Code|DB}}.
+
* <code>db:optimize("DB", true(), map { 'ftindex': true() })</code> optimizes all database structures of the database {{Code|DB}} and creates a full-text index.
 
|}
 
|}
  
 
==db:rename==
 
==db:rename==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:rename|$db as item(), $path as xs:string, $newpath as xs:string|empty-sequence()}}
+
|{{Func|db:rename|$db as xs:string, $source as xs:string, $target as xs:string|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Renames document(s), specified by {{Code|$path}} to {{Code|$newpath}} in the database specified by the [[#Database Nodes|database node]] {{Code|$db}}.
+
|Moves all resources(s) of database {{Code|$db}}, which are found in the supplied {{Code|$source}} path, to the supplied {{Code|$target}} path. The paths may point to single resources or directories. No updates will take place if a non-existing source path is supplied.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0008|#Errors}} new document names would be empty.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|path|#Errors}} the specified source or target path, or one of its descendants, is invalid.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
* {{Code|db:rename("DB", "docs/dir/doc.xml", "docs/dir/newdoc.xml")}} renames the document {{Code|docs/dir/doc.xml}} to {{Code|docs/dir/newdoc.xml}} in the database {{Code|DB}}.
+
* {{Code|db:rename("DB", "docs/dir/doc.xml", "docs/dir/newdoc.xml")}} renames the resource {{Code|docs/dir/doc.xml}} to {{Code|docs/dir/newdoc.xml}} in the database {{Code|DB}}.
* {{Code|db:rename("DB", "docs/dir", "docs/newdir")}} renames all documents with paths beginning with {{Code|docs/dir}} to paths beginning with {{Code|docs/newdir}} in the database {{Code|DB}}.
+
* {{Code|db:rename("DB", "docs/dir", "docs/newdir")}} moves all resources in the database {{Code|DB}} from {{Code|docs/dir}} to {Code|docs/newdir}}.
 
|}
 
|}
  
 
==db:replace==
 
==db:replace==
{{Mark|Updated in Version 7.5:}} Node inputs will be automatically converted to document nodes.
+
 
{|
+
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:replace|$db as item(), $path as xs:string, $input as item()|empty-sequence()}}
+
|{{Func|db:replace|$db as xs:string, $path as xs:string, $input as item()|empty-sequence()}}<br/>{{Func|db:replace|$db as xs:string, $path as xs:string, $input as item(), $options as map(*)?|empty-sequence()|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Replaces a document, specified by {{Code|$path}}, in the database specified by the [[#Database Nodes|database node]] {{Code|$db}} with the content of {{Code|$input}}, or adds it as a new document.
+
|Replaces a resource, specified by {{Code|$path}}, in the database {{Code|$db}} with the contents of {{Code|$input}}, or adds it as a new resource:
 +
* See [[#db:create|db:create]] for more details on the input argument.
 +
* The parsing behavior can be controlled via {{Code|$options}}:
 +
** allowed options are {{Option|ADDCACHE}} and the [[Options#Parsing|parsing]] and [[Options#XML Parsing|XML parsing]] options, all in lower case
 +
** parsing options will only impact string input (URIs, XML strings), because nodes have already been parsed
 +
* For historical reasons, the order of the 2nd and 3rd argument is different to [[#db:add|db:add]] and [[#db:create|db:create]]
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0006|#Errors}} {{Code|$path}} is not a single document path.<br/>{{Error|FODC0002|XQuery Errors#Functions Errors}} {{Code|$input}} is a string representing a path, which cannot be read.<br/>{{Error|FOUP0001|XQuery Errors#Update Errors}} {{Code|$input}} is neither a string nor a document node.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|target|#Errors}} the path points to a directory.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 367: Line 679:
 
* {{Code|db:replace("DB", "docs/dir/doc.xml", "<a/>")}} replaces the content of the document {{Code|docs/dir/doc.xml}} in the database {{Code|DB}} with {{Code|&lt;a/&gt;}}.
 
* {{Code|db:replace("DB", "docs/dir/doc.xml", "<a/>")}} replaces the content of the document {{Code|docs/dir/doc.xml}} in the database {{Code|DB}} with {{Code|&lt;a/&gt;}}.
 
* {{Code|db:replace("DB", "docs/dir/doc.xml", document { <a/> })}} replaces the content of the document {{Code|docs/dir/doc.xml}} in the database {{Code|DB}} with the specified document node.
 
* {{Code|db:replace("DB", "docs/dir/doc.xml", document { <a/> })}} replaces the content of the document {{Code|docs/dir/doc.xml}} in the database {{Code|DB}} with the specified document node.
 +
The following query can be used to import files from a directory to a database:
 +
<syntaxhighlight lang="xquery">
 +
let $source := '/home/john/xml/source'
 +
for $file in file:list($source, true())
 +
let $path := $source || $file
 +
where not(file:is-dir($path))
 +
return db:replace('db', $file, doc($path))
 +
</syntaxhighlight>
 
|}
 
|}
  
 
==db:store==
 
==db:store==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:store|$db as item(), $path as xs:string, $input as item()|empty-sequence()}}
+
|{{Func|db:store|$db as xs:string, $path as xs:string, $input as item()|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Stores a binary resource specified by {{Code|$input}} in the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and the location specified by {{Code|$path}}.
+
|Replaces a binary resource specified by {{Code|$input}} in the database {{Code|$db}} and the location specified by {{Code|$path}}, or adds it as new resource.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXDB0003|#Errors}} the databse is not ''persistent'' (stored on disk).<br/>{{Error|FODC0007|XQuery Errors#Functions Errors}} the specified path is invalid.<br/>{{Error|FOUP0002|XQuery Errors#Update Errors}} the resource cannot be stored at the specified location.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.<br/>{{Error|mainmem|#Errors}} the database is not ''persistent'' (stored on disk).
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
 
* {{Code|db:store("DB", "video/sample.mov", file:read-binary('video.mov'))}} stores the addressed video file at the specified location.
 
* {{Code|db:store("DB", "video/sample.mov", file:read-binary('video.mov'))}} stores the addressed video file at the specified location.
 +
* With the following query, you can copy full directories:
 +
<syntaxhighlight lang="xquery">
 +
let $db := 'db'
 +
let $src-path := 'src/'
 +
let $trg-path := 'trg/'
 +
for $src in db:list($db, $src-path)
 +
where db:is-raw($db, $src)
 +
let $trg := $trg-path || substring-after($src, $src-path)
 +
return db:store($db, $trg, db:retrieve($db, $src))
 +
</syntaxhighlight>
 
|}
 
|}
  
==db:output==
+
==db:flush==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:output|$data as item()*|empty-sequence()}}
+
|{{Func|db:flush|$db as xs:string|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This function can be used to both perform updates and return results in a single query. The argument of the function will be evaluated, and the resulting value will be cached and returned after the updates on the ''pending update list'' have been processed.<br/>The function can only be used together with [[XQuery Update#Updating Expressions|updating expressions]]; if the function is called within a transform expression, its results will be discarded.
+
|Explicitly flushes the buffers of the database {{Code|$db}}. This command is only useful if {{Option|AUTOFLUSH}} has been set to {{Code|false}}.
 
|-
 
|-
| '''Examples'''
+
| '''Errors'''
|
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
* {{Code|db:output("Prices have been deleted."), delete node //price}} deletes all {{Code|price}} elements in a database and returns an info message.
 
 
|}
 
|}
  
==db:flush==
+
=Helper Functions=
  
{{Mark|Introduced with Version 7.3:}}
+
==db:name==
  
{|
+
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:flush|$db as item()|empty-sequence()}}
+
|{{Func|db:name|$node as node()|xs:string}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Explicitly flushes the buffers of the database specified by the [[#Database Nodes|database node]] {{Code|$db}}. This command is only useful if [[Options#AUTOFLUSH|AUTOFLUSH]] has been set to {{Code|false}}.
+
|Returns the name of the database in which the specified [[#Database Nodes|database node]] {{Code|$node}} is stored.
 +
|-
 +
| '''Errors'''
 +
|{{Error|node|#Errors}} {{Code|$nodes}} contains a node which is not stored in a database.
 
|}
 
|}
  
=Helper Functions=
+
==db:path==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:path|$node as node()|xs:string}}
 +
|-
 +
| '''Summary'''
 +
|Returns the path of the database document in which the specified [[#Database Nodes|database node]] {{Code|$node}} is stored.
 +
|-
 +
| '''Errors'''
 +
|{{Error|node|#Errors}} {{Code|$nodes}} contains a node which is not stored in a database.
 +
|}
  
 
==db:exists==
 
==db:exists==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:exists|$db as item()|xs:boolean}}<br/>{{Func|db:exists|$db as item(), $path as xs:string|xs:boolean}}
+
|{{Func|db:exists|$db as xs:string|xs:boolean}}<br/>{{Func|db:exists|$db as xs:string, $path as xs:string|xs:boolean}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Checks if the database specified by the [[#Database Nodes|database node]] {{Code|$db}} or the resource specified by {[Mono|$path}} exists. {{Code|false}} is returned if a database directory has been addressed.
+
|Checks if the database {{Code|$db}} or the resource specified by {{Code|$path}} exists. {{Code|false}} is returned if a database directory has been addressed.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 431: Line 778:
  
 
==db:is-raw==
 
==db:is-raw==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:is-raw|$db as item(), $path as xs:string|xs:boolean}}
+
|{{Func|db:is-raw|$db as xs:string, $path as xs:string|xs:boolean}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Checks if the specified resource in the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and the path {{Code|$path}} exists, and if it is a raw file.
+
|Checks if the specified resource in the database {{Code|$db}} and the path {{Code|$path}} exists, and if it is a [[Binary Data|binary resource]].
 +
|-
 +
| '''Errors'''
 +
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 445: Line 796:
  
 
==db:is-xml==
 
==db:is-xml==
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|db:is-xml|$db as xs:string, $path as xs:string|xs:boolean}}
 
|-
 
|-
| width='90' | '''Signatures'''
+
| '''Errors'''
|{{Func|db:is-xml|$db as item(), $path as xs:string|xs:boolean}}
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Checks if the specified resource in the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and the path {{Code|$path}} exists, and if it is an XML document.
+
|Checks if the specified resource in the database {{Code|$db}} and the path {{Code|$path}} exists, and if it is an XML document.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 459: Line 814:
  
 
==db:content-type==
 
==db:content-type==
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|db:content-type|$db as item(), $path as xs:string|xs:string}}
+
|{{Func|db:content-type|$db as xs:string, $path as xs:string|xs:string}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Retrieves the content type of a resource in the database specified by the [[#Database Nodes|database node]] {{Code|$db}} and the path {{Code|$path}}.<br/>The file extension is used to recognize the content-type of a resource stored in the database. Content-type {{Code|application/xml}} will be returned for any XML document stored in the database, regardless of its file name extension.
+
|Retrieves the content type of a resource in the database {{Code|$db}} and the path {{Code|$path}}.<br/>The file extension is used to recognize the content-type of a resource stored in the database. Content-type {{Code|application/xml}} will be returned for any XML document stored in the database, regardless of its file name extension.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|FODC0002|XQuery Errors#Functions Errors}} the addressed resource is not found or cannot be retrieved.
+
|{{Error|open|#Errors}} the addressed database does not exist or could not be opened.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 475: Line 831:
 
* {{Code|db:content-type("DB", "docs/doc01.xml")}} returns {{Code|application/xml}}.
 
* {{Code|db:content-type("DB", "docs/doc01.xml")}} returns {{Code|application/xml}}.
 
* {{Code|db:content-type("DB", "docs/doc01")}} returns {{Code|application/xml}}, if {{Code|db:is-xml("DB", "docs/doc01")}} returns {{Code|true}}.
 
* {{Code|db:content-type("DB", "docs/doc01")}} returns {{Code|application/xml}}, if {{Code|db:is-xml("DB", "docs/doc01")}} returns {{Code|true}}.
|}
 
 
==db:event==
 
{|
 
|-
 
| width='90' | '''Signatures'''
 
|{{Func|db:event|$name as xs:string, $query as item()|empty-sequence()}}
 
|-
 
| '''Summary'''
 
|Executes a {{Code|$query}} and sends the resulting value to all clients watching the [[Events|Event]] with the specified {{Code|$name}}. The query may also perform updates; no event will be sent to the client that fired the event.
 
|-
 
| '''Errors'''
 
|{{Error|BXDB0010|XQuery Errors#BaseX Errors}} the specified event is unknown.<br/>{{Error|SEPM0016|XQuery_Errors#Serialization_Errors}} serialization errors occurred while sending the value.<br/>
 
 
|}
 
|}
  
Line 493: Line 836:
  
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
! width="5%"|Code
+
! width="110"|Code
! width="95%"|Description
+
|Description
 +
|-
 +
|{{Code|args}}
 +
|The number of specified inputs and paths differs.
 
|-
 
|-
|{{Code|BXDB0001}}
+
|{{Code|conflict}}
|A referenced XML node is no [[#Database Nodes|database node]], i.e. is neither stored in a database nor a database fragment.
+
|Multiple update operations point to the same target.
 
|-
 
|-
|{{Code|BXDB0002}}
+
|{{Code|lock}}
|An I/O error occurred while opening a database.
+
|A database cannot be updated because it is opened by another process.
 
|-
 
|-
|{{Code|BXDB0003}}
+
|{{Code|mainmem}}
 
|The addressed database is not ''persistent'' (stored on disk).
 
|The addressed database is not ''persistent'' (stored on disk).
 
|-
 
|-
|{{Code|BXDB0004}}
+
|{{Code|name}}
 +
|The name of the specified database is invalid.
 +
|-
 +
|{{Code|no-backup}}
 +
|No backup exists for a database.
 +
|-
 +
|{{Code|node}}
 +
|The referenced XML node is no [[#Database Nodes|database node]], i.e. it is neither stored in a database nor represented as database fragment.
 +
|-
 +
|{{Code|no-index}}
 
|The database lacks an index structure required by the called function.
 
|The database lacks an index structure required by the called function.
 
|-
 
|-
|{{Code|BXDB0005}}
+
|{{Code|open}}
|A query is expected to exclusively return [[#Database Nodes|database nodes]] of a single database.
+
|The addressed database does not exist or could not be opened.
 
|-
 
|-
|{{Code|BXDB0006}}
+
|{{Code|option}}
|A database path addressed with {{Code|doc()}} contains more than one document.
+
|The specified option is unknown.
 
|-
 
|-
|{{Code|BXDB0007}}
+
|{{Code|path}}
|A database cannot be updated because it is opened by another process.
+
|The specified database path is invalid.
 
|-
 
|-
|{{Code|BXDB0008}}
+
|{{Code|property}}
|Database paths cannot be renamed to empty strings.
+
|The specified database property is unknown.
 
|-
 
|-
|{{Code|BXDB0009}}
+
|{{Code|range}}
 
|The addressed database id or pre value is out of range.
 
|The addressed database id or pre value is out of range.
 
|-
 
|-
|{{Code|BXDB0010}}
+
|{{Code|target}}
|The specified event is unknown.
+
|Path points to an invalid target.
|-
 
|{{Code|BXDB0011}}
 
|The name of the specified database is invalid.
 
|-
 
|{{Code|BXDB0012}}
 
|A database can only be created once.
 
 
|}
 
|}
  
 
=Changelog=
 
=Changelog=
 +
 +
;Version 9.3
 +
* Added: [[#db:alter-backup|db:alter-backup]]
 +
* Updated: [[#db:open-id|db:open-id]], [[#db:open-pre|db:open-pre]]: support for multiple integers
 +
 +
;Version 9.2
 +
* Added: [[#db:dir|db:dir]]
 +
* Updated: [[#db:add|db:add]]: {{Code|$path}} allow empty path argument
 +
 +
;Version 9.0
 +
* Added: [[#db:option|db:option]]
 +
* Updated: db:output renamed to {{Function|Update|update:output}}, db:output-cache renamed to {{Function|Update|update:cache}}
 +
* Updated: error codes updated; errors now use the module namespace
 +
 +
;Version 8.6
 +
* Added: [[#db:property|db:property]]
 +
 +
;Version 8.4
 +
* Updated: [[#db:create|db:create]], [[#db:add|db:add]], [[#db:replace|db:replace]]: support for {{Code|ADDCACHE}} option.
 +
* Added: [[#db:token|db:token]]
 +
 +
;Version 8.3
 +
* Updated: [[#db:list-details|db:list-details]]: attributes with name of database and date of backup added to results.
 +
* Updated: [[#db:backups|db:backups]] now include attributes with name of database and date of backup.
 +
* Updated: [[#Value Indexes|Value Indexes]]: raise error if no index exists.
 +
 +
;Version 8.2
 +
* Added: [[#db:output-cache|db:output-cache]]
 +
* Removed: db:event
 +
 +
;Version 7.9
 +
* Updated: parsing options added to [[#db:create|db:create]], [[#db:add|db:add]] and [[#db:replace|db:replace]].
 +
* Updated: allow {{Option|UPDINDEX}} if {{Code|$all}} is {{Code|true}}.
 +
 +
;Version 7.8.2
 +
* Added: [[#db:alter|db:alter]], [[#db:copy|db:copy]], [[#db:create-backup|db:create-backup]], [[#db:drop-backup|db:drop-backup]], [[#db:restore|db:restore]]
 +
 +
;Version 7.8
 +
* Removed: db:fulltext (use [[Full-Text Module#ft:search|ft:search]] instead)
 +
 +
;Version 7.7
 +
* Added: [[#db:export|db:export]], [[#db:name|db:name]], [[#db:path|db:path]]
 +
* Updated: {{Code|$options}} argument added to [[#db:create|db:create]] and [[#db:optimize|db:optimize]].
 +
* Updated: the functions no longer accept [[#Database Nodes|Database Nodes]] as reference. Instead, the name of a database must now be specified.
 +
 +
;Version 7.6
 +
* Updated: [[#db:create|db:create]]: allow more than one input and path.
  
 
;Version 7.5
 
;Version 7.5
 
 
* Updated: [[#db:add|db:add]]: input nodes will be automatically converted to document nodes
 
* Updated: [[#db:add|db:add]]: input nodes will be automatically converted to document nodes
 
* Added: [[#db:backups|db:backups]]
 
* Added: [[#db:backups|db:backups]]
 
* Added: [[#db:create|db:create]]
 
* Added: [[#db:create|db:create]]
 +
* Added: [[#db:drop|db:drop]]
  
 
;Version 7.3
 
;Version 7.3
 
 
* Added: [[#db:flush|db:flush]]
 
* Added: [[#db:flush|db:flush]]
  
 
;Version 7.2.1
 
;Version 7.2.1
 
 
* Added: [[#db:text-range|db:text-range]], [[#db:attribute-range|db:attribute-range]], [[#db:output|db:output]]
 
* Added: [[#db:text-range|db:text-range]], [[#db:attribute-range|db:attribute-range]], [[#db:output|db:output]]
  
 
;Version 7.1
 
;Version 7.1
 
 
* Added: [[#db:list-details|db:list-details]], [[#db:content-type|db:content-type]]
 
* Added: [[#db:list-details|db:list-details]], [[#db:content-type|db:content-type]]
 
* Updated: [[#db:info|db:info]], [[#db:system|db:system]], [[#db:retrieve|db:retrieve]]
 
* Updated: [[#db:info|db:info]], [[#db:system|db:system]], [[#db:retrieve|db:retrieve]]
  
 
;Version 7.0
 
;Version 7.0
 
 
* Added: [[#db:retrieve|db:retrieve]], [[#db:store|db:store]], [[#db:exists|db:exists]], [[#db:is-raw|db:is-raw]], [[#db:is-xml|db:is-xml]]
 
* Added: [[#db:retrieve|db:retrieve]], [[#db:store|db:store]], [[#db:exists|db:exists]], [[#db:is-raw|db:is-raw]], [[#db:is-xml|db:is-xml]]
* Updated: [[#db:list|db:list]], [[#db:oen|db:open]], [[#db:add|db:add]]
+
* Updated: [[#db:list|db:list]], [[#db:open|db:open]], [[#db:add|db:add]]
 
 
[[Category:XQuery]]
 

Latest revision as of 14:39, 30 November 2020

This XQuery Module contains functions for processing databases from within XQuery. Existing databases can be opened and listed, its contents can be directly accessed, documents can be added to and removed, etc.

Conventions[edit]

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

Database Nodes[edit]

In BaseX, two internal representations exist for nodes.

  • XML fragments are generated by XQuery node constructors.
  • Database nodes are:
    • stored in a persistent database on disk;
    • nodes of a document that has been generated temporarily with fn:doc, fn:parse-xml and other functions; or
    • result of a main-memory update operation.

Some operations are restricted to database nodes, but you can convert XML fragments to database nodes by applying an empty update or transform operation to a node. Two examples:

  • Retrieve the internal node id of an XML fragment:
let $xml := <xml>hello world</xml> update {}
return db:node-id($xml/text())
  • Puts a marker element around the result of a full-text request (see ft:mark for more details):
copy $p := <xml>hello world</xml>
modify ()
return ft:mark($p[text() contains text 'word'], 'b')

General Functions[edit]

db:system[edit]

Signatures db:system() as element(system)
Summary Returns general information on the database system the current values of all global and local Options. The INFO command returns similar output.

db:option[edit]

Signatures db:option($name as xs:string) as xs:string
Summary Returns the current value (string, integer, boolean, map) of a global or local Option with the specified $name. The GET command works similar.
Errors option: the specified option is unknown.
Examples
  • db:option('dbpath') returns the database path string.
  • db:option('serializer') returns a map with the current serialization parameters.
  • declare option db:chop 'true'; db:option('chop') returns true (irrespective of the global value).

db:info[edit]

Signatures db:info($db as xs:string) as element(database)
Summary Returns meta information on the database $db. The output is similar to the INFO DB command.
Errors open: the addressed database does not exist or could not be opened.

db:property[edit]

Signatures db:property($db as xs:string, $name as xs:string) as xs:anyAtomicType
Summary Returns the value (string, boolean, integer) of a property with the specified $name in the database $db. The available properties are the ones returned by db:info.
Errors property: the specified property is unknown.
Examples
  • db:property('db', 'size') returns the number of bytes occupied by the database db.
  • db:property('xmark', 'textindex') indicates if the xmark database has a text index.
  • db:property('discogs', 'uptodate') indicates if the database statistics and index structures of the discogs database are up-to-date.

db:list[edit]

Signatures db:list() as xs:string*
db:list($db as xs:string) as xs:string*
db:list($db as xs:string, $path as xs:string) as xs:string*
Summary The result of this function is dependent on the number of arguments:
  • Without arguments, the names of all databases are returned that are accessible to the current user.
  • If a database $db is specified, all documents and raw files of the specified database are returned.
  • The list of returned resources can be restricted by the $path argument.
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:list("docs") returns the names of all documents of a database named docs.

db:list-details[edit]

Signatures db:list-details() as element(database)*
db:list-details($db as xs:string) as element(resource)*
db:list-details($db as xs:string, $path as xs:string) as element(resource)*
Summary Without arguments, an element is returned for each database that is accessible to the current user:
  • An element has a value, which is the name of the database, and several attributes, which contain the number of stored resources, the modification date, the database size on disk (measured in bytes), and a path to the original database input.

If a database $db is specified, an element for each documents and raw file of the specified database is returned:

  • An element has a value, which is the name of the resource, and several attributes, which contain the content type, the modification date, the raw flag (which indicates if the resource is binary or XML), and the size of a resource.
  • The value of the size attribute depends on the resource type: for documents, it represents the number of nodes; for binary data, it represents the file size (measured in bytes).
  • Returned databases resources can be further restricted by the $path argument.
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:list-details("shop") returns the names plus additional info on all resources of a database named shop.

db:dir[edit]

Signatures db:dir($db as xs:string, $path as xs:string) as element()*
Summary Returns meta data on all directories and resources of the database $db in the specified directory $path. Two types of elements are returned:
  • resource represents a resource. The element value is the directory path; content type, modification date, raw flag (which indicates if the resource is binary or XML), and size of the resource are returned as attributes.
  • dir represents a directory. The element value is the directory path; the modification date is returned as attribute.

Please note that directories are not stored in BaseX. Instead, they result implicitly from the paths of stored resources.

Errors open: the addressed database does not exist or could not be opened.
path: the specified path is invalid.
Examples
  • db:dir('shop', 'books') returns all entries of the books directory of a shop database.

db:backups[edit]

Signatures db:backups() as element(backup)*
db:backups($db as xs:string) as element(backup)*
Summary Returns an element sequence containing all available database backups.
If a database $db is specified, the sequence will be restricted to the backups matching this database.
Examples
  • db:backups("factbook") returns all backups that have been made from the factbook database.

Read Operations[edit]

db:open[edit]

Signatures db:open($db as xs:string) as document-node()*
db:open($db as xs:string, $path as xs:string) as document-node()*
Summary Opens the database $db and returns all document nodes.
The document nodes to be returned can be filtered with the $path argument.
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:open("docs") returns all documents from the database named docs.
  • db:open("db", "one") returns all documents from the database named db located in the path one.
  • for $i in 1 to 3 return db:open("db" || $i)//item returns all item elements from the databases db1, db2 and db3.

db:open-pre[edit]

Signatures db:open-pre($db as xs:string, $pres as xs:integer*) as node()*
Summary Opens the database $db and returns all distinct nodes with the pre values $pres in document order.
The PRE value provides very fast access to an existing database node, but it will change whenever a node with a smaller pre values is added to or deleted from a database.
Errors open: the addressed database does not exist or could not be opened.
range: the specified pre value does not exist in the database.
Examples
  • db:open-pre("docs", 0) returns the first database node from the database named docs.

db:open-id[edit]

Signatures db:open-id($db as xs:string, $ids as xs:integer*) as node()*
Summary Opens the database $db and returns all distinct nodes with the specified $ids in document order.
Each database node has a persistent ID value. Access to the node id can be sped up by turning on the UPDINDEX option.
Errors open: the addressed database does not exist or could not be opened.
range: the specified id value does not exist in the database.

db:node-pre[edit]

Signatures db:node-pre($nodes as node()*) as xs:integer*
Summary Returns the pre values of the specified $nodes, which must all be database nodes.
The PRE value provides very fast access to an existing database node, but it will change whenever a node with a smaller pre values is added to or deleted from a database.
Errors node: $nodes contains a node which is not stored in a database.
Examples
  • db:node-pre(doc("input")) returns 0 if the database input contains a single document.

db:node-id[edit]

Signatures db:node-id($nodes as node()*) as xs:integer*
Summary Returns the id values of the specified $nodes, which must all be database nodes.
Each database node has a persistent ID value. Access to the node id can be sped up by turning on the UPDINDEX option.
Errors node: $nodes contains a node which is not stored in a database.

db:retrieve[edit]

Signatures db:retrieve($db as xs:string, $path as xs:string) as xs:base64Binary
Summary Returns a binary resource addressed by the database $db and $path as streamable xs:base64Binary.
Errors open: the addressed database does not exist or could not be opened.
mainmem: the database is not persistent (stored on disk).
Examples
  • db:retrieve("DB", "music/01.mp3") returns the specified audio file as raw data.
  • stream:materialize(db:retrieve("DB", "music/01.mp3")) materializes the streamable result in main-memory before returning it.
  • convert:binary-to-string(db:retrieve("DB", "info.txt"), 'UTF-8') converts a binary database resource as UTF-8 text and returns a string.

db:export[edit]

Signatures db:export($db as xs:string, $path as xs:string) as empty-sequence()
db:export($db as xs:string, $path as xs:string, $params as item()) as empty-sequence()
Summary Exports the specified database $db to the specified file $path. Existing files will be overwritten.
The $params argument contains serialization parameters. As with fn:serialize(), the parameters can be specified
  • either as children of an <output:serialization-parameters/> element:
<output:serialization-parameters>
  <output:method value='xml'/>
  <output:cdata-section-elements value="div"/>
  ...
</output:serialization-parameters>
  • or as map, which contains all key/value pairs:
map { "method": "xml", "cdata-section-elements": "div", ... }
Errors open: the addressed database does not exist or could not be opened.
Examples Export all files as text:
db:export("DB", "/home/john/xml/texts", map { 'method': 'text' })

The following query can be used to export parts of the database:

let $target := '/home/john/xml/target'
for $doc in db:open('DB', 'collection')
let $path := $target || db:path($doc)
return (
  file:create-dir(file:parent($path)),
  file:write($path, $doc)
)

Value Indexes[edit]

db:text[edit]

Signatures db:text($db as xs:string, $strings as xs:string*) as text()*
Summary Returns all text nodes of the database $db that have one of the specified $strings as values and that are stored in the text index.
Errors open: the addressed database does not exist or could not be opened.
no-index: the index is not available.
Examples
  • db:text("DB", "QUERY")/.. returns the parents of all text nodes of the database DB that match the string QUERY.

db:text-range[edit]

Signatures db:text-range($db as xs:string, $min as xs:string, $max as xs:string) as text()*
Summary Returns all text nodes of the database $db whose values are between $min and $max and that are stored in the text index.
Errors open: the addressed database does not exist or could not be opened.
no-index: the index is not available.
Examples
  • db:text-range("DB", "2000", "2001") returns all text nodes of the database DB that are found in between 2000 and 2001.

db:attribute[edit]

Signatures db:attribute($db as xs:string, $strings as xs:string*) as attribute()*
db:attribute($db as xs:string, $strings as xs:string*, $name as xs:string) as attribute()*
Summary Returns all attribute nodes of the database $db that have one of the specified $strings as values and that are stored in the attribute index.
If $name is specified, the resulting attribute nodes are filtered by their attribute name.
Errors open: the addressed database does not exist or could not be opened.
no-index: the index is not available.
Examples
  • db:attribute("DB", "QUERY", "id")/.. returns the parents of all id attribute nodes of the database DB that have QUERY as string value.

db:attribute-range[edit]

Signatures db:attribute-range($db as xs:string, $min as xs:string, $max as xs:string) as attribute()*
db:attribute-range($db as xs:string, $min as xs:string, $max as xs:string, $name as xs:string) as attribute()*
Summary Returns all attributes of the database $db, the string values of which are larger than or equal to $min and smaller than or equal to $max and that are stored in the attribute index.
Errors open: the addressed database does not exist or could not be opened.
no-index: the index is not available.
Examples
  • db:attribute-range("DB", "id456", "id473", 'id') returns all @id attributes of the database DB that have a string value in between id456 and id473.

db:token[edit]

Signatures db:token($db as xs:string, $tokens as xs:string*) as attribute()*
db:token($db as xs:string, $tokens as xs:string*, $name as xs:string) as attribute()*
Summary Returns all attribute nodes of the database $db the values of which contain one of the specified $tokens.
If $name is specified, the resulting attribute nodes are filtered by their attribute name.
Errors open: the addressed database does not exist or could not be opened.
no-index: the index is not available.
Examples
  • db:token("DB", "row", "class")/parent::div returns all div nodes of database DB with a class attribute that contains the token row.

Updates[edit]

Important note: All functions in this section are updating functions: they will not be immediately executed, but queued on the Pending Update List, which will be processed after the actual query has been evaluated. This means that the order in which the functions are specified in the query does usually not reflect the order in which the code will be evaluated.

db:create[edit]

Signatures db:create($db as xs:string) as empty-sequence()
db:create($db as xs:string, $inputs as item()*) as empty-sequence()
db:create($db as xs:string, $inputs as item()*, $paths as xs:string*) as empty-sequence()
db:create($db as xs:string, $inputs as item()*, $paths as xs:string*, $options as map(*)?) as empty-sequence()
Summary Creates a new database with name $db and adds initial documents specified via $inputs to the specified $paths:
  • $inputs may be strings or nodes:
    • nodes may be of any type except for attributes
    • strings can be a URI pointing to a file/directory or an XML string (which is detected by the leading < character)
    • a path must be specified if the input is not a file or directory reference
  • The parsing and indexing behavior can be controlled via $options:
  • An existing database will be overwritten.
  • Database creation takes place after most other update operations (see Pending Update List). As a consequence, a newly created database cannot be addressed in the same query.
Errors lock: a database is opened by another process.
name: the specified name is not a valid database name.
conflict: the same database was addressed more than once.
args: the number of specified inputs and paths differs.
Examples
  • db:create("DB") creates the empty database DB.
  • db:create("DB", "/home/dir/doc.xml") creates the database DB and adds the document /home/dir/doc.xml as initial content.
  • db:create("DB", <a/>, "doc.xml") creates the database DB and adds the document with content <a/> under the name doc.xml.
  • db:create("DB", "/home/dir/", "docs/dir") creates the database DB and adds the documents in /home/dir to the database under the path docs/dir.
  • db:create("DB", file:list('.'), (), map { 'ftindex': true() }) adds all files of the current working directory to a new database, preserving relative filesystem paths and creating a full-text index.

db:drop[edit]

Signatures db:drop($db as xs:string) as empty-sequence()
Summary Drops the database $db and all connected resources.
Errors open: the addressed database does not exist or could not be opened.
lock: a database is opened by another process.
conflict: the same database was addressed more than once.
Examples
  • db:drop("DB") drops the database DB.

db:add[edit]

Signatures db:add($db as xs:string, $input as item()) as empty-sequence()
db:add($db as xs:string, $input as item(), $path as xs:string?) as empty-sequence()
db:add($db as xs:string, $input as item(), $path as xs:string?, $options as map(*)?) as empty-sequence()
Summary Adds documents specified by $input to the database $db with the specified $path:
  • A document with the same path may occur more than once in a database. If you want to enforce single instances, use db:replace instead.
  • See db:create for more details on the input and path arguments.
  • The parsing behavior can be controlled via $options:
    • allowed options are ADDCACHE and the parsing and XML parsing options, all in lower case
    • parsing options will only impact string input (URIs, XML strings), because nodes have already been parsed
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:add("DB", "/home/dir/doc.xml") adds the file /home/dir/doc.xml to the database DB.
  • db:add("DB", <a/>, "doc.xml") adds a document node to the database DB under the name doc.xml.
  • db:add("DB", "/home/dir", "docs/dir", map { 'addcache': true() }) adds all documents in /home/dir to the database DB under the path docs/dir. In order to reduce memory consumption, the files will be cached before being added to the database.

db:delete[edit]

Signatures db:delete($db as xs:string, $path as xs:string) as empty-sequence()
Summary Deletes resource(s), specified by $path, from the database $db.
Errors open: the addressed database does not exist or could not be opened.
path: the specified path is invalid.
Examples
  • db:delete("DB", "docs/dir/doc.xml") deletes the resource docs/dir/doc.xml from DB.
  • db:delete("DB", "docs/dir") deletes all resources from DB in the specified path docs/dir.

db:copy[edit]

Signatures db:copy($db as xs:string, $name as xs:string) as empty-sequence()
Summary Creates a copy of the database $db, which will be called $name.
Errors open: the addressed database does not exist or could not be opened.
lock: a database is opened by another process.
name: invalid database name.
conflict: the same database was addressed more than once.

db:alter[edit]

Signatures db:alter($db as xs:string, $name as xs:string) as empty-sequence()
Summary Renames the database $db to $name.
Errors open: the addressed database does not exist or could not be opened.
lock: a database is opened by another process.
name: invalid database name.
conflict: the same database was addressed more than once.

db:create-backup[edit]

Signatures db:create-backup($db as xs:string) as empty-sequence()
Summary Creates a backup of the database $db.
Errors open: the addressed database does not exist or could not be opened.
name: invalid database name.
conflict: the same database was addressed more than once.
Examples
  • db:create-backup("DB") creates a backup of the database DB.

db:drop-backup[edit]

Signatures db:drop-backup($name as xs:string) as empty-sequence()
Summary Drops all backups of the database with the specified $name. If the given $name points to a specific backup file, only this specific backup file is deleted.
Errors backup: No backup file found.
name: invalid database name.
conflict: the same database was addressed more than once.
Examples
  • db:drop-backup("DB") drops all backups of the database DB.
  • db:drop-backup("DB-2014-03-13-17-36-44") drops the specific backup file DB-2014-03-13-17-36-44.zip of the database DB.

db:alter-backup[edit]

Signatures db:alter-backup($name as xs:string, $new-name as xs:string) as empty-sequence()
Summary Renames all backups of the database with the specified $name to $new-name. The directory inside the archive will be renamed as well. If the given $name points to a specific backup file, only this specific backup file will be renamed.
Errors backup: No backup file found.
name: invalid database name.
conflict: the same database was addressed more than once.
Examples
  • db:alter-backup("DB", "DB2) renames all backups of the database DB to DB2.

db:restore[edit]

Signatures db:restore($name as xs:string) as empty-sequence()
Summary Restores the database with the specified $name. The $name may include the timestamp of the backup file.
Errors lock: a database is opened by another process.
name: invalid database name.
no-backup: No backup found.
conflict: the same database was addressed more than once.
Examples
  • db:restore("DB") restores the database DB.
  • db:restore("DB-2014-03-13-18-05-45") restores the database DB from the backup file with the given timestamp.

db:optimize[edit]

Signatures db:optimize($db as xs:string) as empty-sequence()
db:optimize($db as xs:string, $all as xs:boolean) as empty-sequence()
db:optimize($db as xs:string, $all as xs:boolean, $options as map(*)?) as empty-sequence()
Summary Optimizes the meta data and indexes of the database $db.
If $all is true, the complete database will be rebuilt.
The $options argument can be used to control indexing. The syntax is identical to the db:create function: Allowed options are all indexing and full-text options. UPDINDEX is only supported if $all is true.
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:optimize("DB") optimizes the database structures of the database DB.
  • db:optimize("DB", true(), map { 'ftindex': true() }) optimizes all database structures of the database DB and creates a full-text index.

db:rename[edit]

Signatures db:rename($db as xs:string, $source as xs:string, $target as xs:string) as empty-sequence()
Summary Moves all resources(s) of database $db, which are found in the supplied $source path, to the supplied $target path. The paths may point to single resources or directories. No updates will take place if a non-existing source path is supplied.
Errors open: the addressed database does not exist or could not be opened.
path: the specified source or target path, or one of its descendants, is invalid.
Examples
  • db:rename("DB", "docs/dir/doc.xml", "docs/dir/newdoc.xml") renames the resource docs/dir/doc.xml to docs/dir/newdoc.xml in the database DB.
  • db:rename("DB", "docs/dir", "docs/newdir") moves all resources in the database DB from docs/dir to {Code|docs/newdir}}.

db:replace[edit]

Signatures db:replace($db as xs:string, $path as xs:string, $input as item()) as empty-sequence()
db:replace($db as xs:string, $path as xs:string, $input as item(), $options as map(*)?) as empty-sequence()
Summary Replaces a resource, specified by $path, in the database $db with the contents of $input, or adds it as a new resource:
  • See db:create for more details on the input argument.
  • The parsing behavior can be controlled via $options:
    • allowed options are ADDCACHE and the parsing and XML parsing options, all in lower case
    • parsing options will only impact string input (URIs, XML strings), because nodes have already been parsed
  • For historical reasons, the order of the 2nd and 3rd argument is different to db:add and db:create
Errors open: the addressed database does not exist or could not be opened.
target: the path points to a directory.
Examples
  • db:replace("DB", "docs/dir/doc.xml", "/home/dir/doc.xml") replaces the content of the document docs/dir/doc.xml in the database DB with the content of the file /home/dir/doc.xml.
  • db:replace("DB", "docs/dir/doc.xml", "<a/>") replaces the content of the document docs/dir/doc.xml in the database DB with <a/>.
  • db:replace("DB", "docs/dir/doc.xml", document { <a/> }) replaces the content of the document docs/dir/doc.xml in the database DB with the specified document node.

The following query can be used to import files from a directory to a database:

let $source := '/home/john/xml/source'
for $file in file:list($source, true())
let $path := $source || $file
where not(file:is-dir($path))
return db:replace('db', $file, doc($path))

db:store[edit]

Signatures db:store($db as xs:string, $path as xs:string, $input as item()) as empty-sequence()
Summary Replaces a binary resource specified by $input in the database $db and the location specified by $path, or adds it as new resource.
Errors open: the addressed database does not exist or could not be opened.
mainmem: the database is not persistent (stored on disk).
Examples
  • db:store("DB", "video/sample.mov", file:read-binary('video.mov')) stores the addressed video file at the specified location.
  • With the following query, you can copy full directories:
let $db := 'db'
let $src-path := 'src/'
let $trg-path := 'trg/'
for $src in db:list($db, $src-path)
where db:is-raw($db, $src)
let $trg := $trg-path || substring-after($src, $src-path)
return db:store($db, $trg, db:retrieve($db, $src))

db:flush[edit]

Signatures db:flush($db as xs:string) as empty-sequence()
Summary Explicitly flushes the buffers of the database $db. This command is only useful if AUTOFLUSH has been set to false.
Errors open: the addressed database does not exist or could not be opened.

Helper Functions[edit]

db:name[edit]

Signatures db:name($node as node()) as xs:string
Summary Returns the name of the database in which the specified database node $node is stored.
Errors node: $nodes contains a node which is not stored in a database.

db:path[edit]

Signatures db:path($node as node()) as xs:string
Summary Returns the path of the database document in which the specified database node $node is stored.
Errors node: $nodes contains a node which is not stored in a database.

db:exists[edit]

Signatures db:exists($db as xs:string) as xs:boolean
db:exists($db as xs:string, $path as xs:string) as xs:boolean
Summary Checks if the database $db or the resource specified by $path exists. false is returned if a database directory has been addressed.
Examples
  • db:exists("DB") returns true if the database DB exists.
  • db:exists("DB", "resource") returns true if resource is an XML document or a raw file.

db:is-raw[edit]

Signatures db:is-raw($db as xs:string, $path as xs:string) as xs:boolean
Summary Checks if the specified resource in the database $db and the path $path exists, and if it is a binary resource.
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:is-raw("DB", "music/01.mp3") returns true.

db:is-xml[edit]

Signatures db:is-xml($db as xs:string, $path as xs:string) as xs:boolean
Errors open: the addressed database does not exist or could not be opened.
Summary Checks if the specified resource in the database $db and the path $path exists, and if it is an XML document.
Examples
  • db:is-xml("DB", "dir/doc.xml") returns true.

db:content-type[edit]

Signatures db:content-type($db as xs:string, $path as xs:string) as xs:string
Summary Retrieves the content type of a resource in the database $db and the path $path.
The file extension is used to recognize the content-type of a resource stored in the database. Content-type application/xml will be returned for any XML document stored in the database, regardless of its file name extension.
Errors open: the addressed database does not exist or could not be opened.
Examples
  • db:content-type("DB", "docs/doc01.pdf") returns application/pdf.
  • db:content-type("DB", "docs/doc01.xml") returns application/xml.
  • db:content-type("DB", "docs/doc01") returns application/xml, if db:is-xml("DB", "docs/doc01") returns true.

Errors[edit]

Code Description
args The number of specified inputs and paths differs.
conflict Multiple update operations point to the same target.
lock A database cannot be updated because it is opened by another process.
mainmem The addressed database is not persistent (stored on disk).
name The name of the specified database is invalid.
no-backup No backup exists for a database.
node The referenced XML node is no database node, i.e. it is neither stored in a database nor represented as database fragment.
no-index The database lacks an index structure required by the called function.
open The addressed database does not exist or could not be opened.
option The specified option is unknown.
path The specified database path is invalid.
property The specified database property is unknown.
range The addressed database id or pre value is out of range.
target Path points to an invalid target.

Changelog[edit]

Version 9.3
Version 9.2
  • Added: db:dir
  • Updated: db:add: $path allow empty path argument
Version 9.0
Version 8.6
Version 8.4
Version 8.3
  • Updated: db:list-details: attributes with name of database and date of backup added to results.
  • Updated: db:backups now include attributes with name of database and date of backup.
  • Updated: Value Indexes: raise error if no index exists.
Version 8.2
Version 7.9
Version 7.8.2
Version 7.8
Version 7.7
Version 7.6
  • Updated: db:create: allow more than one input and path.
Version 7.5
Version 7.3
Version 7.2.1
Version 7.1
Version 7.0