Commands

From BaseX Documentation
Revision as of 15:10, 6 December 2010 by Lukas.kircher (talk | contribs) (added WRITEBACK property to SET CMD)
Jump to navigation Jump to search

Here you find a description of all database commands which you can enter in the console mode, in the Command text field in the GUI, or send to the BaseX server:

Database Commands

Create

CREATE [DB|FS|INDEX|USER] [...]
Creates a new database, index or user:

  • DB [name] ([input]):
    creates the database [name] with an optional [input]
  • INDEX [TEXT|ATTRIBUTE|FULLTEXT|PATH]:
    creates the specified index
  • FS [name] [path] ([mountpoint] [backingstore]):
    creates filesystem database [name] for [path] (using [mountpoint] and [backingstore] if FUSE is activated)
  • USER [name] ([password]):
    creates the specified user

Open

OPEN [name]
Opens the specified database [name].


Add

ADD (AS [name]) (TO [target]) [input]
Adds [input] as [name] to the database, using an optional [target] path.


Delete

DELETE [name]
Deletes a document from the current database.


Info

INFO ([DB|INDEX|TABLE])
Shows information on the currently opened database:

  • no argument: show global information
  • DB: shows database information
  • INDEX: shows index information
  • TABLE [start end] | [query]: show internal database table

Close

CLOSE
Closes the current database.


List

LIST
Lists all available databases.


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]:
    drops the specified user

Export

EXPORT [path]
Exports the database to [path].


Optimize

OPTIMIZE
Optimizes the current database structures.



Query Commands

Xquery

XQUERY [query]
Evaluates the specified query and prints the result.


Find

FIND [query]
The following modifiers can be used:


Run

RUN [path]
Evaluates an query from [path] and prints the result.


CS

CS [query]
Evaluates the query and sets the result as new context set.



Admin Commands

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.

Grant

GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [db]) TO [user]
Grants permissions (on a database) to a user.


Alter

ALTER [USER|DB] [...]
Alters user password or database name:

  • USER [name] ([password]):
    alters the password of a user.
  • DB [name] [newname]:
    alters the name of a database.

Kill

KILL [name]
Kills all sessions of the specified user.


Backup

BACKUP [name]
Creates a backup of the specified database.


Restore

RESTORE [name]
Restores a backup of the specified database.



General Commands

Set

SET [option] ([value])
Available options [option] with value [value] = on/off:

  • QUERYINFO: Display of query info
  • DEBUG: Display of debug info
  • SERIALIZE: Serialization of query results
  • CHOP: Chopping of XML whitespaces
  • ENTITY: Parsing of XML entities
  • TEXTINDEX: Text indexing
  • ATTRINDEX: Attribute value indexing
  • FTINDEX: Full-text indexing
  • PATHINDEX: Path indexing
  • WRITEBACK: Propagating changes to input file

Have a look into the <a href='faq#5.4'>FAQ</a> to find a complete list of available options.

Password

PASSWORD ([password])
Changes the user's password.


Help

HELP ([command])
If [command] is specified, information on the specific command is printed; otherwise, all commands are listed.


Exit

EXIT
Exits BaseX.