OConsoleDatabaseApp (OrientDB 2.2.37 API)

java.lang.Object
- com.orientechnologies.common.console.OConsoleApplication
- - com.orientechnologies.orient.console.OrientConsole
  - - com.orientechnologies.orient.console.OConsoleDatabaseApp

All Implemented Interfaces:

OProgressListener, OTableFormatter.OTableOutput, OCommandOutputListener

Direct Known Subclasses:

OGremlinConsole
```
public class OConsoleDatabaseApp
extends OrientConsole
implements OCommandOutputListener, OProgressListener
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.orientechnologies.common.console.OConsoleApplication
  OConsoleApplication.RESULT

Field Summary

Fields
Modifier and Type	Field and Description
`protected ODatabaseDocumentTx`	`currentDatabase`
`protected String`	`currentDatabaseName`
`protected ORecord`	`currentRecord`
`protected int`	`currentRecordIdx`
`protected Object`	`currentResult`
`protected List<OIdentifiable>`	`currentResultSet`
`protected OServerAdmin`	`serverAdmin`

Fields inherited from class com.orientechnologies.common.console.OConsoleApplication
args, commandBuffer, COMMENT_PREFIXS, debugMode, err, exitCommands, helpCommands, in, interactiveMode, methods, ONLINE_HELP_EXT, ONLINE_HELP_URL, out, properties, reader, wordSeparator

Constructor Summary

Constructors
Constructor and Description

OConsoleDatabaseApp(String[] args)

Constructors
Constructor and Description
`OConsoleDatabaseApp(String[] args)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCluster(String clusterName, String clusterId)`
`void`	`alterClass(String iCommandText)`
`void`	`alterCluster(String iCommandText)`
`void`	`alterDatabase(String iCommandText)`
`void`	`alterProperty(String iCommandText)`
`void`	`alterSequence(String iCommandText)`
`String`	`ask(String iText)`
`void`	`backupDatabase(String iText)`
`void`	`begin()`
`void`	`browseClass(String iClassName)`
`void`	`browseCluster(String iClusterName)`
`protected void`	`checkCurrentObject()` Should be used only by console commands
`void`	`checkDatabase(String iOptions)`
`protected void`	`checkForDatabase()` Should be used only by console commands
`protected void`	`checkForRemoteServer()` Should be used only by console commands
`void`	`close()` Closes the console freeing all the used resources.
`void`	`clusterStatus()`
`void`	`commit()`
`void`	`compareDatabases(String iDb1URL, String iDb2URL, String iUserName, String iUserPassword, String autoDiscoveringMappingData)`
`void`	`config()`
`void`	`configGet(String iConfigName)`
`void`	`configSet(String iConfigName, String iConfigValue)`
`void`	`connect(String iURL, String iUserName, String iUserPassword)`
`void`	`copyDatabase(String iDatabaseName, String iDatabaseUserName, String iDatabaseUserPassword, String iRemoteName, String iRemoteEngine)`
`void`	`createClass(String iCommandText)`
`void`	`createCluster(String iCommandText)`
`void`	`createDatabase(String databaseURL, String userName, String userPassword, String storageType, String databaseType, String options)`
`void`	`createEdge(String iCommandText)`
`void`	`createFunction(String iCommandText)` Creates a function.
`void`	`createIndex(String iCommandText)`
`void`	`createLink(String iCommandText)`
`void`	`createProperty(String iCommandText)`
`void`	`createSequence(String iCommandText)`
`void`	`createUser(String iCommandText)`
`void`	`createVertex(String iCommandText)`
`void`	`current()`
`void`	`declareIntent(String iIntentName)`
`void`	`delete(String iCommandText)`
`void`	`dictionaryGet(String iKey)`
`void`	`dictionaryPut(String iKey, String iRecordId)`
`void`	`dictionaryRemove(String iKey)`
`void`	`disconnect()`
`void`	`displayRawRecord(String iRecordId)`
`void`	`displayRecord(String iRecordNumber)`
`void`	`dropClass(String iCommandText)`
`void`	`dropCluster(String iClusterName)`
`void`	`dropDatabase(String storageType)`
`void`	`dropDatabase(String iDatabaseURL, String iUserName, String iUserPassword, String storageType)`
`void`	`dropIndex(String iCommandText)`
`void`	`dropProperty(String iCommandText)`
`void`	`dropSequence(String iCommandText)`
`void`	`dropServerUser(String iServerUserName)`
`void`	`dropUser(String iCommandText)`
`protected void`	`dumpDistributedConfiguration(boolean iForce)`
`protected void`	`dumpResultSet(int limit)`
`void`	`eval(String iText)`
`protected static int`	`exec(String[] cmd)` Execute the specified command and return the output (both stdout and stderr).
`protected void`	`executeServerSideScript(String iLanguage, String iText)`
`void`	`explain(String iCommandText)`
`void`	`exportDatabase(String iText)`
`void`	`exportRecord(String iFormat, String iOptions)`
`void`	`exportSchema(String iOutputFilePath)`
`void`	`findReferences(String iCommandText)`
`void`	`flushDatabase(String storageType)`
`void`	`freezeDatabase(String storageType)`
`void`	`gc()`
`void`	`get(String iPropertyName)`
`protected String`	`getContext()`
`ODatabaseDocument`	`getCurrentDatabase()` Should be used only by console commands
`String`	`getCurrentDatabaseName()` Should be used only by console commands
`String`	`getCurrentDatabaseUserName()` Should be used only by console commands
`String`	`getCurrentDatabaseUserPassword()` Should be used only by console commands
`ORecord`	`getCurrentRecord()` Should be used only by console commands
`List<OIdentifiable>`	`getCurrentResultSet()` Should be used only by console commands
`protected ODocument`	`getDistributedConfiguration()`
`protected float`	`getElapsedSecs(long start)`
`int`	`getMaxMultiValueEntries()`
`protected String`	`getPrompt()`
`void`	`grant(String iCommandText)`
`void`	`ha(String iCommandText)`
`void`	`importDatabase(String text)`
`void`	`info()`
`void`	`infoClass(String iClassName)`
`void`	`infoProperty(String iPropertyName)`
`void`	`insert(String iCommandText)`
`protected boolean`	`isCollectingCommands(String iLine)`
`void`	`js(String iText)`
`void`	`jss(String iText)`
`void`	`listClasses()`
`void`	`listClusters(String options)`
`void`	`listConnections()`
`void`	`listDatabases()`
`void`	`listIndexes()`
`void`	`listProperties()`
`void`	`listServers()`
`void`	`listServerUsers()`
`void`	`loadRecord(String iRecordId)`
`void`	`loadRecord(String iRecordId, String iFetchPlan)`
`void`	`loadRecordInternal(String iRecordId, String iFetchPlan)` Should be used only by console commands
`void`	`loadScript(String scriptPath)`
`static void`	`main(String[] args)`
`void`	`match(String iQueryText)`
`void`	`move(String iText)`
`void`	`moveVertex(String iCommandText)`
`void`	`next()`
`protected void`	`onBefore()`
`void`	`onBegin(Object iTask, long iTotal, Object metadata)`
`void`	`onCompletition(Object iTask, boolean iSucceed)`
`void`	`onMessage(String iText)`
`boolean`	`onProgress(Object iTask, long iCounter, float iPercent)`
`void`	`optimizeDatabase(String iCommandText)`
`protected Map<String,String>`	`parseCommandOptions(String options)`
`protected Map<String,List<String>>`	`parseOptions(String iOptions)`
`protected void`	`parseResult()`
`void`	`prev()`
`protected void`	`printApplicationInfo()`
`protected void`	`printError(Exception e)`
`void`	`profiler(String iCommandName)`
`void`	`profileStorageOff()`
`void`	`profileStorageOn()`
`void`	`properties()`
`void`	`pwd()`
`void`	`rebuildIndex(String iCommandText)`
`void`	`releaseDatabase(String storageType)`
`void`	`reloadRecord(String iRecordId)`
`void`	`reloadRecord(String iRecordId, String iFetchPlan)`
`void`	`reloadRecordInternal(String iRecordId, String iFetchPlan)` Should be used only by console commands
`void`	`reloadSchema()`
`void`	`repairDatabase(String iOptions)`
`protected void`	`resetResultSet()`
`void`	`restoreDatabase(String text)`
`protected static void`	`restoreTerminal()`
`void`	`revoke(String iCommandText)`
`void`	`rollback()`
`void`	`script(String iText)`
`void`	`select(String iQueryText)`
`void`	`set(String iPropertyName, String iPropertyValue)`
`OConsoleDatabaseApp`	`setCurrentDatabase(ODatabaseDocumentTx iCurrentDatabase)` Pass an existent database instance to be used as current.
`protected OIdentifiable`	`setCurrentRecord(int iIndex)`
`protected void`	`setResultset(List<OIdentifiable> iResultset)`
`void`	`setServerUser(String iServerUserName, String iServerUserPasswd, String iPermissions)`
`protected static boolean`	`setTerminalToCBreak()`
`void`	`sleep(String iTime)`
`protected static int`	`stty(String args)` Execute the stty command with the specified arguments against the current active terminal.
`void`	`transactional(String iCommandText)`
`void`	`traverse(String iQueryText)`
`void`	`truncateClass(String iCommandText)`
`void`	`truncateCluster(String iCommandText)`
`void`	`truncateRecord(String iCommandText)`
`void`	`update(String iCommandText)`
`protected void`	`updateDatabaseInfo()`

Methods inherited from class com.orientechnologies.orient.console.OrientConsole
format, onAfter, onException, onMessage

Methods inherited from class com.orientechnologies.common.console.OConsoleApplication
addCommand, error, execute, executeBatch, executeCommands, formatCommandSpecs, getClearName, getCommandLine, getConsoleMethods, getConsoleWidth, getCorrectMethodName, getMethod, getOnlineHelp, getVerboseLevel, help, isComment, isEchoEnabled, isInteractiveMode, isPropertyEnabled, message, run, setOutput, setReader, syntaxError

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentDatabase

protected ODatabaseDocumentTx currentDatabase

currentDatabaseName
```
protected String currentDatabaseName
```

currentRecord
```
protected ORecord currentRecord
```

currentRecordIdx
```
protected int currentRecordIdx
```

currentResultSet

protected List<OIdentifiable> currentResultSet

currentResult
```
protected Object currentResult
```

serverAdmin
```
protected OServerAdmin serverAdmin
```

Constructor Detail

OConsoleDatabaseApp

public OConsoleDatabaseApp(String[] args)

Method Detail

main

public static void main(String[] args)

restoreTerminal

protected static void restoreTerminal()

setTerminalToCBreak

protected static boolean setTerminalToCBreak()
                                      throws IOException,
                                             InterruptedException

Throws:: IOException; InterruptedException

stty

protected static int stty(String args)
                   throws IOException,
                          InterruptedException

Execute the stty command with the specified arguments against the current active terminal.

Throws:: IOException; InterruptedException

exec

protected static int exec(String[] cmd)
                   throws IOException,
                          InterruptedException

Execute the specified command and return the output (both stdout and stderr).

Throws:: IOException; InterruptedException

connect

public void connect(String iURL,
                    String iUserName,
                    String iUserPassword)
             throws IOException

Throws:: IOException

disconnect
```
public void disconnect()
```

createDatabase

public void createDatabase(String databaseURL,
                           String userName,
                           String userPassword,
                           String storageType,
                           String databaseType,
                           String options)
                    throws IOException

Throws:: IOException

parseCommandOptions

protected Map<String,String> parseCommandOptions(String options)

listDatabases

public void listDatabases()
                   throws IOException

Throws:: IOException

listConnections

public void listConnections()
                     throws IOException

Throws:: IOException

reloadSchema

public void reloadSchema()
                  throws IOException

Throws:: IOException

createCluster

public void createCluster(String iCommandText)

dropCluster

public void dropCluster(String iClusterName)

addCluster

public void addCluster(String clusterName,
                       String clusterId)

alterCluster

public void alterCluster(String iCommandText)

begin

public void begin()
           throws IOException

Throws:: IOException

commit

public void commit()
            throws IOException

Throws:: IOException

rollback

public void rollback()
              throws IOException

Throws:: IOException

truncateClass

public void truncateClass(String iCommandText)

truncateCluster

public void truncateCluster(String iCommandText)

truncateRecord

public void truncateRecord(String iCommandText)

loadRecord

public void loadRecord(String iRecordId,
                       String iFetchPlan)

loadRecord

public void loadRecord(String iRecordId)

reloadRecord

public void reloadRecord(String iRecordId,
                         String iFetchPlan)

reloadRecord

public void reloadRecord(String iRecordId)

explain

public void explain(String iCommandText)

transactional

public void transactional(String iCommandText)

insert

public void insert(String iCommandText)

createVertex

public void createVertex(String iCommandText)

createEdge

public void createEdge(String iCommandText)

profileStorageOn
```
public void profileStorageOn()
```

profileStorageOff
```
public void profileStorageOff()
```

update

public void update(String iCommandText)

ha
```
public void ha(String iCommandText)
```

moveVertex

public void moveVertex(String iCommandText)

optimizeDatabase

public void optimizeDatabase(String iCommandText)

gc
```
public void gc()
```

delete

public void delete(String iCommandText)

grant

public void grant(String iCommandText)

revoke

public void revoke(String iCommandText)

createLink

public void createLink(String iCommandText)

findReferences

public void findReferences(String iCommandText)

alterDatabase

public void alterDatabase(String iCommandText)

freezeDatabase

public void freezeDatabase(String storageType)
                    throws IOException

Throws:: IOException

releaseDatabase

public void releaseDatabase(String storageType)
                     throws IOException

Throws:: IOException

flushDatabase

public void flushDatabase(String storageType)
                   throws IOException

Throws:: IOException

current
```
public void current()
```

next
```
public void next()
```

prev
```
public void prev()
```

alterClass

public void alterClass(String iCommandText)

createClass

public void createClass(String iCommandText)

createSequence

public void createSequence(String iCommandText)

alterSequence

public void alterSequence(String iCommandText)

dropSequence

public void dropSequence(String iCommandText)

createUser

public void createUser(String iCommandText)

dropUser

public void dropUser(String iCommandText)

alterProperty

public void alterProperty(String iCommandText)

createProperty

public void createProperty(String iCommandText)

createFunction
```
public void createFunction(String iCommandText)
```
Creates a function.

Parameters:

iCommandText - the command text to execute

traverse

public void traverse(String iQueryText)

select

public void select(String iQueryText)

match
```
public void match(String iQueryText)
```

move
```
public void move(String iText)
```

eval
```
public void eval(String iText)
```

script
```
public void script(String iText)
```

js
```
public void js(String iText)
```

jss
```
public void jss(String iText)
```

setServerUser

public void setServerUser(String iServerUserName,
                          String iServerUserPasswd,
                          String iPermissions)

dropServerUser

public void dropServerUser(String iServerUserName)

listServerUsers
```
public void listServerUsers()
```

createIndex

public void createIndex(String iCommandText)
                 throws IOException

Throws:: IOException

dropDatabase

public void dropDatabase(String storageType)
                  throws IOException

Throws:: IOException

dropDatabase

public void dropDatabase(String iDatabaseURL,
                         String iUserName,
                         String iUserPassword,
                         String storageType)
                  throws IOException

Throws:: IOException

dropIndex

public void dropIndex(String iCommandText)
               throws IOException

Throws:: IOException

rebuildIndex

public void rebuildIndex(String iCommandText)
                  throws IOException

Throws:: IOException

dropClass

public void dropClass(String iCommandText)
               throws IOException

Throws:: IOException

dropProperty

public void dropProperty(String iCommandText)
                  throws IOException

Throws:: IOException

browseClass

public void browseClass(String iClassName)

browseCluster

public void browseCluster(String iClusterName)

displayRecord

public void displayRecord(String iRecordNumber)

displayRawRecord

public void displayRawRecord(String iRecordId)
                      throws IOException

Throws:: IOException

info
```
public void info()
```

listProperties
```
public void listProperties()
```

infoClass

public void infoClass(String iClassName)

infoProperty

public void infoProperty(String iPropertyName)

listIndexes
```
public void listIndexes()
```

listClusters

public void listClusters(String options)

listClasses
```
public void listClasses()
```

listServers
```
public void listServers()
```

dictionaryGet

public void dictionaryGet(String iKey)

dictionaryPut

public void dictionaryPut(String iKey,
                          String iRecordId)

dictionaryRemove

public void dictionaryRemove(String iKey)

copyDatabase

public void copyDatabase(String iDatabaseName,
                         String iDatabaseUserName,
                         String iDatabaseUserPassword,
                         String iRemoteName,
                         String iRemoteEngine)
                  throws IOException

Throws:: IOException

clusterStatus

public void clusterStatus()
                   throws IOException

Throws:: IOException

checkDatabase

public void checkDatabase(String iOptions)
                   throws IOException

Throws:: IOException

repairDatabase

public void repairDatabase(String iOptions)
                    throws IOException

Throws:: IOException

compareDatabases

public void compareDatabases(String iDb1URL,
                             String iDb2URL,
                             String iUserName,
                             String iUserPassword,
                             String autoDiscoveringMappingData)
                      throws IOException

Throws:: IOException

loadScript

public void loadScript(String scriptPath)
                throws IOException

Throws:: IOException

importDatabase

public void importDatabase(String text)
                    throws IOException

Throws:: IOException

backupDatabase

public void backupDatabase(String iText)
                    throws IOException

Throws:: IOException

restoreDatabase

public void restoreDatabase(String text)
                     throws IOException

Throws:: IOException

exportDatabase

public void exportDatabase(String iText)
                    throws IOException

Throws:: IOException

exportSchema

public void exportSchema(String iOutputFilePath)
                  throws IOException

Throws:: IOException

exportRecord

public void exportRecord(String iFormat,
                         String iOptions)
                  throws IOException

Throws:: IOException

properties
```
public void properties()
```

get

public void get(String iPropertyName)

set

public void set(String iPropertyName,
                String iPropertyValue)

declareIntent

public void declareIntent(String iIntentName)

profiler

public void profiler(String iCommandName)

configGet

public void configGet(String iConfigName)
               throws IOException

Throws:: IOException

sleep
```
public void sleep(String iTime)
```

configSet

public void configSet(String iConfigName,
                      String iConfigValue)
               throws IOException

Throws:: IOException

config

public void config()
            throws IOException

Throws:: IOException

getCurrentDatabase
```
public ODatabaseDocument getCurrentDatabase()
```
Should be used only by console commands

setCurrentDatabase

public OConsoleDatabaseApp setCurrentDatabase(ODatabaseDocumentTx iCurrentDatabase)

Pass an existent database instance to be used as current.

getCurrentDatabaseName
```
public String getCurrentDatabaseName()
```
Should be used only by console commands

getCurrentDatabaseUserName
```
public String getCurrentDatabaseUserName()
```
Should be used only by console commands

getCurrentDatabaseUserPassword
```
public String getCurrentDatabaseUserPassword()
```
Should be used only by console commands

getCurrentRecord
```
public ORecord getCurrentRecord()
```
Should be used only by console commands

getCurrentResultSet
```
public List<OIdentifiable> getCurrentResultSet()
```
Should be used only by console commands

loadRecordInternal

public void loadRecordInternal(String iRecordId,
                               String iFetchPlan)

Should be used only by console commands

reloadRecordInternal

public void reloadRecordInternal(String iRecordId,
                                 String iFetchPlan)

Should be used only by console commands

checkForRemoteServer
```
protected void checkForRemoteServer()
```
Should be used only by console commands

checkForDatabase
```
protected void checkForDatabase()
```
Should be used only by console commands

checkCurrentObject
```
protected void checkCurrentObject()
```
Should be used only by console commands

ask
```
public String ask(String iText)
```

onMessage
```
public void onMessage(String iText)
```
Specified by:

onMessage in interface OCommandOutputListener

onBegin

public void onBegin(Object iTask,
                    long iTotal,
                    Object metadata)

Specified by:: onBegin in interface OProgressListener

onProgress

public boolean onProgress(Object iTask,
                          long iCounter,
                          float iPercent)

Specified by:: onProgress in interface OProgressListener

pwd
```
public void pwd()
```

onCompletition

public void onCompletition(Object iTask,
                           boolean iSucceed)

Specified by:: onCompletition in interface OProgressListener

close
```
public void close()
```
Closes the console freeing all the used resources.

dumpDistributedConfiguration

protected void dumpDistributedConfiguration(boolean iForce)

getDistributedConfiguration

protected ODocument getDistributedConfiguration()

isCollectingCommands
```
protected boolean isCollectingCommands(String iLine)
```
Overrides:

isCollectingCommands in class OConsoleApplication

onBefore
```
protected void onBefore()
```
Overrides:

onBefore in class OrientConsole

setCurrentRecord

protected OIdentifiable setCurrentRecord(int iIndex)

printApplicationInfo
```
protected void printApplicationInfo()
```
Overrides:

printApplicationInfo in class OrientConsole

dumpResultSet

protected void dumpResultSet(int limit)

getElapsedSecs

protected float getElapsedSecs(long start)

printError

protected void printError(Exception e)

updateDatabaseInfo
```
protected void updateDatabaseInfo()
```

getContext
```
protected String getContext()
```
Overrides:

getContext in class OConsoleApplication

getPrompt
```
protected String getPrompt()
```
Overrides:

getPrompt in class OConsoleApplication

parseResult
```
protected void parseResult()
```

setResultset

protected void setResultset(List<OIdentifiable> iResultset)

resetResultSet
```
protected void resetResultSet()
```

executeServerSideScript

protected void executeServerSideScript(String iLanguage,
                                       String iText)

parseOptions

protected Map<String,List<String>> parseOptions(String iOptions)

getMaxMultiValueEntries
```
public int getMaxMultiValueEntries()
```

Class OConsoleDatabaseApp

Nested Class Summary

Nested classes/interfaces inherited from class com.orientechnologies.common.console.OConsoleApplication

Field Summary

Fields inherited from class com.orientechnologies.common.console.OConsoleApplication

Constructor Summary

Method Summary

Methods inherited from class com.orientechnologies.orient.console.OrientConsole

Methods inherited from class com.orientechnologies.common.console.OConsoleApplication

Methods inherited from class java.lang.Object

Field Detail

currentDatabase

currentDatabaseName

currentRecord

currentRecordIdx

currentResultSet

currentResult

serverAdmin

Constructor Detail

OConsoleDatabaseApp

Method Detail

main

restoreTerminal

setTerminalToCBreak

stty

exec

connect

disconnect

createDatabase

parseCommandOptions

listDatabases

listConnections

reloadSchema

createCluster

dropCluster

addCluster

alterCluster

begin

commit

rollback

truncateClass

truncateCluster

truncateRecord

loadRecord

loadRecord

reloadRecord

reloadRecord

explain

transactional

insert

createVertex

createEdge

profileStorageOn

profileStorageOff

update

ha

moveVertex

optimizeDatabase

gc

delete

grant

revoke

createLink

findReferences

alterDatabase

freezeDatabase

releaseDatabase

flushDatabase

current

next

prev

alterClass

createClass

createSequence

alterSequence

dropSequence

createUser

dropUser

alterProperty

createProperty