Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
|-
| valign='top' | '''Errors'''
|The command fails if the specified user name is invalid, if the user does not exist, or if no password has been specified.
|-
| valign='top' | '''Errors'''
|The command fails if the specified database name is invalid.
no edit summary
|-
| valign='top' | '''Errors'''
|The command fails if one of the specified database names is invalid, if the target database already exists, if the source database does not exist or is currently locked, or if it could not be renamed for some other reason.
|-
| valign='top' | '''Examples'''
| valign='top' | '''Permission'''
|<code>ADMIN</code>
|-
| valign='top' | '''Summary'''
|Alters the <code>[password]</code> of the user specified by <code>[name]</code>. If no password is specified in the console mode, it is requested via standard input.
|-
| valign='top' | '''Errors'''
|The command fails if the specified user does not exist, or if no password has been specified.
|}
|-
| valign='top' | '''Errors'''
|The command fails if the specified database name is invalid, if the database does not exist, or if the database it could not be zipped for some other reason.
|}
|-
| valign='top' | '''Errors'''
|The command fails if one of the specified database names is invalid, if the target database already exists, if the source database does not exist, or if it could not be renamed for some other reason.
|}
==CREATE DATABASE==
|-
| valign='top' | '''Errors'''
|The command fails if the name of the database is invalid, if a database with the same specified name is currently pinnedused by another process, or if one of the documents to be added is not well-formed or could not be parsed for some other reason.
|}
|-
| valign='top' | '''Errors'''
|The command fails if the specified user name is invalid, if the user already exists, or if no password has been specified.
|}
==CS==
| valign='top' | '''Summary'''
|Drops all backups of the database with the specified <code>[name]</code>.
|}
==DROP DATABASE==
|-
| valign='top' | '''Errors'''
|The command fails if the specified database name is invalid, if the database does not exist or is currently locked, or if the database could not be deleted for some other reason.
|}
==DROP INDEX==
|-
| valign='top' | '''Summary'''
|Drops the user with the specified <code>[name]</code>. If a <code>[database]</code> is specified, the user is only dropped locally. The default <code>admin</code> user can never be dropped.|-| valign='top' | '''Errors'''|The command fails if <code>admin</code> is specified as user name, if the specified user does not exist or is logged in, or if the optional database could not be opened for modification.
|}
==EXIT==
|-
| valign='top' | '''Summary'''
|Exports all documents in the database to the specified <code>[path]</code>, using the serializer options specified by the <code>[[Options#Query_options|EXPORTER]]</code> option.|-| valign='top' | '''Errors'''|The command fails if no database is opened, if the target path or the serialization parameters are invalid, or if the documents cannot be serialized for some other reason.
|}
==FIND==
|Builds and runs a query for the specified <code>[keywords]</code>. The following modifiers can be used to further limit search:
<code>= </code> looks for exact text nodes<br/><code>@=</code> looks for exact attributes<br/><code>@ </code> looks for attributes
|-
| valign='top' | '''Errors'''
|The command fails if no database is opened.
|}
==GET==
| valign='top' | '''Summary'''
|Returns the value of the specified <code>[option]</code>. A list of all options is [[Options|available here]].
|-
| valign='top' | '''Errors'''
|The command fails if the specified option is unknown.
|}
==GRANT==
|-
| valign='top' | '''Summary'''
|Grants the specified [[User_Management|permission]] to the specified <code>[user]</code>. If a <code>[database]</code> is specified, the permissions are only granted locally. The permissions of the <code>admin</code> user cannot be modified.|-| valign='top' | '''Errors'''|The command fails if <code>admin</code> is specified as user name, if the specified index is unknown, if the specified user does not exist, or if the optional database could not be opened for modification.
|}
| valign='top' | '''Summary'''
|If <code>[command]</code> is specified, information on the specific command is printed; otherwise, all commands are listed.
|-
| valign='top' | '''Errors'''
|The command fails if the specified command is unknown.
|}
==INFO==
| valign='top' | '''Summary'''
|Shows information on the currently opened database.
|-
| valign='top' | '''Errors'''
|The command fails if no database is opened.
|}
==INFO INDEX==
| valign='top' | '''Summary'''
|Shows information on the existing index structures. The output can be optionally limited to the specified index.
|-
| valign='top' | '''Errors'''
|The command fails if no database is opened, or if the specified index is unknown.
|}
|-
| valign='top' | '''Summary'''
|Shows the internal main table of the currently opened database. An integer range or a query may be specified as argument.|-| valign='top' | '''Errors'''|The command fails if no database is opened, or if one of the specified arguments is invalid.
|}
==KILL==
| valign='top' | '''Summary'''
|Kills all sessions of the user specified by <code>[name]</code>.
|-
| valign='top' | '''Errors'''
|The command fails if <code>admin</code> is specified as user name, or if a user tries to kill his own sessions.
|}
==LIST==
| valign='top' | '''Summary'''
|Lists all available databases, or the documents in a database. <code>[path]</code> is the name of the database, optionally followed by a path to the requested documents.
|-
| valign='top' | '''Errors'''
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
|}
==OPEN==
| valign='top' | '''Summary'''
|Opens the documents in a database. <code>[path]</code> is the name of the database, optionally followed by a path to the requested documents.
|-
| valign='top' | '''Errors'''
|The command fails if the specified database cannot be opened for some unknown reason.
|}
==OPTIMIZE==
| valign='top' | '''Summary'''
|Optimizes the current database structures. If the <code>ALL</code> flag is specified, the size of all database files is minimized.
|-
| valign='top' | '''Errors'''
|The command fails if no database is opened, or if the currently opened database is a main-memory instance.
|}
==PASSWORD==
| valign='top' | '''Summary'''
|Changes the <code>[password]</code> of the current user. If no password is specified in the console mode, it is requested via standard input.
|-
| valign='top' | '''Errors'''
|The command fails if no password has been specified.
|}
==RESTORE==
| valign='top' | '''Summary'''
|Restores a database with the specified <code>[name]</code>. The name may include the timestamp of the backup file.
|-
| valign='top' | '''Errors'''
|The command fails if the specified backup does not exist, if the database to be restored is currently locked, or if it could not be restored for some other reason.
|}
==RUN==
| valign='top' | '''Summary'''
|Runs the query contained in <code>[file]</code> and prints the result.
|-
| valign='top' | '''Errors'''
|The command fails if the specified file does not exist, or if the retrieved query is invalid.
|}
| valign='top' | '''Summary'''
|Sets an <code>[option]</code> to the specified <code>[value]</code>. A list of all options is [[Options|available here]].
|-
| valign='top' | '''Errors'''
|The command fails if the specified option is unknown or if the specified value is invalid.
|}
==SHOW BACKUPS==
| valign='top' | '''Summary'''
|Shows all users that are registered in the database. If a <code>[database]</code> is specified, local users are shown.
|-
| valign='top' | '''Errors'''
|The command fails if the optional database could not be opened.
|}
==XQUERY==
| valign='top' | '''Summary'''
|Runs the specified <code>[query]</code> and prints the result.
|-
| valign='top' | '''Errors'''
|The command fails if the specified query is invalid.
|-
| valign='top' | '''Examples'''
