ODatabaseDocumentRemote (OrientDB 3.0.44 API)

java.lang.Object
- com.orientechnologies.common.listener.OListenerManger<ODatabaseListener>
- - com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract
  - - com.orientechnologies.orient.core.db.document.ODatabaseDocumentRemote

All Implemented Interfaces:

ODatabaseDocument, ODatabase<ORecord>, ODatabaseDocumentInternal, ODatabaseInternal<ORecord>, ODatabaseSession, OBackupable, Closeable, AutoCloseable

Direct Known Subclasses:

ODatabaseDocumentRemotePooled
```
public class ODatabaseDocumentRemote
extends ODatabaseDocumentAbstract
```
Created by tglman on 30/06/16.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.ODatabase
  ODatabase.ATTRIBUTES, ODatabase.OPERATION_MODE, ODatabase.STATUS

Field Summary

Fields
Modifier and Type Field and Description

protected OStorageRemoteSession sessionMetadata
- Fields inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract
  activeQueries, componentsFactory, currentIntent, currentTx, databaseOwner, hooks, hooksByScope, inHook, initialized, loadedRecordsCount, localCache, maxRecordLoadMs, maxRidbagPrefetchMs, metadata, microTransaction, minRecordLoadMs, minRidbagPrefetchMs, properties, recordType, retainRecords, ridbagPrefetchCount, serializer, sharedContext, status, totalRecordLoadMs, totalRidbagPrefetchMs, unmodifiableHooks, url, user
- Fields inherited from interface com.orientechnologies.orient.core.db.document.ODatabaseDocument
  TYPE

Fields
Modifier and Type	Field and Description
`protected OStorageRemoteSession`	`sessionMetadata`

Constructor Summary

Constructors
Constructor and Description

ODatabaseDocumentRemote(OStorageRemote storage)

Constructors
Constructor and Description
`ODatabaseDocumentRemote(OStorageRemote storage)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addBlobCluster(String iClusterName, Object... iParameters)` Adds a new cluster for store blobs.
`void`	`afterCreateOperations(OIdentifiable id)`
`void`	`afterDeleteOperations(OIdentifiable id)`
`void`	`afterReadOperations(OIdentifiable identifiable)`
`void`	`afterUpdateOperations(OIdentifiable id)`
`OIdentifiable`	`beforeCreateOperations(OIdentifiable id, String iClusterName)`
`void`	`beforeDeleteOperations(OIdentifiable id, String iClusterName)`
`boolean`	`beforeReadOperations(OIdentifiable identifiable)`
`OIdentifiable`	`beforeUpdateOperations(OIdentifiable id, String iClusterName)`
`ODatabaseDocumentAbstract`	`begin(OTransaction.TXTYPE iType)` Begins a new transaction specifying the transaction type.
`protected OMicroTransaction`	`beginMicroTransaction()`
`void`	`closeQuery(String queryId)`
`OResultSet`	`command(String query, Map args)` Executes a generic (idempotent or non idempotent) command.
`OResultSet`	`command(String query, Object... args)` Executes a generic (idempotent or non idempotent) command.
`ODatabaseDocumentInternal`	`copy()`
`<DB extends ODatabase> DB`	`create()` Creates a new database.
`<DB extends ODatabase> DB`	`create(Map<OGlobalConfiguration,Object> iInitialSettings)` Creates a new database passing initial settings.
`<DB extends ODatabase> DB`	`create(String incrementalBackupPath)` Creates new database from database backup.
`static void`	`deInit(OStorageRemote storage)`
`ODatabaseDocumentAbstract`	`delete(ORecord record)` Deletes an entity from the database in synchronous mode.
`void`	`drop()` Drops a database.
`OResultSet`	`execute(String language, String script, Map<String,?> args)` Execute a script of a specified query language The result set has to be closed after usage Sample usage:
`OResultSet`	`execute(String language, String script, Object... args)` Execute a script in a specified query language.
`void`	`executeDeleteRecord(OIdentifiable record, int iVersion, boolean iRequired, ODatabase.OPERATION_MODE iMode, boolean prohibitTombstones)`
`<RET extends ORecord> RET`	`executeSaveRecord(ORecord record, String clusterName, int ver, ODatabase.OPERATION_MODE mode, boolean forceCreate, ORecordCallback<? extends Number> recordCreatedCallback, ORecordCallback<Integer> recordUpdatedCallback)`
`boolean`	`exists()` Checks if the database exists.
`void`	`fetchNextPage(ORemoteResultSet rs)`
`OStorageRemoteSession`	`getSessionMetadata()`
`OStorageRemote`	`getStorage()` Returns the underlying storage implementation.
`OResultSet`	`indexQuery(String indexName, String query, Object... args)`
`void`	`internalOpen(String user, String password, OrientDBConfig config)`
`OLiveQueryMonitor`	`live(String query, OLiveQueryResultListener listener, Map<String,?> args)` Subscribe a query as a live query for future create/update event with the referred conditions
`OLiveQueryMonitor`	`live(String query, OLiveQueryResultListener listener, Object... args)` Subscribe a query as a live query for future create/update event with the referred conditions
`protected void`	`loadMetadata()`
`<DB extends ODatabase> DB`	`open(OToken iToken)` Deprecated.
`<DB extends ODatabase> DB`	`open(String iUserName, String iUserPassword)` Opens a database using the user and password received as arguments.
`OResultSet`	`query(String query, Map args)` Executes an SQL query (idempotent).
`OResultSet`	`query(String query, Object[] args)` Executes an SQL query.
`void`	`recycle(ORecord record)`
`void`	`replaceStorage(OStorage iNewStorage)` Internal only: replace the storage with a new one.
`<DB extends ODatabase> DB`	`set(ODatabase.ATTRIBUTES iAttribute, Object iValue)` Sets a database attribute value
`<DB extends ODatabase> DB`	`setCustom(String name, Object iValue)`
`void`	`setSessionMetadata(OStorageRemoteSession sessionMetadata)`
`static void`	`updateFunction(OStorageRemote storage)`
`static void`	`updateIndexManager(OStorageRemote storage, ODocument indexManager)`
`static void`	`updateSchema(OStorageRemote storage, ODocument schema)`
`static void`	`updateSequences(OStorageRemote storage)`
`protected byte[]`	`updateStream(ORecord record)`

