From BaseX Documentation
This page is part of the Getting Started Section.
In BaseX, a database is a pretty light-weight concept and can be compared to a collection. It contains an arbitrary number of resources, addressed by their unique database path. Resources can either be XML documents or raw files (binaries). Some information on binary data can be found on an extra page.
New databases can be created via commands, in the GUI, or with any of our APIs. If some input is specified along with the create operation, it will be added to the database in a bulk operation:
CREATE DB db /path/to/resourceswill add initial documents to a database
- GUI: Go to Database → New, press Browse to choose an initial file or directory, and press OK
Stored resources and external documents can be accessed in different ways:
Various XQuery functions exist to access XML documents in databases and from other locations:
|Returns all documents that are found in the database |
|Returns all documents at the location |
If no path is specified after the database, all documents in the database will be returned.
If no argument is specified, all documents of the currently opened database will be returned.
|Returns the document at the location |
An error is raised if the specified addresses does not address exactly one document.
fn:base-uri() functions return URIs that can be reused as arguments for the
fn:collection() functions. As a result of this, as an example, the following query will always return
every $c in collection('anyDB') satisfies doc-available(document-uri($c))
If the argument of
fn:collection() does not start with a valid database name, or if the addressed database does not exist, the string is interpreted as URI reference, and the documents found at this location will be returned. Examples:
doc("http://web.de"): retrieves the addressed URI and returns it as a main-memory document node.
collection("/path/to/docs"): returns a main-memory collection with all XML documents found at the addressed file path.
db:retrieve("dbname", "path/to/docs")returns raw files in their Base64 representation. By choosing
"method=raw"as Serialization Option, the data is returned in its original byte representation:
declare option output:method "raw"; db:retrieve('multimedia', 'sample.avi')
RETRIEVEreturns raw files without modifications.
- With REST and WebDAV, all database resources can be requested in a uniform way, no matter if they are well-formed XML documents or binary files.
Once you have created a database, additional commands exist to modify its contents:
- XML documents can be added with the
- Raw files are added with
- Resource can be replaced with other ones with the
- Resources can be deleted via
The AUTOFLUSH option can be turned off before bulk operations (i.e. before a large number of new resources is added to the database).
The following commands create an empty database, add two resources, explicitly flush data structures to disk, and finally delete all inserted data:
CREATE DB example SET AUTOFLUSH false ADD example.xml ADD ... STORE TO images/ 123.jpg FLUSH DELETE /
You may as well use the BaseX-specific XQuery Database Functions to add, replace and delete XML documents:
let $root := "/path/to/xml/documents/" for $file in file:list($root) return db:add("database", $root || $file)
Last but not least, XML documents can also be added via the GUI and the Database menu.
All resources stored in a database can be exported, i.e., written back to disk. This can be done in several ways:
EXPORTwrites all resources to the specified target directory
- GUI: Go to Database → Export, choose the target directory and press OK
- WebDAV: Locate the database directory (or a sub-directory of it) and copy all contents to another location
- Version 7.2.1
fn:base-uri()now return strings that can be reused with
fn:collection()to reopen the original document.