From BaseX Documentation
This page is part of the Getting Started Section.
In BaseX, a single database contains an arbitrary number of resources, addressed by their unique database path. Since Version 7.0, resources can either be XML documents or raw files (binaries). Sets of XML documents are also called collections. Some information on binary data can be found on an extra page.
New databases can either be created in the GUI, on command line, or using any of our APIs. XML documents can be specified along with the create operation, which will be added to the database in a bulk operation:
- Console: enter
basex -c "CREATE DB dbname /path/to/resources"
- GUI: Go to Database → New, press Browse to choose an initial file or directory, and press OK
Various parsers can be chosen to influence the database creation, or to convert different formats to XML,
Existing databases can eventually be dropped again:
- Console: enter
basex -c "DROP DB dbname".
- GUI: Go to Database → Manage and choose the database to be dropped
Database must follow the valid names constraints.
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.
Stored resources and external documents can be accessed in different ways:
Updated with Version 7.2.1:
Various XQuery functions exist to access XML documents in databases and from other locations:
db:open("dbname", "PATH/TO/DOCS"): returns documents that are found in the specified database at the specified (optional) path.
collection("PATH/TO/DOCS"): returns all documents that are found at the location
TO/DOCSin the database
PATH. If the addressed database does not exist, or if the argument does not start with a valid database name, the string is interpreted as URI reference, and the documents found at this location will be returned.
doc("PATH/TO/DOC.XML"): returns the document found at the location
TO/DOC.XMLin the database
PATH. If the addressed database does not exist, or if the argument does not start with a valid database name, the string is interpreted as URI reference, and the document found at this location will be returned.
fn:base-uri() functions returns paths that can be reused as arguments for the
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.
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
fn:base-uri()now return strings that can be reused with
fn:collection()to reopen the original document.