1
.\"Text automatically generated by txt2man
2
.TH basexserver 1 "15 February 2011" "" "The XML Database"
4
\fBbasexserver \fP- XML database system and XPath/XQuery processor (server mode)
9
\fBbasexserver\fP [\fB-s\fP] [\fB-dpz\fP] [\fB-c\fP] [\fIstop\fP]
16
\fBbasexserver\fP starts the server mode of the native XML database system \fBbasex\fP(1) on default port 1984.
21
Stop an existing server instance; remaining input is ignored.
25
Launch database commands before the server itself is started; all remaining text is interpreted as command input. Several commands can be separated by semicolons. (\fB-c\fP"open database;info")
29
Turn on debugging. Debugging information is output to standard error.
33
Interactively enter commands on the console, similar to standalone and client mode.
37
Specify the port on which the server will be addressable (default 1984, \fB-p9999\fP).
45
Do not generate log files.
47
On first startup a user 'admin' with default password 'admin' exists (make sure to change this)!
49
Admin permissions are needed to execute one of the following processes.
51
Creating user 'test' with password 'test':
55
> CREATE USER test test
59
As global permissions valid options are 'none', 'read', 'write', 'create' and 'admin'.
61
Revoking all global permissions from user 'test':
69
Valid local permissions are 'none', 'read' and 'write'.
71
Granting write permission on database 'factbook' to user 'test':
75
> GRANT write ON factbook TO test
79
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.
81
Showing global permissions:
90
Showing local permissions on database 'factbook':
94
> SHOW USERS ON factbook
99
Dropping of user 'test':
107
Further details on user management are to be found in the BaseX Documentation
108
Wiki (http://docs.basex.org/wiki/User_Management).
109
.SH DATABASE COMMANDS
110
A list of supported Database commands can be obtained from
114
$ basexserver \-i help
118
or by browsing http://docs.basex.org/wiki/Commands
120
Following table shows BaseX commands and the permission needed to execute the command.
121
Without appropriate permission an error is thrown and the command will not be executed.
125
Closes currently opened database. (None)
133
Returns a property value. (None)
137
Shows the help texts. (None)
141
Changes password of currently logged-in user. (None)
145
Sets a property value. (None)
149
Executes a xquery function without database access. (None)
153
Shows information about the currently opened database. (Read)
157
Shows all available databases. (Read)
161
Opens a database. (Read)
165
Executes a read-only xquery function with database access. (Read)
169
Adds documents to the currently opened database. (Write)
173
Creates the specified index. (Write)
177
Deletes documents from the currently opened database. (Write)
181
Drops the specified index. (Write)
185
Optimizes the database structure and renews the indexes. (Write)
189
Executes a xquery update function. (Write)
193
Renames a database. (Create)
197
Creates a database. (Create)
201
Drops a database. (Create)
205
Exports the database content. (Create)
209
Changes the password of an user. (Admin)
213
Creates a new user. (Admin)
217
Drops an user. (Admin)
221
Assigns permissions to users. (Admin)
225
Kills an user session on the server. (Admin)
229
Shows different server information. (Admin)
231
\fBbasexclient\fP(1), \fBbasex\fP(1), \fBbasexgui\fP(1)
235
BaseX (standalone and server) properties
239
BaseX additional GUI properties
243
user name, passwords, and permissions
247
Default database directory
253
BaseX Documentation Wiki: http://docs.basex.org
255
BaseX started as a research project of the Database and Information Systems
256
Group (DBIS) at the University of Konstanz in 2005 and soon turned into a
257
feature-rich open source XML database and XPath/XQuery processor.
259
New (3-clause) BSD License
261
BaseX is primarily developed by Christian Gruen <christian.gruen@gmail.com> with the help of others listed as
262
The BaseX Team on <http://basex.org/about-us/>
264
The man page was written by Alexander Holupirek <alex@holupirek.de> in the progress of packaging BaseX for Debian GNU/Linux.
added
removed
debian/man/basexserver.1