Methods inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract
activateOnCurrentThread, addCluster, addCluster, addRidbagPrefetchStats, afterCommitOperations, afterRollbackOperations, assignAndCheckCluster, backup, beforeCommitOperations, beforeRollbackOperations, begin, begin, browseClass, browseClass, browseCluster, browseCluster, browseCluster, browseCluster, browseCluster, callbackHookFailure, callbackHookFinalize, callbackHooks, callbackHookSuccess, callOnCloseListeners, callOnDropListeners, callOnOpenListeners, checkForClusterPermissions, checkIfActive, checkOpenness, checkRecordClass, checkSecurity, checkSecurity, checkSecurity, checkSecurity, checkSecurity, checkSecurity, checkSecurity, cleanOutRecord, clearDocumentTracking, close, closeActiveQueries, command, commit, commit, countClass, countClass, countClusterElements, countClusterElements, countClusterElements, countClusterElements, countClusterElements, declareIntent, delete, delete, delete, delete, dropCluster, dropCluster, executeHideRecord, executeReadRecord, executeSaveEmptyRecord, executeWithRetries, executeWithRetries, executeWithRetries, existsCluster, freeze, freeze, get, getActiveIntent, getActiveQueries, getActiveQuery, getBlobClusterIds, getClusterIdByName, getClusterNameById, getClusterNames, getClusterRecordSizeById, getClusterRecordSizeByName, getClusters, getCollectionsChanges, getConfiguration, getConflictStrategy, getDatabaseOwner, getDefaultClusterId, getDefaultSerializer, getDictionary, getHooks, getListeners, getLocalCache, getMetadata, getMicroOrRegularTransaction, getName, getProperties, getProperty, getRecord, getRecordMetadata, getRecordType, getSbTreeCollectionManager, getSerializer, getSerializerFactory, getSharedContext, getSize, getStats, getStatus, getStorageVersions, getTransaction, getType, getUnderlying, getURL, getUser, hide, incrementalBackup, init, internalClose, internalCommit, isActiveOnCurrentThread, isClosed, isClusterEdge, isClusterVertex, isMVCC, isPooled, isPrefetchRecords, isRetainRecords, isUseLightweightEdges, isValidationEnabled, load, load, load, load, load, load, load, load, load, load, loadIfVersionIsNotLatest, newBlob, newBlob, newEdge, newEdge, newElement, newElement, newElement, newInstance, newInstance, newLightweightEdge, newRegularEdge, newVertex, newVertex, query, queryClosed, queryStarted, rawBegin, registerHook, registerHook, release, reload, reload, reload, reload, reload, reloadUser, resetInitialization, resetRecordLoadStats, restore, rollback, rollback, save, save, save, save, setConflictStrategy, setConflictStrategy, setCurrentDatabaseInThreadLocal, setDatabaseOwner, setDefaultClusterIdInternal, setDefaultSerializer, setDefaultTransactionMode, setInternal, setMVCC, setPrefetchRecords, setProperty, setRetainRecords, setSerializer, setStatus, setStatusInternal, setUseLightweightEdges, setUser, setValidationEnabled, swapTx, truncateCluster, unregisterHook

