Difference between revisions of "Commands"

From BaseX Documentation
Jump to navigation Jump to search
Line 7: Line 7:
 
'''<code>ADD (AS [name]) (TO [target]) [input]</code>'''
 
'''<code>ADD (AS [name]) (TO [target]) [input]</code>'''
  
−
Adds '''<code>[input]</code>''' as '''<code>[name]</code>''' to the database, using an optional
+
Adds <code>[input]</code> as <code>[name]</code> to the database, using an optional
−
'''<code>[target]</code>''' path.
+
<code>[target]</code> path.
  
 
===ALTER===
 
===ALTER===
Line 15: Line 15:
  
 
Alters user password or database name:
 
Alters user password or database name:
−
* '''<code>USER [name] ([password])</code>''':
+
* <code>USER [name] ([password])</code>:
 
: alters the password of a user.
 
: alters the password of a user.
−
* '''<code>DATABASE [name] [newname]</code>'''
+
* <code>DATABASE [name] [newname]</code>
 
: alters the name of a database.
 
: alters the name of a database.
  
Line 37: Line 37:
  
 
Creates a new database, index or user:
 
Creates a new database, index or user:
−
* '''<code>DATABASE [name] ([input])</code>''':
+
* <code>DATABASE [name] ([input])</code>:
−
: creates the database '''<code>[name]</code>''' with an optional '''<code>[input]</code>'''
+
: creates the database <code>[name]</code> with an optional <code>[input]</code>
−
* '''<code>INDEX [TEXT|ATTRIBUTE|FULLTEXT|PATH]</code>''':
+
* <code>INDEX [TEXT|ATTRIBUTE|FULLTEXT|PATH]</code>:
 
: creates the specified index
 
: creates the specified index
−
* '''<code>FS [name] [path] ([mountpoint] [backingstore])</code>''':
+
* <code>FS [name] [path] ([mountpoint] [backingstore])</code>:
−
: creates filesystem database '''<code>[name]</code>''' for '''<code>[path]</code>'''
+
: creates filesystem database <code>[name]</code> for <code>[path]</code>
−
: (using '''<code>[mountpoint]</code>''' and '''<code>[backingstore]</code>''' if FUSE is activated)
+
: (using <code>[mountpoint]</code> and <code>[backingstore]</code> if FUSE is activated)
−
* '''<code>USER [name] ([password])</code>''':
+
* <code>USER [name] ([password])</code>:
 
: creates the specified user
 
: creates the specified user
  
Line 64: Line 64:
  
 
Drops a database, index or user:
 
Drops a database, index or user:
−
* '''<code>DATABASE [name]</code>''':
+
* <code>DATABASE [name]</code>:
 
: drops the database
 
: drops the database
−
* '''<code>INDEX [PATH|TEXT|ATTRIBUTE|FULLTEXT]</code>''':
+
* <code>INDEX [PATH|TEXT|ATTRIBUTE|FULLTEXT]</code>:
 
: drops the specified index
 
: drops the specified index
−
* '''<code>USER [name]</code>''':
+
* <code>USER [name]</code>:
 
: drops the specified user
 
: drops the specified user
−
* '''<code>BACKUP [name]</code>''':
+
* <code>BACKUP [name]</code>:
 
: drops the database backup
 
: drops the database backup
  
Line 83: Line 83:
 
'''<code>EXPORT [path]</code>'''
 
'''<code>EXPORT [path]</code>'''
  
−
Exports the database to '''<code>[path]</code>'''.
+
Exports the database to <code>[path]</code>.
  
 
===FIND===
 
===FIND===
Line 104: Line 104:
 
'''<code>HELP ([command])</code>'''
 
'''<code>HELP ([command])</code>'''
  
−
If '''<code>[command]</code>''' is specified, information on the specific
+
If <code>[command]</code> is specified, information on the specific
 
command is printed; otherwise, all commands are listed.
 
command is printed; otherwise, all commands are listed.
  
Line 112: Line 112:
  
 
Shows information on the currently opened database:
 
Shows information on the currently opened database:
−
* '''<code>no argument</code>''': show global information
+
* <code>no argument</code>: show global information
−
* '''<code>DATABASE</code>''': shows database information
+
* <code>DATABASE</code>: shows database information
−
* '''<code>INDEX</code>''': shows index information
+
* <code>INDEX</code>: shows index information
−
* '''<code>STORAGE [start end] | [query]</code>''': show internal database table
+
* <code>STORAGE [start end] | [query]</code>: show internal database table
  
 
===KILL===
 
===KILL===
Line 133: Line 133:
 
'''<code>OPEN [name]</code>'''
 
'''<code>OPEN [name]</code>'''
  
−
Opens the specified database '''<code>[name]</code>'''.
+
Opens the specified database <code>[name]</code>.
  
 
===OPTIMIZE===
 
