Console Commands
OrientDB implements a number of SQL statements and commands that are available through the Console. In the event that you need information while working in the console, you can access it using either the HELP or ? command.
| Command | Description |
|---|---|
BACKUP DATABASE |
Backup a database |
BROWSE CLASS |
Browses all the records of a class |
BROWSE CLUSTER |
Browses all the records of a cluster |
CLASSES |
Displays all the configured classes |
CLUSTER STATUS |
Displays the status of distributed cluster of servers |
CLUSTERS |
Displays all the configured clusters |
CONFIG |
Displays the configuration where the opened database is located (local or remote) |
CONFIG GET |
Returns a configuration value |
CONFIG SET |
Set a configuration value |
CONNECT |
Connects to a database |
CREATE DATABASE |
Creates a new database |
DECLARE INTENT |
Declares an intent |
DICTIONARY KEYS |
Displays all the keys in the database dictionary |
DICTIONARY GET |
Loookups for a record using the dictionary. If found set it as the current record |
DICTIONARY PUT |
Inserts or modify an entry in the database dictionary. The entry is composed by key=String, value=record-id |
DICTIONARY REMOVE |
Removes the association in the dictionary |
DISCONNECT |
Disconnects from the current database |
DISPLAY RECORD |
Displays current record's attributes |
DISPLAY RAW RECORD |
Displays current record's raw format |
DROP DATABASE |
Drop a database |
EXPORT DATABASE |
Exports a database |
EXPORT RECORD |
Exports a record in any of the supported format (i.e. json) |
FREEZE DATABASE |
Freezes the database locking all the changes. Use this to raw backup. Once frozen it uses the RELEASE DATABASE to release it |
GET |
Returns the value of a property |
IMPORT DATABASE |
Imports a database previously exported |
INDEXES |
Displays information about indexes |
INFO |
Displays information about current status |
INFO CLASS |
Displays information about a class |
JS |
Executes a Javascript in the console |
JSS |
Executes a Javascript in the server |
LIST DATABASES |
List the available databases |
LIST CONNECTIONS |
List the available connections |
LOAD RECORD |
Loads a record in memory and set it as the current one |
LOAD SCRIPT |
Loads and executes a sql script |
PROFILER |
Controls the Profiler |
PROPERTIES |
Returns all the configured properties |
pwd |
Display current path |
RELEASE DATABASE |
Releases a Console Freeze Database database |
RELOAD RECORD |
Reloads a record in memory and set it as the current one |
RELOAD SCHEMA |
Reloads the schema |
RESTORE DATABASE |
Restore a database |
SET |
Changes the value of a property |
HELP |
Prints this help |
EXIT |
Closes the console |
| SQL Commands |