Methods inherited from class com.orientechnologies.common.listener.OListenerManger
browseListeners, getListenersCopy, registerListener, resetListeners, unregisterListener

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

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseDocumentInternal
getCommandInterruptionDepth, getHaStatus, isCommandInterrupted, isStorageCommitHappening, queryOnNode, realClose, removeHaServer, reuse, setCommandInterrupted, setCommandInterruptionDepth, setStorageCommitHappening

Methods inherited from interface com.orientechnologies.orient.core.db.document.ODatabaseDocument
createClassIfNotExist, createEdgeClass, createVertexClass, newEdge, newVertex

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabase
createClass, executeWithRetry, getClass, registerListener, unregisterListener

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseInternal
createInterruptTimerTask, getActiveClusterMap, getActiveDataCenterMap, getEnterpriseEndpoint, getLocalNodeName, interruptExecution, isSharded

- Field Detail
  - sessionMetadata
```
protected OStorageRemoteSession sessionMetadata
```
- Constructor Detail
  - ODatabaseDocumentRemote
```
public ODatabaseDocumentRemote(OStorageRemote storage)
```
- Method Detail
  - open
```
public <DB extends ODatabase> DB open(String iUserName,
                                      String iUserPassword)
```
    Description copied from interface: ODatabase
    
    Opens a database using the user and password received as arguments.
    
    Parameters:
    
    iUserName - Username to login
    
    iUserPassword - Password associated to the user
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - open
```
@Deprecated
public <DB extends ODatabase> DB open(OToken iToken)
```
    Deprecated.
    
    Description copied from interface: ODatabaseInternal
    
    Opens a database using an authentication token received as an argument.
    
    Parameters:
    
    iToken - Authentication token
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - create
```
public <DB extends ODatabase> DB create()
```
    Description copied from interface: ODatabase
    
    Creates a new database.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - create
```
public <DB extends ODatabase> DB create(String incrementalBackupPath)
```
    Description copied from interface: ODatabase
    
    Creates new database from database backup. Only incremental backups are supported.
    
    Type Parameters:
    
    DB - Concrete database instance type.
    
    Parameters:
    
    incrementalBackupPath - Path to incremental backup
    
    Returns:
    
    he Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - create
```
public <DB extends ODatabase> DB create(Map<OGlobalConfiguration,Object> iInitialSettings)
```
    Description copied from interface: ODatabase
    
    Creates a new database passing initial settings.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - drop
```
public void drop()
```
    Description copied from interface: ODatabase
    
    Drops a database.
  - set
```
public <DB extends ODatabase> DB set(ODatabase.ATTRIBUTES iAttribute,
                                     Object iValue)
```
    Description copied from interface: ODatabase
    
    Sets a database attribute value
    
    Parameters:
    
    iAttribute - Attributes between #ATTRIBUTES enum
    
    iValue - Value to set
    
    Returns:
    
    underlying
  - setCustom
```
public <DB extends ODatabase> DB setCustom(String name,
                                           Object iValue)
```
  - copy
```
public ODatabaseDocumentInternal copy()
```
  - exists
```
public boolean exists()
```
    Description copied from interface: ODatabase
    
    Checks if the database exists.
    
    Returns:
    
    True if already exists, otherwise false.
  - internalOpen
```
public void internalOpen(String user,
                         String password,
                         OrientDBConfig config)
```
  - loadMetadata
```
protected void loadMetadata()
```
    Specified by:
    
    loadMetadata in class ODatabaseDocumentAbstract
  - begin
```
public ODatabaseDocumentAbstract begin(OTransaction.TXTYPE iType)
```
    Description copied from interface: ODatabase
    
    Begins a new transaction specifying the transaction type. If a previous transaction is running a nested call counter is incremented. A transaction once begun has to be closed by calling the ODatabase.commit() or ODatabase.rollback().
    
    Specified by:
    
    begin in interface ODatabase<ORecord>
    
    Overrides:
    
    begin in class ODatabaseDocumentAbstract
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - getSessionMetadata
```
public OStorageRemoteSession getSessionMetadata()
```
  - setSessionMetadata
```
public void setSessionMetadata(OStorageRemoteSession sessionMetadata)
```
  - getStorage
```
public OStorageRemote getStorage()
```
    Description copied from interface: ODatabaseInternal
    
    Returns the underlying storage implementation.
    
    Returns:
    
    The underlying storage implementation
    
    See Also:
    
    OStorage
  - replaceStorage
