Commands
This page lists all commands that are supported by BaseX. Commands can be either run from command line or from the input field in the GUI frontend. If commands are triggered by the GUI itself, they will be listed in the Info View.
ADD
ADD (AS [name]) (TO [target]) [input]
Adds [input]
as [name]
to the database, using an optional
[target]
path.
ALTER
ALTER [USER|DATABASE] [...]
Alters user password or database name:
USER [name] ([password])
:
- alters the password of a user.
DATABASE [name] [newname]
- alters the name of a database.
BACKUP
BACKUP [name]
Creates a backup of the specified database.
CHECK
CHECK [input]
Opens an existing database or creates a new instance.
CLOSE
CLOSE
Closes the currently opened database.
COPY
COPY [name] [newname]
Creates an identical database copy.
CREATE
CREATE [DATABASE|INDEX|USER] [...]
Creates a new database, index or user:
DATABASE [name] ([input])
:
- creates the database
[name]
with an optional[input]
INDEX [TEXT|ATTRIBUTE|FULLTEXT|PATH]
:
- creates the specified index
USER [name] ([password])
:
- creates the specified user
CS
CS [query]
Evaluates the query and sets the result as new context set.
DELETE
DELETE [name]
Deletes documents from the currently opened database.
DROP
DROP [DB|INDEX|USER] [...]
Drops a database, index or user:
DB [name]
:
- drops the database
INDEX [PATH|TEXT|ATTRIBUTE|FULLTEXT]
:
- drops the specified index
USER [name] (ON [db])
:
- drops the specified user (on a database)
BACKUP [name]
:
- drops the database backup
EXIT
EXIT
Exits the BaseX console.
EXPORT
EXPORT [path]
Exports the database to [path]
.
FIND
FIND [query]
The following modifiers can be used:
- = : looks for exact text nodes"
- @= : looks for exact attributes
- @ : looks for attributes
GET
GET [option]
Shows the value of a global option. A list of all options is available here.
GRANT
GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [db]) TO [user]
Grants permissions (on a database) to a user.
HELP
HELP ([command])
If [command]
is specified, information on the specific
command is printed; otherwise, all commands are listed.
INFO
INFO ([DB|INDEX|STORAGE])
Shows information on the currently opened database:
no argument
: show global informationDB
: shows database informationINDEX
: shows index informationSTORAGE [start end] | [query]
: show internal database table
KILL
KILL [name]
Kills all sessions of the specified user.
LIST
LIST ([path])
Lists all available databases, or the documents within a database [path].
OPEN
OPEN [name]
Opens the specified database [name]
.
OPTIMIZE
OPTIMIZE
Optimizes the current database structures.
PASSWORD
PASSWORD ([password])
Changes the user's password.
RESTORE
RESTORE [name]
Restores a backup of the specified database.
RUN
RUN [path]
Evaluates an query from [path]
and prints the result.
SET
SET [option] ([value])
Available options [option]
with value [value]
= on/off:
QUERYINFO
: Display query infoDEBUG
: Display debug infoSERIALIZE
: Serialize query resultsCHOP
: Chopp XML whitespacesENTITY
: Parse XML entitiesTEXTINDEX
: Turn on/off text indexingATTRINDEX
: Turn on/off attribute value indexingFTINDEX
: Turn on/off full-text indexingPATHINDEX
: Turn on/off path indexing
A list of all options is available here.
SHOW
SHOW [DATABASES|SESSIONS|USERS|BACKUPS]
Shows server information:
DATABASES
: shows currently opened databases.SESSIONS
: shows current database sessions.USERS (ON [db])
: shows users (on a database).BACKUPS
: shows backups.
XQUERY
XQUERY [query]
Evaluates the specified query and prints the result.