Difference between revisions of "Database Module"
Line 30: | Line 30: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns meta information on the database specified by <code>[[#Database | + | |Returns meta information on the database specified by <code>[[#Database Nodes|$db]]</code>. |
|} | |} | ||
Line 40: | Line 40: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns an {{Mono|xs:string}} sequence with the names of all databases.<br/>If <code>[[#Database | + | |Returns an {{Mono|xs:string}} sequence with the names of all databases.<br/>If <code>[[#Database Nodes|$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 {{Mono|$path}} argument. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 54: | Line 54: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns an {{Mono|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>[[#Database | + | |Returns an {{Mono|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>[[#Database Nodes|$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 {{Mono|$path}} argument. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 68: | Line 68: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns a sequence with all document nodes contained in the database specified by <code>[[#Database | + | |Returns a sequence with all document nodes contained in the database specified by <code>[[#Database Nodes|$db]]</code>.<br/>The document nodes to be returned can be restricted by the {{Mono|$path}} argument. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 83: | Line 83: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Opens the database specified by <code>[[#Database | + | |Opens the database specified by <code>[[#Database Nodes|$db]]</code> and returns the node with the specified {{Mono|$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. |
|} | |} | ||
Line 93: | Line 93: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Opens the database specified by <code>[[#Database | + | |Opens the database specified by <code>[[#Database Nodes|$db]]</code> and returns the node with the specified {{Mono|$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. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 122: | Line 122: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns all attribute nodes of the database specified by <code>[[#Database | + | |Returns all attribute nodes of the database specified by <code>[[#Database Nodes|$db]]</code> that have {{Mono|$string}} as string value. If available, the value index is used to speed up evaluation.<br />If {{Mono|$attname}} is specified, the resulting attribute nodes are filtered by their attribute name. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 138: | Line 138: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns all attributes of the database specified by <code>[[#Database | + | |Returns all attributes of the database specified by <code>[[#Database Nodes|$db]]</code>, the string values of which are larger than or equal to {{Mono|$min}} and smaller than or equal to {{Mono|$max}}. If available, the value index is used to speed up evaluation. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 152: | Line 152: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns all text nodes from the full-text index of the database specified by <code>[[#Database | + | |Returns all text nodes from the full-text index of the database specified by <code>[[#Database Nodes|$db]]</code> that contain the text specified as {{Mono|$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. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 169: | Line 169: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns the ''id'' values of all {{Mono|$nodes}} of the database specified by <code>[[#Database | + | |Returns the ''id'' values of all {{Mono|$nodes}} of the database specified by <code>[[#Database Nodes|$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. |
|} | |} | ||
Line 179: | Line 179: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns the ''pre'' values of all {{Mono|$nodes}} of the database specified by <code>[[#Database | + | |Returns the ''pre'' values of all {{Mono|$nodes}} of the database specified by <code>[[#Database Nodes|$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. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 194: | Line 194: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns a binary database resource addressed by <code>[[#Database | + | |Returns a binary database resource addressed by <code>[[#Database Nodes|$db]]</code> and {{Mono|$path}}. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 211: | Line 211: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns all text nodes of the database specified by <code>[[#Database | + | |Returns all text nodes of the database specified by <code>[[#Database Nodes|$db]]</code> that have {{Mono|$string}} as their string value. If available, the value index is used to speed up evaluation. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 227: | Line 227: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Returns all text nodes of the database specified by <code>[[#Database | + | |Returns all text nodes of the database specified by <code>[[#Database Nodes|$db]]</code> that are located in between the {{Mono|$min}} and {{Mono|$max}} strings. If available, the value index is used to speed up evaluation. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 246: | Line 246: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Adds documents specified by {{Mono|$input}} to the database <code>[[#Database | + | |Adds documents specified by {{Mono|$input}} to the database <code>[[#Database Nodes|$db]]</code> and the specified {{Mono|$path}}. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 266: | Line 266: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Deletes document(s), specified by {{Mono|$path}}, from the database <code>[[#Database | + | |Deletes document(s), specified by {{Mono|$path}}, from the database <code>[[#Database Nodes|$db]]</code>. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 281: | Line 281: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Optimizes the meta data and indexes of the database <code>[[#Database | + | |Optimizes the meta data and indexes of the database <code>[[#Database Nodes|$db]]</code>.<br/>If {{Mono|$all}} is set to {{Mono|true()}}, the complete database will be rebuilt. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 299: | Line 299: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Renames document(s), specified by {{Mono|$path}} to {{Mono|$newpath}} in the database <code>[[#Database | + | |Renames document(s), specified by {{Mono|$path}} to {{Mono|$newpath}} in the database <code>[[#Database Nodes|$db]]</code>. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 317: | Line 317: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Replaces a document, specified by {{Mono|$path}}, in the database <code>[[#Database | + | |Replaces a document, specified by {{Mono|$path}}, in the database <code>[[#Database Nodes|$db]]</code> with the content of {{Mono|$input}}. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 336: | Line 336: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Stores a binary resource specified by {{Mono|$data}} in the database specified by <code>[[#Database | + | |Stores a binary resource specified by {{Mono|$data}} in the database specified by <code>[[#Database Nodes|$db]]</code> and the location specified by {{Mono|$path}}. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
Line 371: | Line 371: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Checks if the database specified by <code>[[#Database | + | |Checks if the database specified by <code>[[#Database Nodes|$db]]</code> or the resource specified by {[Mono|$path}} exists. {{Mono|false}} is returned if a database directory has been addressed. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 386: | Line 386: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Checks if the specified resource in the database <code>[[#Database | + | |Checks if the specified resource in the database <code>[[#Database Nodes|$db]]</code> and the path {{Mono|$path}} exists, and if it is a raw file. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 400: | Line 400: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Checks if the specified resource in the database <code>[[#Database | + | |Checks if the specified resource in the database <code>[[#Database Nodes|$db]]</code> and the path {{Mono|$path}} exists, and if it is an XML document. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 414: | Line 414: | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Retrieves the content type of a resource in the database <code>[[#Database | + | |Retrieves the content type of a resource in the database <code>[[#Database Nodes|$db]]</code> and the path {{Mono|$path}}.<br/>The file extension is used to recognize the content-type of a resource stored in the database. Content-type {{Mono|application/xml}} will be returned for any XML document stored in the database, regardless of its file name extension. |
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' |
Revision as of 23:52, 25 May 2012
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. All functions are introduced with the db:
prefix, which is linked to the statically declared http://basex.org/modules/db
namespace.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/db
namespace, which is statically bound to the db
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Database Nodes
Many function signatures in this and other modules share $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:
- BXDB0001 is raised if
$db
references an XML node that is not stored in a database, or is no database fragment. - BXDB0002 is raised if the addressed database cannot be opened.
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 transform expression on an XML fragment:
copy $c := element hello { 'world' } modify () return db:text($c, 'world')
General Functions
db:info
Signatures | db:info($db as item()) as element(Database)
|
Summary | Returns meta information on the database specified by $db .
|
db:list
Signatures | db:list() as xs:string* db:list($db as item()) as xs:string* db:list($db as item(), $path as xs:string) as xs:string*
|
Summary | Returns an xs:string sequence with the names of all databases.If $db is specified, all documents and raw files of the specified database are returned.The list of resources can be further restricted by the $path argument.
|
Examples |
|
db:list-details
Signatures | db:list-details() as element(database)* db:list-details($db as item()) as element(resource)* db:list-details($db as item(), $path as xs:string) as element(resource)*
|
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.If $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.The list of resources can be further restricted by the $path argument.
|
Examples |
|
db:open
Signatures | db:open($db as item()) as document-node()* db:open($db as item(), $path as xs:string) as document-node()*
|
Summary | Returns a sequence with all document nodes contained in the database specified by $db .The document nodes to be returned can be restricted by the $path argument.
|
Examples |
|
db:open-id
Signatures | db:open-id($db as item(), $id as xs:integer) as node()
|
Summary | Opens the database specified by $db and returns the node with the specified $id value.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. |
db:open-pre
Signatures | db:open-pre($db as item(), $pre as xs:integer) as node()
|
Summary | Opens the database specified by $db and returns the node with the specified $pre value.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 | BASX0004 is raised if the specified $pre value does not exist in the database.
|
Examples |
|
db:system
Signatures | db:system() as element(system)
|
Summary | Returns information on the database system, such as the database path and current database settings. |
Read Operations
db:attribute
Signatures | db:attribute($db as item(), $string as item()) as attribute()* db:attribute($db as item(), $string as item(), $attname as xs:string) as attribute()*
|
Summary | Returns all attribute nodes of the database specified by $db that have $string as string value. If available, the value index is used to speed up evaluation.If $attname is specified, the resulting attribute nodes are filtered by their attribute name.
|
Examples |
|
db:attribute-range
Signatures | db:attribute-range($db as item(), $min as xs:string, $max as xs:string) as text()* db:attribute-range($db as item(), $min as xs:string, $max as xs:string, $attname as xs:string) as attribute()*
|
Summary | Returns all attributes of the database specified by $db , the string values of which are larger than or equal to $min and smaller than or equal to $max . If available, the value index is used to speed up evaluation.
|
Examples |
|
db:fulltext
Signatures | db:fulltext($db as item(), $terms as xs:string) as text()*
|
Summary | Returns all text nodes from the full-text index of the database specified by $db that contain the text specified as $terms .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 | BXDB0004 is raised if the full-text index is not available. |
Examples |
|
db:node-id
Signatures | db:node-id($nodes as node()*) as xs:integer*
|
Summary | Returns the id values of all $nodes of the database specified by $db .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. |
db:node-pre
Signatures | db:node-pre($nodes as node()*) as xs:integer*
|
Summary | Returns the pre values of all $nodes of the database specified by $db .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 |
|
db:retrieve
Signatures | db:retrieve($db as item(), $path as xs:string) as xs:base64Binary
|
Summary | Returns a binary database resource addressed by $db and $path .
|
Errors | FODC0002 is raised if the addressed resource is not found or cannot be retrieved. |
Examples |
|
db:text
Signatures | db:text($db as item(), $string as item()) as text()*
|
Summary | Returns all text nodes of the database specified by $db that have $string as their string value. If available, the value index is used to speed up evaluation.
|
Examples |
|
db:text-range
Signatures | db:text-range($db as item(), $min as xs:string, $max as xs:string) as text()*
|
Summary | Returns all text nodes of the database specified by $db that are located in between the $min and $max strings. If available, the value index is used to speed up evaluation.
|
Examples |
|
Updates
All functions in this section are treated as updating: they are not immediately executed, but queued on a pending update list, which is processed after the actual query has been evaluated. The XQuery Update page gives more insight into the relevant concepts.
db:add
Signatures | db:add($db as item(), $input as item()) as empty-sequence() db:add($db as item(), $input as item(), $path as xs:string) as empty-sequence()
|
Summary | Adds documents specified by $input to the database $db and the specified $path .
|
Errors | FODC0002 is raised if $input is a string representing a path, which cannot be read.FOUP0001 is raised if $input is not a string and not a document node.
|
Examples |
|
db:delete
Signatures | db:delete($db as item(), $path as xs:string) as empty-sequence()
|
Summary | Deletes document(s), specified by $path , from the database $db .
|
Examples |
|
db:optimize
Signatures | db:optimize($db as item()) as empty-sequence() db:optimize($db as item(), $all as xs:boolean) as empty-sequence()
|
Summary | Optimizes the meta data and indexes of the database $db .If $all is set to true() , the complete database will be rebuilt.
|
Errors | BASX0014 is raised if an error occurs during optimizing the data structures. BASX0015 is raised if the $all flag is set to true() , but the database is an in-memory database.BASX0016 is raised if the database $db is in use by other user(s).
|
Examples |
|
db:rename
Signatures | db:rename($db as item(), $path as xs:string, $newpath as xs:string) as empty-sequence()
|
Summary | Renames document(s), specified by $path to $newpath in the database $db .
|
Errors | BASX0013 is raised if new document name(s) will be empty. |
Examples |
|
db:replace
Signatures | db:replace($db as item(), $path as xs:string, $input as item()) as empty-sequence()
|
Summary | Replaces a document, specified by $path , in the database $db with the content of $input .
|
Errors | BASX0012 is raised if $path is not a single document path.FODC0002 is raised if $input is a string representing a path, which cannot be read.FOUP0001 is raised if $input is not a string and not a document node.
|
Examples |
|
db:store
Signatures | db:store($db as item(), $path as xs:string, $data as item()) as empty-sequence()
|
Summary | Stores a binary resource specified by $data in the database specified by $db and the location specified by $path .
|
Errors | FOUP0002 is raised if the resource cannot be stored at the specified location. |
Examples |
|
db:output
Signatures | db:output($data as item()*) as empty-sequence()
|
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. The function can only be used together with updating expressions; if the function is called within a transform expression, its results will be discarded. |
Examples |
|
Helper Functions
db:exists
Signatures | db:exists($db as item()) as xs:boolean db:exists($db as item(), $path as xs:string) as xs:boolean
|
Summary | Checks if the database specified by $db or the resource specified by {[Mono|$path}} exists. false is returned if a database directory has been addressed.
|
Examples |
|
db:is-raw
Signatures | db:is-raw($db as item(), $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 raw file.
|
Examples |
|
db:is-xml
Signatures | db:is-xml($db as item(), $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 an XML document.
|
Examples |
|
db:content-type
Signatures | db:content-type($db as item(), $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 | FODC0002 is raised if the addressed resource is not found or cannot be retrieved. |
Examples |
|
db:event
Signatures | db:event($name as xs:string, $query as item()) as empty-sequence()
|
Summary | Executes a $query and sends the resulting value to all clients watching the Event with the specified $name . The query may also perform updates; no event will be sent to the client that fired the event.
|
Errors | BASX0009 is raised if the specified event is unknown. SEPM0016 is raised if serialization errors occurred while sending the value. |
Changelog
Version 7.2.1
- Added: db:text-range, db:attribute-range, db:output
Version 7.1
- Added: db:list-details, db:content-type
- Updated: db:info, db:system, db:retrieve