Changes

Jump to navigation Jump to search
1,849 bytes added ,  01:30, 6 May 2011
no edit summary
A short version exists for some command arguments. For example, you may replace the <code>DATABASE</code> keyword with <code>DB</code>.
<hr/>
<div style="float:left; width:48%;">
==ADD==
{|
The optional name is ignored if the input is a directory.
|}
 ===ALTER==={||-| valign='top'width='90' | '''Signature'''|<code>ALTER [USER|&#124;DATABASE] [...]</code>|-| valign='top' | '''Summary''' |Alters the password of a user, or the name of a database:
* <code>USER [name] ([password])</code>:
: Alters the <code>[password]</code> of the user specified with <code>[name]</code>. If no password is specified in the console mode, it is requested via standard input.
* <code>DATABASE [name] [newname]</code>
: Alters the <code>[name]</code> of a database to <code>[newname]</code>.
<hr/>|}===BACKUP==={||-| valign='top'width='90' | '''Signature'''|<code>BACKUP [name]</code>|-| valign='top' | '''Summary''' |Creates a zipped backup of the specified database. The backup file will be suffixed with the current timestamp.<hr/>|}===CHECK==={||-| valign='top' width='90' | '''Signature'''|<code>CHECK [input]</code>|-| valign='top' | '''Summary''' |Opens an existing database for the specified <code>[input]</code> or creates a new instance.<hr/>|}===CLOSE==={||-| valign='top'width='90' | '''Signature'''|<code>CLOSE </code>|-| valign='top' | '''Summary''' |Closes the currently opened database.<hr/>|}===COPY==={||-| valign='top' width='90' | '''Signature'''|<code>COPY [name] [newname]</code>|-| valign='top' | '''Summary''' |Creates an identical a copy of the database specified databaseby [name].<hr/>|}===CREATE==={||-| valign='top' width='90' | '''Signature'''|<code>CREATE [DATABASE|&#124;INDEX|&#124;USER] [...]</code>|-| valign='top' | '''Summary''' |Creates a new database, index or user:
* <code>DATABASE [name] ([input])</code>:
: Creates the database <code>[name]</code> with an optional <code>[input]</code>.
: The input may either be a single XML document, a directory, a remote URL or a plain XML string.
* <code>INDEX [TEXT|&#124;ATTRIBUTE|&#124;FULLTEXT|&#124;PATH]</code>:
: Creates the specified index
* <code>USER [name] ([password])</code>:
: Creates a user with the specified [name] and [password]. If no password is specified in the console mode, it is requested via standard input.
<hr/>|}===CS==={||-| valign='top'width='90' | '''Signature'''|<code>CS [query]</code>|-| valign='top' | '''Summary''' |Evaluates the specified <code>[query]</code> and sets the result as new context set.<hr/>|}===DELETE==={||-| valign='top'width='90' | '''Signature'''|<code>DELETE [path]</code>|-| valign='top' | '''Summary''' |Deletes all documents from the currently opened database that start with the specified <code>[path]</code>.<hr/>|}===DROP==={||-| valign='top'width='90' | '''Signature'''|<code>DROP [DATABASE|&#124;INDEX|&#124;USER] [...]</code>|-| valign='top' | '''Summary''' |Drops a database, index or user:
* <code>DATABASE [name]</code>:
: Drops the database with the specified <code>[name]</code>.
* <code>INDEX [PATH|&#124;TEXT|&#124;ATTRIBUTE|&#124;FULLTEXT]</code>:
: Drops the specified index.
* <code>USER [name] (ON [database])</code>:
* <code>BACKUP [name]</code>:
: Drops all backups for the database with the specified <code>[name]</code>.
<hr/>|}===EXIT==={||-| valign='top' width='90'| '''Signature'''|<code>EXIT </code>|-| valign='top' | '''Summary''' |Exits the console mode.<hr/>|}===EXPORT==={||-| valign='top'width='90' | '''Signature'''|<code>EXPORT [path]</code>|-| valign='top' | '''Summary''' |Exports all documents in the database to the specified <code>[path]</code>.|}</div><div style="float:left; width:4%;">&nbsp;</div><div style="float:left; width:48%;">===FIND==={||-| valign='top' width='90' | '''Signature'''|<code>FIND [keywords]</code>|-| valign='top' | '''Summary''' |Builds and runs a query for the specified <code>[keywords]</code>. The following modifiers can be used to further limit search:
:= : looks for exact text nodes
:@= : looks for exact attributes
:@ : looks for attributes
<hr/>|}===GET==={||-| valign='top' width='90' | '''Signature'''|<code>GET [option]</code>|-| valign='top' | '''Summary''' |Returns the value of the specified <code>[option]</code>. A list of all options is [[Options|available here]].<hr/>|}===GRANT==={||-| valign='top' width='90' | '''Signature'''|<code>GRANT [NONE|&#124;READ|&#124;WRITE|&#124;CREATE|&#124;ADMIN] (ON [database]) TO [user]</code>|-| valign='top' | '''Summary''' |Grants the specified [[User_Management#Permissions|permission]] to the specified <code>[user]</code>. If a <code>[database]</code> is specified, the permissions are only granted locally.<hr/>|}===HELP==={||-| valign='top' width='90' | '''Signature'''|<code>HELP ([command])</code>|-| valign='top' | '''Summary''' |If <code>[command]</code> is specified, information on the specificcommand is printed; otherwise, all commands are listed.<hr/>|}===INFO==={||-| valign='top' width='90' | '''Signature'''|<code>INFO ([DATABASE|&#124;INDEX|&#124;STORAGE])</code>|-| valign='top' | '''Summary''' |Shows information on the currently opened database:
* <code>no argument</code>: Shows global information on the DBMS
* <code>DATABASE</code>: Shows general database information
* <code>INDEX</code>: Shows information on the existing index structures
* <code>STORAGE [start end] | [query]</code>: Shows the main table of the internal storage
<hr/>|}===KILL==={||-| valign='top' width='90' | '''Signature'''|<code>KILL [name]</code>|-| valign='top' | '''Summary''' |Kills all sessions of the user specified by <code>[name]</code>.<hr/>|}===LIST==={||-| valign='top'width='90' | '''Signature'''|<code>LIST ([path])</code>|-| valign='top' | '''Summary''' |Lists all available databases, or the documents in a database.<code>[path]</code> is the name of the database, optionallyfollowed by a path to the requested documents.<hr/>|}===OPEN==={||-| valign='top' width='90'| '''Signature'''|<code>OPEN [path]</code>|-| valign='top' | '''Summary''' |Opens the documents in a database.<code>[path]</code> is the name of the database, optionallyfollowed by a path to the requested documents.<hr/>|}===OPTIMIZE==={||-| valign='top'width='90' | '''Signature'''|<code>OPTIMIZE (ALL)</code>|-| valign='top' | '''Summary''' |Optimizes the current database structures. If the <code>ALL</code>flag is specified, the size of all database files is minimized.<hr/>|}===PASSWORD==={||-| valign='top' width='90'| '''Signature'''|<code>PASSWORD ([password])</code>|-| valign='top' | '''Summary''' |Changes the <code>[password]</code> of the current user. If no password isspecified in the console mode, it is requested via standard input.<hr/>|}===RESTORE==={||-| valign='top' width='90' | '''Signature'''|<code>RESTORE [name]</code>|-| valign='top' | '''Summary''' |Restores a database with the specified [name]. The name may include the timestamp of the backup file.<hr/>|}===RUN==={||-| valign='top' width='90' | '''Signature'''|<code>RUN [path]</code>|-| valign='top' | '''Summary''' |Runs the query file specified by <code>[path]</code> and prints the result.<hr/>|}===SET==={||-| valign='top'width='90' | '''Signature'''|<code>SET [option] ([value])</code>|-| valign='top' | '''Summary''' |Sets an <code>[option]</code> to the specified <code>[value]</code>.A list of all options is [[Options|available here]].<hr/>|}===SHOW==={||-| valign='top' width='90' | '''Signature'''|<code>SHOW [DATABASES|&#124;SESSIONS|&#124;USERS|&#124;BACKUPS]</code>|-| valign='top' | '''Summary''' |Shows server information:
* <code>DATABASES</code>: Shows the currently opened databases.
* <code>SESSIONS</code>: Shows the currently active database sessions.
* <code>USERS (ON [database])</code>: Shows all known users. If a <code>[database]</code> is specified, local users are shown.
* <code>BACKUPS</code>: Shows all database backups.
<hr/>|}===XQUERY==={||-| valign='top' width='90' | '''Signature'''|<code>XQUERY [query]</code>|-| valign='top' | '''Summary''' |Runs the specified <code>[query]</code> and prints the result.</div><hr/>|}
[[Category:Beginner]]
[[Category:Server]]
 
__NOTOC__
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Navigation menu