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

• The 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:
  • Allowed options are ADDCACHE and the indexing, full-text indexing, 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.
• 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() })

• A document with the same path may occur more than once in a database. If you want to enforce single instances, use db:put 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.

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

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

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

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

db:put-binary('DB', file:read-binary('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')