NAMEbasexserver - XML database system and XPath/XQuery processor (server mode)
SYNOPSISbasexserver [-dpsz] [-c] [stop]
DESCRIPTIONbasexserver starts the server mode of the native XML database system basex(1) on default port 1984.
OPTIONSstop Stop an existing server instance; remaining input is ignored. -c<cmd> Launch database commands before the server itself is started; all remaining text is interpreted as command input. Several commands can be separated by semicolons. (-c"open database;info") -d Turn on debugging. Debugging information is output to standard error. -i Interactively enter commands on the console, similar to standalone and client mode. -p<num> Specify the port on which the server will be addressable (default 1984, -p9999). -s Start as daemon. -z Do not generate log files.
USER MANAGEMENTOn first startup a user 'admin' with default password 'admin' exists (make sure to change this)! Admin permissions are needed to execute one of the following processes. o Creating user 'test' with password 'test': > CREATE USER test test As global permissions valid options are 'none', 'read', 'write', 'create' and 'admin'. o Revoking all global permissions from user 'test': > GRANT none TO test Valid local permissions are 'none', 'read' and 'write'. o Granting write permission on database 'factbook' to user 'test': > GRANT write ON factbook TO test Note: Local permissions overwrite global permissions. As a consequence, the 'test' user will only be allowed to access (i.e., read and write) the 'factbook' database. If no local permissions are set, the global rights are inherited. o Showing global permissions: > SHOW USERS o Showing local permissions on database 'factbook': > SHOW USERS ON factbook o Dropping of user 'test': > DROP USER test Further details on user management are to be found in the BaseX Documentation Wiki (//docs.basex.org/wiki/User_Management).
DATABASE COMMANDSA list of supported Database commands can be obtained from $ basexserver -i help or by browsing //docs.basex.org/wiki/Commands Following table shows BaseX commands and the permission needed to execute the command. Without appropriate permission an error is thrown and the command will not be executed. close Closes currently opened database. (None) exit Exits BaseX. (None) get Returns a property value. (None) help Shows the help texts. (None) password Changes password of currently logged-in user. (None) set Sets a property value. (None) xquery Executes a xquery function without database access. (None) info Shows information about the currently opened database. (Read) list Shows all available databases. (Read) open Opens a database. (Read) xquery Executes a read-only xquery function with database access. (Read) add Adds documents to the currently opened database. (Write) create index Creates the specified index. (Write) delete Deletes documents from the currently opened database. (Write) drop index Drops the specified index. (Write) optimize Optimizes the database structure and renews the indexes. (Write) xquery Executes a xquery update function. (Write) alter db Renames a database. (Create) create db Creates a database. (Create) drop db Drops a database. (Create) export Exports the database content. (Create) alter user Changes the password of an user. (Admin) create users Creates a new user. (Admin) drop user Drops an user. (Admin) grant Assigns permissions to users. (Admin) kill Kills an user session on the server. (Admin) show Shows different server information. (Admin)
SEE ALSObasexclient(1), basex(1), basexgui(1) ~/.basex BaseX (standalone and server) properties ~/.basexgui BaseX additional GUI properties ~/.basexperm user name, passwords, and permissions ~/BaseXData Default database directory ~/BaseXData/.logs Server logs BaseX Documentation Wiki: //docs.basex.org
HISTORYBaseX started as a research project of the Database and Information Systems Group (DBIS) at the University of Konstanz in 2005 and soon turned into a feature-rich open source XML database and XPath/XQuery processor.
LICENSENew (3-clause) BSD License
AUTHORBaseX is developed by a bunch of people called 'The BaseX Team' <//basex.org/about-us/> led by Christian Gruen <firstname.lastname@example.org>. The man page was written by Alexander Holupirek <email@example.com> while packaging BaseX for Debian GNU/Linux. 13 May 2011 BASEXSERVER(1)