Database Functions

db:option('dbpath')

db:option('serializer')

declare option db:stripws 'true';
db:option('stripws')

db:option-map()

db:option-map()?serializer?json?format

db:property('db', 'size')

db:property('xmark', 'textindex')

db:property('discogs', 'uptodate')

db:property-map('db')

db:property-map('xmark')?textindex

db:list('docs')

• 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.

• 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).
• The results can be restricted to resources starting with the specified $path.

db:list-details('shop')

• 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 in an attribute.

db:dir('shop', 'books')

db:get('docs')

db:get('db', 'one')

for $i in 1 to 3
return db:get('db' || $i)//item

db:get-pre('docs', 0)

db:get-binary('DB', 'music/01.mp3')

db:get-binary('DB', 'music/01.mp3'))
=> stream:materialize()

db:get-binary('DB', 'info.txt')
=> convert:binary-to-string('UTF-8')

db:get-value('DB', 'sequence')

db:node-pre(doc('input'))

db:export('DB', '/home/john/xml/texts', { 'method': 'text' })

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

db:text('DB', 'QUERY')/..

db:text-range('DB', '2000', '2001')

db:attribute('DB', 'QUERY', 'id')/..

db:attribute-range('DB', 'id456', 'id473', 'id')

db:token('DB', 'row', 'class')/parent::div

• A single db:create call can store XML, binary, and value resources in the new database. For each input, the target resource type is determined by the item type:
  • a node is stored as an XML resource;
  • a string is interpreted as a URI pointing to a single XML file or a directory with XML files;
  • a binary item (xs:base64Binary, xs:hexBinary) is stored as a binary resource (see db:put-binary);
  • all other items (maps, arrays, numbers, …) are stored as a value resource (see db:put-value).
• An entry in $paths can be a plain string (target path only) or a single-entry map { path: type } overriding the resource type. Valid types are xml, binary, and value:
  • For binary, string inputs are interpreted as URIs pointing to a file.
  • For value, the input is stored verbatim, including nodes and binary items.
• Paths for binary and value resources must be non-empty and must not end with a slash. For XML inputs, a path is required unless the input provides an inherent name, as described above; paths ending with a slash indicate a target directory.
• The parsing and indexing behavior can be controlled via $options:
  • Allowed options are ADDCACHE and the indexing, full-text indexing, parsing and XML parsing options, all in lower case.
  • Parsing options only apply to string input (URIs, XML strings), since nodes are already parsed.
• 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.

db:create('DB')

db:create('DB', '/home/dir/doc.xml')

db:create('DB', <a/>, 'doc.xml')

db:create('DB', '/home/dir/', 'docs/dir')

db:create('DB', file:list('.'), (), { 'ftindex': true() })

db:create('DB',
  (<doc/>, xs:hexBinary('414243'), [ 1 to 10 ]),
  ('doc.xml', 'binary.data', 'numbers')
)

db:create('DB',
  ('/home/dir/notes.txt', <a/>),
  ({ 'notes.txt': 'value' }, 'a.xml')
)

• Input/path semantics, type dispatch, and per-path resource type overrides match db:create.
• db:add never overwrites existing resources:
  • XML documents may share a path with existing or other newly added documents (use db:put to enforce single instances).
  • Binary and value resources require unique paths. Adding a binary or value resource raises a conflict if the same path already exists in the database, or if it appears twice in the same call.
• 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 only apply to string input (URIs, XML strings), since nodes are already parsed.

db:add("DB", "/home/dir/doc.xml")

db:add('DB', <a/>, 'doc.xml')

db:add('DB', '/home/dir', 'docs/dir', { 'addcache': true() })

db:add('DB',
  (<doc/>, xs:hexBinary('414243'), { 'k': 'v' }),
  ('doc.xml', 'binary.data', 'config')
)

• The behavior can be controlled via $options:
  • Allowed options are ADDCACHE, REPLACE and the parsing and XML parsing options, all in lower case.
  • Parsing options only apply to string input (URIs, XML strings), since nodes are already parsed.
• See db:create for more details on the input argument.

db:put('DB', '/home/dir/doc.xml', 'docs/dir/doc.xml')

db:put('DB', <a/>, 'docs/dir/doc.xml')

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:put('db', doc($path), $file)

• If $input is a binary item (xs:base64Binary, xs:hexBinary), it is stored verbatim.
• If $input is a string-typed or untyped atomic item, it is interpreted as a URI pointing to an existing file, whose contents are read and stored.
• Any other item type raises an error.

db:put-binary('DB', file:read-binary('video.mov'), 'video/sample.mov')

db:put-binary('DB', 'video.mov', 'video/sample.mov')

let $db := 'db'
let $src-path := 'src/'
let $trg-path := 'trg/'
for $src in db:list($db, $src-path)
where db:type($db, $src) = 'binary'
let $trg := $trg-path || substring-after($src, $src-path)
return db:put-binary($db, db:get-binary($db, $src), $trg)

db:put-value('DB', 1 to 10000, 'sequence')

db:put-value(
  'factbook',
  map:merge(
    for $country in db:get('factbook')//country
    return map:entry($country/@name, $country//city/name ! string())),
  'cities'
)

db:delete('DB', 'docs/dir/doc.xml')

db:delete('DB', 'docs/dir')

• 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 indexing options. UPDINDEX is only supported if $all is true.

db:optimize('DB')

db:optimize('DB', true(), { 'ftindex': true() })

db:rename('DB', 'docs/dir/doc.xml', 'docs/dir/newdoc.xml')

db:rename('DB', 'docs/dir', 'docs/newdir')

db:drop('DB')

db:create-backup('DB', { 'compress': false() })

db:drop-backup('DB')

db:drop-backup('DB-2014-03-13-17-36-44')

db:alter-backup('DB', 'DB2')

db:restore('DB')

db:restore('DB-2014-03-13-18-05-45')

db:backups('factbook')

db:exists('DB')

db:exists('DB', 'resource')

db:type('DB', 'factbook.xml')

db:content-type('DB', 'docs/doc01.pdf')

db:content-type('DB', 'docs/doc01.xml')

db:content-type('DB', 'docs/doc01')