```
public void replaceStorage(OStorage iNewStorage)
```
    Description copied from interface: ODatabaseInternal
    
    Internal only: replace the storage with a new one.
    
    Parameters:
    
    iNewStorage - The new storage to use. Usually it's a wrapped instance of the current cluster.
  - query
```
public OResultSet query(String query,
                        Object[] args)
```
    Description copied from interface: ODatabase
    
    Executes an SQL query. The result set has to be closed after usage
    
    Sample usage:
    OResultSet rs = db.query("SELECT FROM V where name = ?", "John"); while(rs.hasNext()){ OResult item = rs.next(); ... } rs.close();
    
    Parameters:
    
    query - the query string
    
    args - query parameters (positional)
    
    Returns:
    
    the query result set
  - query
```
public OResultSet query(String query,
                        Map args)
```
    Description copied from interface: ODatabase
    
    Executes an SQL query (idempotent). The result set has to be closed after usage
    
    Sample usage:
    Map<String, Object> params = new HashMapMap<>(); params.put("name", "John"); OResultSet rs = db.query("SELECT FROM V where name = :name", params); while(rs.hasNext()){ OResult item = rs.next(); ... } rs.close();
    
    Parameters:
    
    query - the query string
    
    args - query parameters (named)
    
    Returns:
  - indexQuery
```
public OResultSet indexQuery(String indexName,
                             String query,
                             Object... args)
```
  - command
```
public OResultSet command(String query,
                          Object... args)
```
    Description copied from interface: ODatabase
    
    Executes a generic (idempotent or non idempotent) command. The result set has to be closed after usage
    
    Sample usage:
    OResultSet rs = db.command("INSERT INTO Person SET name = ?", "John"); ... rs.close();
    
    args - query arguments
    
    Returns:
  - command
```
public OResultSet command(String query,
                          Map args)
```
    Description copied from interface: ODatabase
    
    Executes a generic (idempotent or non idempotent) command. The result set has to be closed after usage
    
    Sample usage:
    Map<String, Object> params = new HashMapMap<>(); params.put("name", "John"); OResultSet rs = db.query("INSERT INTO Person SET name = :name", params); ... rs.close();
    
    Returns:
  - execute
```
public OResultSet execute(String language,
                          String script,
                          Object... args)
                   throws OCommandExecutionException,
                          OCommandScriptException
```
    Description copied from interface: ODatabase
    
    Execute a script in a specified query language. The result set has to be closed after usage
    
    Sample usage:
    String script = "INSERT INTO Person SET name = 'foo', surname = ?;"+ "INSERT INTO Person SET name = 'bar', surname = ?;"+ "INSERT INTO Person SET name = 'baz', surname = ?;";
    OResultSet rs = db.execute("sql", script, "Surname1", "Surname2", "Surname3"); ... rs.close();
    
    Returns:
    
    Throws:
    
    OCommandExecutionException
    
    OCommandScriptException
  - execute
```
public OResultSet execute(String language,
                          String script,
                          Map<String,?> args)
                   throws OCommandExecutionException,
                          OCommandScriptException
```
    Description copied from interface: ODatabase
    
    Execute a script of a specified query language The result set has to be closed after usage
    
    Sample usage:
    Map<String, Object> params = new HashMapMap<>(); params.put("surname1", "Jones"); params.put("surname2", "May"); params.put("surname3", "Ali");
    String script = "INSERT INTO Person SET name = 'foo', surname = :surname1;"+ "INSERT INTO Person SET name = 'bar', surname = :surname2;"+ "INSERT INTO Person SET name = 'baz', surname = :surname3;";
    OResultSet rs = db.execute("sql", script, params); ... rs.close();
    
    Returns:
    
    Throws:
    
    OCommandExecutionException
    
    OCommandScriptException
  - closeQuery
```
public void closeQuery(String queryId)
```
  - fetchNextPage
```
public void fetchNextPage(ORemoteResultSet rs)
```
  - live
```
public OLiveQueryMonitor live(String query,
                              OLiveQueryResultListener listener,
                              Object... args)
```
    Description copied from interface: ODatabase
    
    Subscribe a query as a live query for future create/update event with the referred conditions
    
    Parameters:
    
    query - live query
    
    listener - the listener that receive the query results
    
    args - the live query args
  - live
```
public OLiveQueryMonitor live(String query,
                              OLiveQueryResultListener listener,
                              Map<String,?> args)
```
    Description copied from interface: ODatabase
    
    Subscribe a query as a live query for future create/update event with the referred conditions
    
    Parameters:
    
    query - live query
    
    listener - the listener that receive the query results
    
    args - the live query args
  - recycle
