Graphical User Interface

From BaseX Documentation
Revision as of 21:53, 11 January 2011 by CG (talk | contribs) (moved BaseX GUI to GUI Tutorial)
Jump to navigation Jump to search

Startup

see the Startup Overview.

First Operations

To get to know BaseX, we advise to run some of the following operations to see how it works and get your first indentations.

Create a database/collection

Go to Database/New menu you can choose a folder of xml files or a single xml file to either create a single xml file database or a collection with a bunch of xml files.

Furthermore there are tabs for parsing, indexes and full-text options:

Parsing
Here you can change settings for the parser and choose a file for your xml catalog.
Indexes
Here you can choose what indexes to be created with the database: text index, attribute index and path summary are available
as indexes.
Full-Text
Here you can activate the full-text index. Furthermore some more options can be set, like language, wildcards and a stopword list.

Add/Delete documents

If you have opened a database you can add (Database/Add documents) or delete (Database/Delete documents) on an easy way. Just go to the designated menu and follow the further steps.

Add documents
Choose a file or directory to add to your database. As path you can enter a target path in your database, where
the new documents have to be added.
Delete documents
Enter the path of the documents which you like to delete, the info message will show you how many documents are effected.

Manage databases

In the Database/Manage menu you can backup, restore, rename and drop a database.

Backup
The backup-file is stored in the database directory.
The file is named db_name-timestamp.zip.
Restore
To restore the database the file with the newest timestamp is taken.

Execute a query

For executing a query there are two ways:

Search mode in the combo box of the main window
Here you can enter your query with the help of the query suggest feature, which will provide you with suggestions for path steps.
Query View
Here you can enter your query with the help of an advanced query editor with syntax highlighting and detailed error feedback.

If you are not familiar with XQuery, you can execute an Easy Search.

See also

BaseX Standalone, BaseX Server, Getting Started, Advanced User Portal