Difference between revisions of "Database Module"
Jump to navigation
Jump to search
Line 153: | Line 153: | ||
| | | | ||
* <code>db:info("DB", "FULLTEXT")</code> returns information about the full-text index in the database <code>DB</code>. | * <code>db:info("DB", "FULLTEXT")</code> returns information about the full-text index in the database <code>DB</code>. | ||
+ | |} | ||
+ | |||
+ | ==db:get== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signatures''' | ||
+ | |<code><b>db:get</b>($db as xs:string, $path as xs:string) as xs:base64Binary</code> | ||
+ | |- | ||
+ | | valign='top' | '''Summary''' | ||
+ | |Retrieves the binary resource specified by <code>$path</code> in the <code>xs:basex64Binary</code> format. Introduced with <font color='red'>Version 6.8</font>. | ||
+ | |- | ||
+ | | valign='top' | '''Errors''' | ||
+ | |<b>[[XQuery Errors#Functions Errors (FOAR, FOCA, FOCH, FODC, FODF, FODT, FOER, FOFD, FONS, FORG, FORX, FOTY)|FODC0002]]</b> is raised if the addressed resource is not found or cannot be retrieved. | ||
+ | |- | ||
+ | | valign='top' | '''Examples''' | ||
+ | | | ||
+ | * <code>db:get("DB", "music/01.mp3")</code> returns the specified audio file. | ||
+ | |} | ||
+ | |||
+ | ==db:put== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signatures''' | ||
+ | |<code><b>db:put</b>($db as xs:string, $path as xs:string, $data as item()) as empty-sequence()</code> | ||
+ | |- | ||
+ | | valign='top' | '''Summary''' | ||
+ | |Stores a binary resource specified by <code>$data</code> at the location specified by <code>$path</code>. Introduced with <font color='red'>Version 6.8</font>. | ||
+ | |- | ||
+ | | valign='top' | '''Errors''' | ||
+ | |<b>[[XQuery Errors#Update Errors (FOUP, XUDY, XUST, XUTY)|FOUP0002]]</b> is raised if the resource cannot be stored at the specified location. | ||
+ | |- | ||
+ | | valign='top' | '''Examples''' | ||
+ | | | ||
+ | * <code>db:put("DB", "video/sample.mov", file:read-binary('video.mov'))</code> stores the addressed video file at the specified location. | ||
|} | |} | ||
Revision as of 17:19, 2 September 2011
This module contains XQuery functions for handling databases from within XQuery. Existing databases can be opened and listed, index structures can be directly accessed, documents can be added to and removed from collections, etc. All functions are introduced with the db:
prefix, which is linked to the http://www.basex.org/db
namespace.
Contents
db:system
Signatures | db:system() as xs:string
|
Summary | Prints information about the database system, including the database path and current database settings. |
db:list
Signatures | db:list() as xs:string* db:list($path as xs:string) as xs:string*
|
Summary | Returns an xs:string sequence with the names of all databases. If an argument is specified, all documents of the specified database or database path are returned.
|
db:open
Signatures | db:open($name as xs:string) as document-node()*
|
Summary | Returns a sequence with all document nodes contained in the database specified by $name . The name of the database may be extended by a collection path.
|
Errors | BASX0003 is raised if the database is not found. |
Examples |
|
db:open-pre
Signatures | db:open-pre($db as item(), $pre as xs:integer) as node()
|
Summary | Opens the database specified by $name and returns the node with the specified $pre value.
|
Errors | BASX0004 is raised if the specified $pre value does not exist in the database.
|
Examples |
|
db:open-id
Signatures | db:open-id($db as item(), $id as xs:integer) as node()
|
Summary | Opens the database specified by $name and returns the node with the specified $id value.In contrast to the pre value, the id will remain valid after update operations. |
Errors | BASX0004 is raised if the specified $id does not exist in the database.
|
db:node-pre
Signatures | db:node-pre($nodes as node()*) as xs:integer*
|
Summary | Returns the pre values of all database nodes specified by $nodes . pre values are direct, internal pointers to database nodes, which might be changed by updates.
|
Examples |
|
db:node-id
Signatures | db:node-id($nodes as node()*) as xs:integer*
|
Summary | Returns the id values of all database nodes specified by $nodes . id values are pointers to database nodes, which are not changed by updates.
|
db:text
Signatures | db:text($db as item(), $string as item()) as text()*
|
Summary | Returns all text nodes that have $string as their string value.
|
Examples |
|
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 that have $string as their string value.If $attname is specified, the resulting attribute nodes are filtered by their attribute name.
|
Examples |
|
db:fulltext
Signatures | db:fulltext($db as item(), $text as item()) as text()*
|
Summary | Returns all text nodes from the full-text index that contain the string $text . The index full-text options are used for searching, i.e., if the index terms have been stemmed, the search string will be stemmed as well.
|
Errors | BASX0001 is raised if the index is not available. |
Examples |
|
db:info
Signatures | db:info($db as item()) as xs:string db:info($db as item(), $type as xs:string) as xs:string
|
Summary | Returns information for a database. If $type is specified, the function returns information on a database index. It must be one of the values TEXT , ATTRIBUTE , FULLTEXT , PATH , TAG , or ATTNAME .
|
Errors | BASX0001 is raised if the specified index is not available. |
Examples |
|
db:get
Signatures | db:get($db as xs:string, $path as xs:string) as xs:base64Binary
|
Summary | Retrieves the binary resource specified by $path in the xs:basex64Binary format. Introduced with Version 6.8.
|
Errors | FODC0002 is raised if the addressed resource is not found or cannot be retrieved. |
Examples |
|
db:put
Signatures | db:put($db as xs:string, $path as xs:string, $data as item()) as empty-sequence()
|
Summary | Stores a binary resource specified by $data at the location specified by $path . Introduced with Version 6.8.
|
Errors | FOUP0002 is raised if the resource cannot be stored at the specified location. |
Examples |
|
db:add
Signatures | db:add($db as item(), $input as item()*) as empty-sequence() db:add($db as item(), $input as item()*, $name as xs:string) as empty-sequence() db:add($db as item(), $input as item()*, $name as xs:string, $path as xs:string) as empty-sequence()
|
Summary | Add documents specified by $input to the database $db , using an optional document name $name and an optional path $path .
|
Errors | BASX0002 is raised if $db is not a database node.BASX0003 is raised if $db is a string and a database with that name cannot be open.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:replace
Signatures | db:replace($db as item(), $path as xs:string, $input as item()) as empty-sequence()
|
Summary | Replace a document, specified by $path in the database $db with the content of $input .
|
Errors | BASX0002 is raised if $db is not a database node.BASX0003 is raised if $db is a string and a database with that name cannot be open.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:delete
Signatures | db:delete($db as item(), $path as xs:string) as empty-sequence()
|
Summary | Delete document(s), specified by $path in the database $db .
|
Errors | BASX0002 is raised if $db is not a database node.BASX0003 is raised if $db is a string and a database with that name cannot be open.
|
Examples |
|
db:rename
Signatures | db:rename($db as item(), $path as xs:string, $newpath as xs:string) as empty-sequence()
|
Summary | Rename document(s), specified by $path to $newpath in the database $db .
|
Errors | BASX0002 is raised if $db is not a database node.BASX0003 is raised if $db is a string and a database with that name cannot be open.BASX0013 is raised if new document name(s) will be empty. |
Examples |
|
db:optimize
Signatures | db:optimize($db as xs:string) as empty-sequence() db:optimize($db as xs:string, $all as xs:boolean) as empty-sequence()
|
Summary | Optimize the data structures of the database $db . If $all is set to true() , then the whole database will be rebuilt.
|
Errors | BASX0002 is raised if $db is not a database node.BASX0003 is raised if $db is a string and a database with that name cannot be open.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 |
|