```
public void recycle(ORecord record)
```
  - beginMicroTransaction
```
protected OMicroTransaction beginMicroTransaction()
```
  - deInit
```
public static void deInit(OStorageRemote storage)
```
  - updateSchema
```
public static void updateSchema(OStorageRemote storage,
                                ODocument schema)
```
  - updateIndexManager
```
public static void updateIndexManager(OStorageRemote storage,
                                      ODocument indexManager)
```
  - updateFunction
```
public static void updateFunction(OStorageRemote storage)
```
  - updateSequences
```
public static void updateSequences(OStorageRemote storage)
```
  - addBlobCluster
```
public int addBlobCluster(String iClusterName,
                          Object... iParameters)
```
    Description copied from interface: ODatabase
    
    Adds a new cluster for store blobs.
    
    Parameters:
    
    iClusterName - Cluster name
    
    iParameters - Additional parameters to pass to the factories
    
    Returns:
    
    Cluster id
  - executeSaveRecord
```
public <RET extends ORecord> RET executeSaveRecord(ORecord record,
                                                   String clusterName,
                                                   int ver,
                                                   ODatabase.OPERATION_MODE mode,
                                                   boolean forceCreate,
                                                   ORecordCallback<? extends Number> recordCreatedCallback,
                                                   ORecordCallback<Integer> recordUpdatedCallback)
```
    Specified by:
    
    executeSaveRecord in interface ODatabaseDocumentInternal
    
    Specified by:
    
    executeSaveRecord in class ODatabaseDocumentAbstract
  - executeDeleteRecord
```
public void executeDeleteRecord(OIdentifiable record,
                                int iVersion,
                                boolean iRequired,
                                ODatabase.OPERATION_MODE iMode,
                                boolean prohibitTombstones)
```
    Specified by:
    
    executeDeleteRecord in interface ODatabaseDocumentInternal
    
    Specified by:
    
    executeDeleteRecord in class ODatabaseDocumentAbstract
  - updateStream
```
protected byte[] updateStream(ORecord record)
```
  - beforeCreateOperations
```
public OIdentifiable beforeCreateOperations(OIdentifiable id,
                                            String iClusterName)
```
    Returns:
    
    null if nothing changed the instance if has been modified or replaced
  - beforeUpdateOperations
```
public OIdentifiable beforeUpdateOperations(OIdentifiable id,
                                            String iClusterName)
```
    Returns:
    
    null if nothing changed the instance if has been modified or replaced
  - beforeDeleteOperations
```
public void beforeDeleteOperations(OIdentifiable id,
                                   String iClusterName)
```
  - afterUpdateOperations
```
public void afterUpdateOperations(OIdentifiable id)
```
  - afterCreateOperations
```
public void afterCreateOperations(OIdentifiable id)
```
  - afterDeleteOperations
```
public void afterDeleteOperations(OIdentifiable id)
```
  - beforeReadOperations
```
public boolean beforeReadOperations(OIdentifiable identifiable)
```
    Returns:
    
    true if the record should be skipped
  - afterReadOperations
```
public void afterReadOperations(OIdentifiable identifiable)
```
  - delete
```
public ODatabaseDocumentAbstract delete(ORecord record)
```
    Description copied from interface: ODatabase
    
    Deletes an entity from the database in synchronous mode.
    
    Parameters:
    
    record - The entity to delete.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.

Class ODatabaseDocumentRemote

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.ODatabase

Field Summary

Fields inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract

Fields inherited from interface com.orientechnologies.orient.core.db.document.ODatabaseDocument

Constructor Summary

Method Summary

Methods inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract

Methods inherited from class com.orientechnologies.common.listener.OListenerManger

Methods inherited from class java.lang.Object

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseDocumentInternal

Methods inherited from interface com.orientechnologies.orient.core.db.document.ODatabaseDocument

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabase

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseInternal

Field Detail

sessionMetadata

Constructor Detail

ODatabaseDocumentRemote

Method Detail

open

open

create

create

create

drop

set

setCustom

copy

exists

internalOpen

loadMetadata

begin

getSessionMetadata

setSessionMetadata

getStorage

replaceStorage

query

query

indexQuery

command

command

execute

execute

closeQuery

fetchNextPage

live

live

recycle

beginMicroTransaction

deInit

updateSchema

updateIndexManager

updateFunction

updateSequences

addBlobCluster

executeSaveRecord

executeDeleteRecord

updateStream

beforeCreateOperations

beforeUpdateOperations

beforeDeleteOperations

afterUpdateOperations

afterCreateOperations

afterDeleteOperations

beforeReadOperations

afterReadOperations

delete