Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
no edit summary
|-
| '''Summary'''
|Returns meta information on the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.
|}
|-
| '''Summary'''
|Returns an {{Code|xs:string}} sequence with the names of all databases.<br/>If <code>a [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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.
|-
| '''Examples'''
|-
| '''Summary'''
|Returns an {{Code|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 <code>a [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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.
|-
| '''Examples'''
|-
| '''Summary'''
|Returns a sequence with all document nodes contained in the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.<br/>The document nodes to be returned can be restricted by the {{Code|$path}} argument.
|-
| '''Examples'''
|-
| '''Summary'''
|Opens the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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.
|-
| '''Errors'''
|-
| '''Summary'''
|Opens the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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.
|-
| '''Errors'''
|-
| '''Summary'''
|Returns all attribute nodes of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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.
|-
| '''Examples'''
|-
| '''Summary'''
|Returns all attributes of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code>}}, 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.
|-
| '''Examples'''
|-
| '''Summary'''
|Returns all text nodes from the full-text index of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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.
|-
| '''Errors'''
|-
| '''Summary'''
|Returns the ''id'' values of all {{Code|$nodes}} of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.<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.
|}
|-
| '''Summary'''
|Returns the ''pre'' values of all {{Code|$nodes}} of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.<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.
|-
| '''Examples'''
|-
| '''Summary'''
|Returns a binary database resource addressed by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} and {{Code|$path}}.
|-
| '''Errors'''
|-
| '''Summary'''
|Returns all text nodes of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} that have {{Code|$string}} as their string value. If available, the value index is used to speed up evaluation.
|-
| '''Examples'''
|-
| '''Summary'''
|Returns all text nodes of the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} that are located in between the {{Code|$min}} and {{Code|$max}} strings. If available, the value index is used to speed up evaluation.
|-
| '''Examples'''
|-
| '''Summary'''
|Adds documents specified by {{Code|$input}} to the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code> }} and the specified {{Code|$path}}.
|-
| '''Errors'''
|-
| '''Summary'''
|Deletes document(s), specified by {{Code|$path}}, from the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.
|-
| '''Examples'''
|-
| '''Summary'''
|Optimizes the meta data and indexes of the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.<br/>If {{Code|$all}} is set to {{Code|true()}}, the complete database will be rebuilt.
|-
| '''Errors'''
|-
| '''Summary'''
|Renames document(s), specified by {{Code|$path}} to {{Code|$newpath}} in the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code>}}.
|-
| '''Errors'''
|-
| '''Summary'''
|Replaces a document, specified by {{Code|$path}}, in the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code> }} with the content of {{Code|$input}}.
|-
| '''Errors'''
|-
| '''Summary'''
|Stores a binary resource specified by {{Code|$data}} in the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} and the location specified by {{Code|$path}}.
|-
| '''Errors'''
|-
| '''Summary'''
|Checks if the database specified by <code>the [[#Database Nodes|database node]] {{Code|$db]]</code> }} or the resource specified by {[Mono|$path}} exists. {{Code|false}} is returned if a database directory has been addressed.
|-
| '''Examples'''
|-
| '''Summary'''
|Checks if the specified resource in the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code> }} and the path {{Code|$path}} exists, and if it is a raw file.
|-
| '''Examples'''
|-
| '''Summary'''
|Checks if the specified resource in the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code> }} and the path {{Code|$path}} exists, and if it is an XML document.
|-
| '''Examples'''
|-
| '''Summary'''
|Retrieves the content type of a resource in the database <code>specified by the [[#Database Nodes|database node]] {{Code|$db]]</code> }} 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'''