===OPTIMIZE===
Line 157: Line 157:
 
'''<code>RUN [path]</code>'''
 
'''<code>RUN [path]</code>'''
  
−
Evaluates an query from '''<code>[path]</code>''' and prints the result.
+
Evaluates an query from <code>[path]</code> and prints the result.
  
 
===SET===
 
===SET===
Line 163: Line 163:
 
'''<code>SET [option] ([value])</code>'''
 
'''<code>SET [option] ([value])</code>'''
  
−
Available options '''<code>[option]</code>''' with value '''<code>[value]</code>''' = on/off:
+
Available options <code>[option]</code> with value <code>[value]</code> = on/off:
−
* '''<code>QUERYINFO</code>''': Display of query info
+
* <code>QUERYINFO</code>: Display of query info
−
* '''<code>DEBUG</code>''': Display of debug info
+
* <code>DEBUG</code>: Display of debug info
−
* '''<code>SERIALIZE</code>''': Serialization of query results
+
* <code>SERIALIZE</code>: Serialization of query results
−
* '''<code>CHOP</code>''': Chopping of XML whitespaces
+
* <code>CHOP</code>: Chopping of XML whitespaces
−
* '''<code>ENTITY</code>''': Parsing of XML entities
+
* <code>ENTITY</code>: Parsing of XML entities
−
* '''<code>TEXTINDEX</code>''': Text indexing
+
* <code>TEXTINDEX</code>: Text indexing
−
* '''<code>ATTRINDEX</code>''': Attribute value indexing
+
* <code>ATTRINDEX</code>: Attribute value indexing
−
* '''<code>FTINDEX</code>''': Full-text indexing
+
* <code>FTINDEX</code>: Full-text indexing
−
* '''<code>PATHINDEX</code>''': Path indexing
+
* <code>PATHINDEX</code>: Path indexing
  
 
Have a look into [[Settings]] to find a complete list of available options.
 
Have a look into [[Settings]] to find a complete list of available options.
Line 181: Line 181:
  
 
Shows server information:
 
Shows server information:
−
* '''<code>DATABASES</code>''': shows currently opened databases.
+
* <code>DATABASES</code>: shows currently opened databases.
−
* '''<code>SESSIONS</code>''': shows current database sessions.
+
* <code>SESSIONS</code>: shows current database sessions.
−
* '''<code>USERS (ON [db])</code>''': shows users (on a database).
+
* <code>USERS (ON [db])</code>: shows users (on a database).
−
* '''<code>BACKUPS</code>''': shows backups.
+
* <code>BACKUPS</code>: shows backups.
  
 
===XQUERY===
 
===XQUERY===

Revision as of 02:26, 16 December 2010

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:

ADD

ADD (AS [name]) (TO [target]) [input]

Adds [input] as [name] to the database, using an optional [target] path.

ALTER

ALTER [USER|DATABASE] [...]

Alters user password or database name:

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

BACKUP

BACKUP [name]

Creates a backup of the specified database.

CLOSE

CLOSE

Closes the currently opened database.

CREATE

CREATE [DATABASE|FS|INDEX|USER] [...]

Creates a new database, index or user:

  • DATABASE [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

CS

CS [query]

Evaluates the query and sets the result as new context set.

DELETE

DELETE [name]

Deletes documents from the currently opened database.

DROP

DROP [DATABASE|INDEX|USER] [...]

Drops a database, index or user:

  • DATABASE [name]:
drops the database
  • INDEX [PATH|TEXT|ATTRIBUTE|FULLTEXT]:
drops the specified index
  • USER [name]:
drops the specified user
  • BACKUP [name]:
drops the database backup

EXIT

EXIT

Exits BaseX.

EXPORT

EXPORT [path]

Exports the database to [path].

FIND

FIND [query]

The following modifiers can be used:

= : looks for exact text nodes"
@= : looks for exact attributes
@ : looks for attributes

GRANT

GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [db]) TO [user]

Grants permissions (on a database) to a user.

HELP

HELP ([command])

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

INFO

INFO ([DATABASE|INDEX|STORAGE])

Shows information on the currently opened database:

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

KILL

KILL [name]

Kills all sessions of the specified user.

LIST

LIST

Lists all available databases.

OPEN

OPEN [name]

Opens the specified database [name].

OPTIMIZE

OPTIMIZE

Optimizes the current database structures.

PASSWORD

PASSWORD ([password])

Changes the user's password.

RESTORE

RESTORE [name]

Restores a backup of the specified database.

RUN

RUN [path]

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

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

Have a look into Settings to find a complete list of available options.

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.

XQUERY

XQUERY [query]

Evaluates the specified query and prints the result.

Retrieved from "http://docs.basex.org/index.php?title=Commands&oldid=684"