ODatabaseDocumentTx (OrientDB 2.2.37 API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ODatabaseDocumentTxPooled
```
public class ODatabaseDocumentTx
extends OListenerManger<ODatabaseListener>
implements ODatabaseDocumentInternal
```
Document API entrypoint.

Author:

Luca Garulli

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ODatabaseDocumentTx.LatestVersionRecordReader`
`static interface`	`ODatabaseDocumentTx.RecordReader`
`static class`	`ODatabaseDocumentTx.SimpleRecordReader`

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static ORecordSerializer`	`defaultSerializer`
`protected ORecordSerializer`	`serializer`
`protected ODatabaseSessionMetadata`	`sessionMetadata`

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

Constructor Summary

Constructors
Constructor and Description
`ODatabaseDocumentTx(String iURL)` Creates a new connection to the database.
`ODatabaseDocumentTx(String iURL, boolean keepStorageOpen)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ODatabaseDocumentTx`	`activateOnCurrentThread()` Activates current database instance on current thread.
`int`	`addBlobCluster(String iClusterName, Object... iParameters)` Add a cluster for blob records.
`int`	`addCluster(String iClusterName, int iRequestedId, Object... iParameters)` Adds a new cluster.
`int`	`addCluster(String iClusterName, Object... iParameters)` Adds a new cluster.
`Object`	`alterCluster(int iClusterId, OCluster.ATTRIBUTES attribute, Object value)` Alters a cluster.
`Object`	`alterCluster(String iClusterName, OCluster.ATTRIBUTES attribute, Object value)` Alters a cluster.
`int`	`assignAndCheckCluster(ORecord record, String iClusterName)`
`List<String>`	`backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener, int compressionLevel, int bufferSize)` Executes a backup of the database.
`ODatabaseDocumentTx`	`begin()` Begins a new transaction.
`ODatabaseDocumentTx`	`begin(OTransaction.TXTYPE iType)` Begins a new transaction specifying the transaction type.
`ODatabaseDocument`	`begin(OTransaction iTx)` Attaches a transaction as current.
`ORecordIteratorClass<ODocument>`	`browseClass(String iClassName)` Browses all the records of the specified class and also all the subclasses.
`ORecordIteratorClass<ODocument>`	`browseClass(String iClassName, boolean iPolymorphic)` Browses all the records of the specified class and if iPolymorphic is true also all the subclasses.
`ORecordIteratorCluster<ODocument>`	`browseCluster(String iClusterName)` Browses all the records of the specified cluster.
`<REC extends ORecord> ORecordIteratorCluster<REC>`	`browseCluster(String iClusterName, Class<REC> iClass)` Browses all the records of the specified cluster of the passed record type.
`<REC extends ORecord> ORecordIteratorCluster<REC>`	`browseCluster(String iClusterName, Class<REC> iRecordClass, long startClusterPosition, long endClusterPosition)`
`<REC extends ORecord> ORecordIteratorCluster<REC>`	`browseCluster(String iClusterName, Class<REC> iRecordClass, long startClusterPosition, long endClusterPosition, boolean loadTombstones)` Deprecated.
`ORecordIteratorCluster<ODocument>`	`browseCluster(String iClusterName, long startClusterPosition, long endClusterPosition, boolean loadTombstones)` Deprecated.
`ORecordHook.RESULT`	`callbackHooks(ORecordHook.TYPE type, OIdentifiable id)` Callback the registered hooks if any.
`<V> V`	`callInLock(Callable<V> iCallable, boolean iExclusiveLock)`
`void`	`callOnCloseListeners()`
`void`	`callOnDropListeners()`
`void`	`callOnOpenListeners()`
`void`	`checkIfActive()`
`protected void`	`checkOpeness()`
`<DB extends ODatabaseDocument> DB`	`checkSecurity(ORule.ResourceGeneric iResourceGeneric, int iOperation, Object... iResourcesSpecific)` Checks if the operation against multiple resources is allowed for the current user.
`<DB extends ODatabaseDocument> DB`	`checkSecurity(ORule.ResourceGeneric iResourceGeneric, int iOperation, Object iResourceSpecific)` Checks if the operation on a resource is allowed for the current user.
`<DB extends ODatabaseDocument> DB`	`checkSecurity(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iOperation)` Checks if the operation on a resource is allowed for the current user.
`<DB extends ODatabaseDocument> DB`	`checkSecurity(String iResource, int iOperation)` Deprecated.
`<DB extends ODatabaseDocument> DB`	`checkSecurity(String iResourceGeneric, int iOperation, Object... iResourcesSpecific)` Deprecated.
`<DB extends ODatabaseDocument> DB`	`checkSecurity(String iResourceGeneric, int iOperation, Object iResourceSpecific)` Deprecated.
`ODatabase<ORecord>`	`cleanOutRecord(ORID iRecord, int iVersion)`
`void`	`close()` Closes an opened database.
`OCommandRequest`	`command(OCommandRequest iCommand)` Execute a command against the database.
`ODatabase<ORecord>`	`commit()` Commits the current transaction.
`ODatabaseDocument`	`commit(boolean force)`
`ODatabaseDocumentTx`	`copy()` Returns a copy of current database if it's open.
`long`	`countClass(String iClassName)` Returns the number of the records of the class iClassName.
`long`	`countClass(String iClassName, boolean iPolymorphic)` Returns the number of the records of the class iClassName considering also sub classes if polymorphic is true.
`long`	`countClusterElements(int iClusterId)` Counts all the entities in the specified cluster id.
`long`	`countClusterElements(int[] iClusterIds)` Counts all the entities in the specified cluster ids.
`long`	`countClusterElements(int[] iClusterIds, boolean countTombstones)`
`long`	`countClusterElements(int iClusterId, boolean countTombstones)`
`long`	`countClusterElements(String iClusterName)` Counts all the entities in the specified cluster name.
`<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.
`boolean`	`declareIntent(OIntent iIntent)` Declares an intent to the database.
`ODatabaseDocumentTx`	`delete(ORecord record)` Deletes a document.
`ODatabaseDocument`	`delete(ORecord iRecord, ODatabase.OPERATION_MODE iMode)`
`ODatabaseDocument`	`delete(ORID iRecord)` Deletes the record without checking the version.
`ODatabase<ORecord>`	`delete(ORID iRecord, int iVersion)` Deletes the record checking the version.
`ODatabaseDocument`	`delete(ORID iRecord, ODatabase.OPERATION_MODE iMode)` Deletes the record without checking the version.
`void`	`drop()` Drops a database.
`boolean`	`dropCluster(int iClusterId, boolean iTruncate)` Drops a cluster by its id.
`boolean`	`dropCluster(String iClusterName, boolean iTruncate)` Drops a cluster by its name.
`void`	`executeDeleteRecord(OIdentifiable record, int iVersion, boolean iRequired, ODatabase.OPERATION_MODE iMode, boolean prohibitTombstones)` This method is internal, it can be subject to signature change or be removed, do not use.
`boolean`	`executeHideRecord(OIdentifiable record, ODatabase.OPERATION_MODE iMode)` This method is internal, it can be subject to signature change or be removed, do not use.
`<RET extends ORecord> RET`	`executeReadRecord(ORecordId rid, ORecord iRecord, int recordVersion, String fetchPlan, boolean ignoreCache, boolean iUpdateCache, boolean loadTombstones, OStorage.LOCKING_STRATEGY lockingStrategy, ODatabaseDocumentTx.RecordReader recordReader)` This method is internal, it can be subject to signature change or be removed, do not use.
`Set<ORecord>`	`executeReadRecords(Set<ORecordId> iRids, boolean ignoreCache)` This method is internal, it can be subject to signature change or be removed, do not use.
`void`	`executeRecycleRecord(ORecord record)` This method is internal, it can be subject to signature change or be removed, do not use.
`<RET extends ORecord> RET`	`executeSaveEmptyRecord(ORecord record, String clusterName)`
`<RET extends ORecord> RET`	`executeSaveRecord(ORecord record, String clusterName, int ver, ODatabase.OPERATION_MODE mode, boolean forceCreate, ORecordCallback<? extends Number> recordCreatedCallback, ORecordCallback<Integer> recordUpdatedCallback)` This method is internal, it can be subject to signature change or be removed, do not use.
`static Object`	`executeWithRetries(OCallable<Object,Integer> callback, int maxRetry)`
`static Object`	`executeWithRetries(OCallable<Object,Integer> callback, int maxRetry, int waitBetweenRetry)`
`static Object`	`executeWithRetries(OCallable<Object,Integer> callback, int maxRetry, int waitBetweenRetry, ORecord[] recordToReloadOnRetry)`
`boolean`	`exists()` Checks if the database exists.
`boolean`	`existsCluster(String iClusterName)` Returns true if the cluster exists, otherwise false.
`void`	`freeze()` Flush all indexes and cached storage content to the disk.
`void`	`freeze(boolean throwException)` Flush all indexes and cached storage content to the disk.
`Object`	`get(ODatabase.ATTRIBUTES iAttribute)` Returns a database attribute value
`OIntent`	`getActiveIntent()` Return the active intent.
`Set<Integer>`	`getBlobClusterIds()` Retrieve the set of defined blob cluster.
`int`	`getClusterIdByName(String iClusterName)` Returns the cluster id by name.
`String`	`getClusterNameById(int iClusterId)` Returns the cluster name by id.
`Collection<String>`	`getClusterNames()` Returns all the names of the clusters.
`long`	`getClusterRecordSizeById(int clusterId)` Returns the total size of records contained in the cluster defined by its id.
`long`	`getClusterRecordSizeByName(String clusterName)` Returns the total size of records contained in the cluster defined by its name.
`int`	`getClusters()` Returns the number of clusters.
`OContextConfiguration`	`getConfiguration()` Returns the database configuration settings.
`ORecordConflictStrategy`	`getConflictStrategy()` Returns the current record conflict strategy.
`ODatabaseInternal<?>`	`getDatabaseOwner()` Returns the database owner.
`int`	`getDefaultClusterId()` Returns the default cluster id.
`static ORecordSerializer`	`getDefaultSerializer()`
`ODictionary<ORecord>`	`getDictionary()` Returns the Dictionary manual index.
`Map<ORecordHook,ORecordHook.HOOK_POSITION>`	`getHooks()` Retrieves all the registered hooks.
`Iterable<ODatabaseListener>`	`getListeners()` Retrieves all the registered listeners.
`OLocalRecordCache`	`getLocalCache()` Returns the level1 cache.
`OMetadataDefault`	`getMetadata()` Return the OMetadata instance.
`String`	`getName()` Returns the database name.
`Iterator<Map.Entry<String,Object>>`	`getProperties()` Returns an iterator of the property entries
`Object`	`getProperty(String iName)` Gets the property value.
`<RET extends ORecord> RET`	`getRecord(OIdentifiable iIdentifiable)` Returns the record for a OIdentifiable instance.
`ORecordMetadata`	`getRecordMetadata(ORID rid)`
`byte`	`getRecordType()` Returns the default record type for this kind of database.
`OSBTreeCollectionManager`	`getSbTreeCollectionManager()` Internal.
`ORecordSerializer`	`getSerializer()`
`OBinarySerializerFactory`	`getSerializerFactory()`
`long`	`getSize()` Returns the total size of database as the real used space.
`ODatabase.STATUS`	`getStatus()` Returns the current status of database.
`OStorage`	`getStorage()` This method is internal, it can be subject to signature change or be removed, do not use.
`OCurrentStorageComponentsFactory`	`getStorageVersions()` Internal.
`OTransaction`	`getTransaction()` Return active transaction.
`String`	`getType()`
`<DB extends ODatabase> DB`	`getUnderlying()` This method is internal, it can be subject to signature change or be removed, do not use.
`String`	`getURL()` Returns the database URL.
`OSecurityUser`	`getUser()` Returns the current user logged into the database.
`boolean`	`hide(ORID rid)` Hides records content by putting tombstone on the records position but does not delete record itself.
`String`	`incrementalBackup(String path)` Performs incremental backup of database content to the selected folder.
`boolean`	`isActiveOnCurrentThread()` Returns true if the current database instance is active on current thread, otherwise false.
`boolean`	`isClosed()` Checks if the database is closed.
`boolean`	`isFrozen()` Returns true if the database is frozen (`ODatabase.freeze()` operation), otherwise false.
`boolean`	`isMVCC()` Returns if the Multi Version Concurrency Control is enabled or not.
`boolean`	`isPooled()`
`boolean`	`isPrefetchRecords()`
`boolean`	`isRetainRecords()` Returns true if current configuration retains objects, otherwise false
`boolean`	`isValidationEnabled()` Tells if validation of record is active.
`<RET extends ORecord> RET`	`load(ORecord iRecord)` Loads the entity and return it.
`<RET extends ORecord> RET`	`load(ORecord iRecord, String iFetchPlan)` Loads a record using a fetch plan.
`<RET extends ORecord> RET`	`load(ORecord iRecord, String iFetchPlan, boolean iIgnoreCache)` Loads a record using a fetch plan.
`<RET extends ORecord> RET`	`load(ORecord iRecord, String iFetchPlan, boolean iIgnoreCache, boolean iUpdateCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy)` Deprecated.
`<RET extends ORecord> RET`	`load(ORecord iRecord, String iFetchPlan, boolean iIgnoreCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy)` Deprecated.
`<RET extends ORecord> RET`	`load(ORID recordId)` Loads the entity by the Record ID.
`<RET extends ORecord> RET`	`load(ORID iRecordId, String iFetchPlan)` Loads the entity by the Record ID using a fetch plan.
`<RET extends ORecord> RET`	`load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache)` Loads the entity by the Record ID using a fetch plan and specifying if the cache must be ignored.
`<RET extends ORecord> RET`	`load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache, boolean iUpdateCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy)` Deprecated.
`<RET extends ORecord> RET`	`load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache, boolean loadTombstone, OStorage.LOCKING_STRATEGY iLockingStrategy)` Deprecated.
`<RET extends ORecord> RET`	`loadIfVersionIsNotLatest(ORID rid, int recordVersion, String fetchPlan, boolean ignoreCache)`
`ODocument`	`newInstance()` Creates a new ODocument.
`ODocument`	`newInstance(String iClassName)` Creates a document with specific class.
`<DB extends ODatabase> DB`	`open(OToken iToken)` Opens a database using an authentication token received as an argument.
`<DB extends ODatabase> DB`	`open(String iUserName, String iUserPassword)` Opens connection to the storage with given user and password.
`<RET extends List<?>> RET`	`query(OQuery<?> iCommand, Object... iArgs)` Execute a query against the database.
`void`	`recycle(ORecord record)`
`<DB extends ODatabase<?>> DB`	`registerHook(ORecordHook iHookImpl)` Registers a hook to listen all events for Records.
`<DB extends ODatabase<?>> DB`	`registerHook(ORecordHook iHookImpl, ORecordHook.HOOK_POSITION iPosition)`
`void`	`release()` Allows to execute write-related commands on DB.
`void`	`reload()` Reloads the database information like the cluster list.
`<RET extends ORecord> RET`	`reload(ORecord iRecord)`
`<RET extends ORecord> RET`	`reload(ORecord iRecord, String iFetchPlan)`
`<RET extends ORecord> RET`	`reload(ORecord iRecord, String iFetchPlan, boolean iIgnoreCache)` Force the reloading of the entity.
`<RET extends ORecord> RET`	`reload(ORecord record, String fetchPlan, boolean ignoreCache, boolean force)` Force the reloading of the entity.
`void`	`reloadUser()`
`void`	`replaceStorage(OStorage iNewStorage)` This method is internal, it can be subject to signature change or be removed, do not use.
`void`	`resetInitialization()`
`void`	`restore(InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener)` Executes a restore of a database backup.
`ODatabase<ORecord>`	`rollback()` Aborts the current running transaction.
`ODatabaseDocument`	`rollback(boolean force)`
`<RET extends ORecord> RET`	`save(ORecord iRecord)` Saves a document to the database.
`<RET extends ORecord> RET`	`save(ORecord iRecord, ODatabase.OPERATION_MODE iMode, boolean iForceCreate, ORecordCallback<? extends Number> iRecordCreatedCallback, ORecordCallback<Integer> iRecordUpdatedCallback)` Saves a document to the database.
`<RET extends ORecord> RET`	`save(ORecord iRecord, String iClusterName)` Saves a document specifying a cluster where to store the record.
`<RET extends ORecord> RET`	`save(ORecord iRecord, String iClusterName, ODatabase.OPERATION_MODE iMode, boolean iForceCreate, ORecordCallback<? extends Number> iRecordCreatedCallback, ORecordCallback<Integer> iRecordUpdatedCallback)` Saves a document specifying a cluster where to store the record.
`<DB extends ODatabase> DB`	`set(ODatabase.ATTRIBUTES iAttribute, Object iValue)` Sets a database attribute value
`ODatabaseDocumentTx`	`setConflictStrategy(ORecordConflictStrategy iResolver)` Overrides record conflict strategy.
`ODatabaseDocumentTx`	`setConflictStrategy(String iStrategyName)` Overrides record conflict strategy selecting the strategy by name.
`void`	`setCurrentDatabaseInThreadLocal()` Deprecated.
`ODatabaseInternal<ORecord>`	`setDatabaseOwner(ODatabaseInternal<?> iOwner)` Internal.
`void`	`setDefaultClusterIdInternal(int iDefClusterId)` Deprecated.
`static void`	`setDefaultSerializer(ORecordSerializer iDefaultSerializer)` Sets default serializer.
`void`	`setDefaultTransactionMode()`
`void`	`setInternal(ODatabase.ATTRIBUTES iAttribute, Object iValue)` Internal method.
`<DB extends ODatabase<?>> DB`	`setMVCC(boolean mvcc)` Enables or disables the Multi-Version Concurrency Control.
`void`	`setPrefetchRecords(boolean prefetchRecords)`
`Object`	`setProperty(String iName, Object iValue)` Sets a property value
`ODatabaseDocument`	`setRetainRecords(boolean retainRecords)` Specifies if retain handled objects in memory or not.
`void`	`setSerializer(ORecordSerializer serializer)` Sets serializer for the database which will be used for document serialization.
`<DB extends ODatabase> DB`	`setStatus(ODatabase.STATUS status)` Returns the current status of database.
`void`	`setStatusInternal(ODatabase.STATUS status)`
`void`	`setUser(OSecurityUser user)` Set user for current database instance.
`<DB extends ODatabaseDocument> DB`	`setValidationEnabled(boolean iEnabled)` Enables or disables the record validation.
`void`	`truncateCluster(String clusterName)` Removes all data in the cluster with given name.
`<DB extends ODatabase<?>> DB`	`unregisterHook(ORecordHook iHookImpl)` Unregisters a previously registered hook.

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.ODatabase
registerListener, unregisterListener

- Field Detail
  - defaultSerializer
```
protected static ORecordSerializer defaultSerializer
```
  - serializer
```
protected ORecordSerializer serializer
```
  - sessionMetadata
```
protected ODatabaseSessionMetadata sessionMetadata
```
- Constructor Detail
  - ODatabaseDocumentTx
```
public ODatabaseDocumentTx(String iURL)
```
    Creates a new connection to the database.
    
    Parameters:
    
    iURL - of the database
  - ODatabaseDocumentTx
```
public ODatabaseDocumentTx(String iURL,
                           boolean keepStorageOpen)
```
- Method Detail
  - getDefaultSerializer
```
public static ORecordSerializer getDefaultSerializer()
```
    Returns:
    
    default serializer which is used to serialize documents. Default serializer is common for all database instances.
  - setDefaultSerializer
```
public static void setDefaultSerializer(ORecordSerializer iDefaultSerializer)
```
    Sets default serializer. The default serializer is common for all database instances.
    
    Parameters:
    
    iDefaultSerializer - new default serializer value
  - open
```
public <DB extends ODatabase> DB open(String iUserName,
                                      String iUserPassword)
```
    Opens connection to the storage with given user and password.
    But we do suggest OPartitionedDatabasePool.acquire() instead. It will make work faster even with embedded database.
    
    Specified by:
    
    open in interface ODatabase<ORecord>
    
    Parameters:
    
    iUserName - Username to login
    
    iUserPassword - Password associated to the user
    
    Returns:
    
    Current database instance.
  - isPrefetchRecords
```
public boolean isPrefetchRecords()
```
    Specified by:
    
    isPrefetchRecords in interface ODatabaseDocumentInternal
  - setPrefetchRecords
```
public void setPrefetchRecords(boolean prefetchRecords)
```
    Specified by:
    
    setPrefetchRecords in interface ODatabaseDocumentInternal
  - open
```
public <DB extends ODatabase> DB open(OToken iToken)
```
    Opens a database using an authentication token received as an argument.
    
    Specified by:
    
    open in interface ODatabaseInternal<ORecord>
    
    Parameters:
    
    iToken - Authentication token
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - callOnOpenListeners
```
public void callOnOpenListeners()
```
  - create
```
public <DB extends ODatabase> DB create()
```
    Creates a new database.
    
    Specified by:
    
    create in interface ODatabase<ORecord>
    
    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)
```
    Creates new database from database backup. Only incremental backups are supported.
    
    Specified by:
    
    create in interface ODatabase<ORecord>
    
    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.
    
    Specified by:
    
    create in interface ODatabase<ORecord>
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - drop
```
public void drop()
```
    Drops a database.
    
    Specified by:
    
    drop in interface ODatabase<ORecord>
  - copy
```
public ODatabaseDocumentTx copy()
```
    Returns a copy of current database if it's open. The returned instance can be used by another thread without affecting current instance. The database copy is not set in thread local.
    
    Specified by:
    
    copy in interface ODatabaseDocumentInternal
  - callOnCloseListeners
```
public void callOnCloseListeners()
```
  - callOnDropListeners
```
public void callOnDropListeners()
```
  - getRecord
```
public <RET extends ORecord> RET getRecord(OIdentifiable iIdentifiable)
```
    Returns the record for a OIdentifiable instance. If the argument received already is a ORecord instance, then it's returned as is, otherwise a new ORecord is created with the identity received and returned.
    
    Specified by:
    
    getRecord in interface ODatabaseDocument
    
    Returns:
    
    A ORecord instance
  - reload
```
public void reload()
```
    Description copied from interface: ODatabase
    
    Reloads the database information like the cluster list.
    
    Specified by:
    
    reload in interface ODatabase<ORecord>
  - load
```
public <RET extends ORecord> RET load(ORID iRecordId,
                                      String iFetchPlan,
                                      boolean iIgnoreCache)
```
    Loads the entity by the Record ID using a fetch plan and specifying if the cache must be ignored.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecordId - The unique record id of the entity to load.
    
    iFetchPlan - Fetch plan used
    
    iIgnoreCache - Ignore cache or use it
    
    Returns:
    
    The loaded entity
  - delete
```
public ODatabase<ORecord> delete(ORID iRecord,
                                 int iVersion)
```
    Deletes the record checking the version.
    
    Specified by:
    
    delete in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - The RecordID to delete.
    
    iVersion - for MVCC
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - cleanOutRecord
```
public ODatabase<ORecord> cleanOutRecord(ORID iRecord,
                                         int iVersion)
```
    Specified by:
    
    cleanOutRecord in interface ODatabase<ORecord>
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface ODatabase<ORecord>
  - delete
```
public ODatabaseDocument delete(ORID iRecord,
                                ODatabase.OPERATION_MODE iMode)
```
    Deletes the record without checking the version.
  - delete
```
public ODatabaseDocument delete(ORecord iRecord,
                                ODatabase.OPERATION_MODE iMode)
```
  - browseCluster
```
public <REC extends ORecord> ORecordIteratorCluster<REC> browseCluster(String iClusterName,
                                                                       Class<REC> iClass)
```
    Description copied from interface: ODatabaseDocument
    
    Browses all the records of the specified cluster of the passed record type.
    
    Specified by:
    
    browseCluster in interface ODatabaseDocument
    
    Parameters:
    
    iClusterName - Cluster name to iterate
    
    iClass - The record class expected
    
    Returns:
    
    Iterator of ODocument instances
  - browseCluster
```
@Deprecated
public <REC extends ORecord> ORecordIteratorCluster<REC> browseCluster(String iClusterName,
                                                                                   Class<REC> iRecordClass,
                                                                                   long startClusterPosition,
                                                                                   long endClusterPosition,
                                                                                   boolean loadTombstones)
```
    Deprecated.
    
    Specified by:
    
    browseCluster in interface ODatabaseDocument
  - browseCluster
```
public <REC extends ORecord> ORecordIteratorCluster<REC> browseCluster(String iClusterName,
                                                                       Class<REC> iRecordClass,
                                                                       long startClusterPosition,
                                                                       long endClusterPosition)
```
    Specified by:
    
    browseCluster in interface ODatabaseDocument
  - command
```
public OCommandRequest command(OCommandRequest iCommand)
```
    Execute a command against the database. A command can be a SQL statement or a Procedure. If the OStorage used is remote (OStorageRemote) then the command will be executed remotely and the result returned back to the calling client.
    
    Specified by:
    
    command in interface ODatabase<ORecord>
    
    Parameters:
    
    iCommand - Command request to execute.
    
    Returns:
    
    The same Command request received as parameter.
  - query
```
public <RET extends List<?>> RET query(OQuery<?> iCommand,
                                       Object... iArgs)
```
    Execute a query against the database. If the OStorage used is remote (OStorageRemote) then the command will be executed remotely and the result returned back to the calling client.
    
    Specified by:
    
    query in interface ODatabase<ORecord>
    
    Parameters:
    
    iCommand - Query command
    
    iArgs - Optional parameters to bind to the query
    
    Returns:
    
    List of POJOs
  - getRecordType
```
public byte getRecordType()
```
    Returns the default record type for this kind of database.
    
    Specified by:
    
    getRecordType in interface ODatabaseDocument
  - countClusterElements
```
public long countClusterElements(int[] iClusterIds)
```
    Counts all the entities in the specified cluster ids.
    
    Specified by:
    
    countClusterElements in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterIds - Array of cluster ids Cluster id
    
    Returns:
    
    Total number of entities contained in the specified clusters
  - countClusterElements
```
public long countClusterElements(int iClusterId)
```
    Counts all the entities in the specified cluster id.
    
    Specified by:
    
    countClusterElements in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterId - Cluster id
    
    Returns:
    
    Total number of entities contained in the specified cluster
  - truncateCluster
```
public void truncateCluster(String clusterName)
```
    Removes all data in the cluster with given name. As result indexes for this class will be rebuilt.
    
    Specified by:
    
    truncateCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    clusterName - Name of cluster to be truncated.
  - countClusterElements
```
public long countClusterElements(int iClusterId,
                                 boolean countTombstones)
```
    Specified by:
    
    countClusterElements in interface ODatabase<ORecord>
  - countClusterElements
```
public long countClusterElements(int[] iClusterIds,
                                 boolean countTombstones)
```
    Specified by:
    
    countClusterElements in interface ODatabase<ORecord>
  - countClusterElements
```
public long countClusterElements(String iClusterName)
```
    Counts all the entities in the specified cluster name.
    
    Specified by:
    
    countClusterElements in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - Cluster name
    
    Returns:
    
    Total number of entities contained in the specified cluster
  - getMetadata
```
public OMetadataDefault getMetadata()
```
    Return the OMetadata instance. Cannot be null.
    
    Specified by:
    
    getMetadata in interface ODatabase<ORecord>
    
    Specified by:
    
    getMetadata in interface ODatabaseDocumentInternal
    
    Returns:
    
    The OMetadata instance.
  - checkSecurity
```
public <DB extends ODatabaseDocument> DB checkSecurity(ORule.ResourceGeneric resourceGeneric,
                                                       String resourceSpecific,
                                                       int iOperation)
```
    Checks if the operation on a resource is allowed for the current user.
    
    Specified by:
    
    checkSecurity in interface ODatabaseDocument
    
    Parameters:
    
    resourceGeneric - Generic Resource where to execute the operation
    
    iOperation - Operation to execute against the resource
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - checkSecurity
```
public <DB extends ODatabaseDocument> DB checkSecurity(ORule.ResourceGeneric iResourceGeneric,
                                                       int iOperation,
                                                       Object... iResourcesSpecific)
```
    Checks if the operation against multiple resources is allowed for the current user. The check is made in two steps:
    1. Access to all the resource as *
    2. Access to the specific target resources
    Specified by:
    
    checkSecurity in interface ODatabaseDocument
    
    Parameters:
    
    iResourceGeneric - Resource where to execute the operation, i.e.: database.clusters
    
    iOperation - Operation to execute against the resource
    
    iResourcesSpecific - Target resources as an array of Objects, i.e.: ["employee", 2] to specify cluster name and id.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - checkSecurity
```
public <DB extends ODatabaseDocument> DB checkSecurity(ORule.ResourceGeneric iResourceGeneric,
                                                       int iOperation,
                                                       Object iResourceSpecific)
```
    Checks if the operation on a resource is allowed for the current user. The check is made in two steps:
    1. Access to all the resource as *
    2. Access to the specific target resource
    Specified by:
    
    checkSecurity in interface ODatabaseDocument
    
    Parameters:
    
    iResourceGeneric - Resource where to execute the operation, i.e.: database.clusters
    
    iOperation - Operation to execute against the resource
    
    iResourceSpecific - Target resource, i.e.: "employee" to specify the cluster name.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - getDatabaseOwner
```
public ODatabaseInternal<?> getDatabaseOwner()
```
    Returns the database owner. Used in wrapped instances to know the up level ODatabase instance.
    
    Specified by:
    
    getDatabaseOwner in interface ODatabaseInternal<ORecord>
    
    Returns:
    
    Returns the database owner.
  - setDatabaseOwner
```
public ODatabaseInternal<ORecord> setDatabaseOwner(ODatabaseInternal<?> iOwner)
```
    Internal. Sets the database owner.
    
    Specified by:
    
    setDatabaseOwner in interface ODatabaseInternal<ORecord>
  - isRetainRecords
```
public boolean isRetainRecords()
```
    Returns true if current configuration retains objects, otherwise false
    
    Specified by:
    
    isRetainRecords in interface ODatabaseDocument
    
    See Also:
    
    ODatabaseDocument.setRetainRecords(boolean)
  - setRetainRecords
```
public ODatabaseDocument setRetainRecords(boolean retainRecords)
```
    Specifies if retain handled objects in memory or not. Setting it to false can improve performance on large inserts. Default is enabled.
    
    Specified by:
    
    setRetainRecords in interface ODatabaseDocument
    
    Parameters:
    
    retainRecords - True to enable, false to disable it.
    
    See Also:
    
    ODatabaseDocument.isRetainRecords()
  - setStatus
```
public <DB extends ODatabase> DB setStatus(ODatabase.STATUS status)
```
    Returns the current status of database. deprecated since 2.2
    
    Specified by:
    
    setStatus in interface ODatabase<ORecord>
  - setStatusInternal
```
public void setStatusInternal(ODatabase.STATUS status)
```
  - setDefaultClusterIdInternal
```
@Deprecated
public void setDefaultClusterIdInternal(int iDefClusterId)
```
    Deprecated.
    
    Deprecated since v2.2
  - setInternal
```
public void setInternal(ODatabase.ATTRIBUTES iAttribute,
                        Object iValue)
```
    Internal method. Don't call it directly unless you're building an internal component.
    
    Specified by:
    
    setInternal in interface ODatabaseInternal<ORecord>
  - getUser
```
public OSecurityUser getUser()
```
    Returns the current user logged into the database.
    
    Specified by:
    
    getUser in interface ODatabase<ORecord>
    
    See Also:
    
    OSecurity
  - setUser
```
public void setUser(OSecurityUser user)
```
    Set user for current database instance.
    
    Specified by:
    
    setUser in interface ODatabaseInternal<ORecord>
  - reloadUser
```
public void reloadUser()
```
    Specified by:
    
    reloadUser in interface ODatabaseDocumentInternal
  - isMVCC
```
public boolean isMVCC()
```
    Returns if the Multi Version Concurrency Control is enabled or not. If enabled the version of the record is checked before each update and delete against the records.
    
    Specified by:
    
    isMVCC in interface ODatabase<ORecord>
    
    Returns:
    
    true if enabled, otherwise false
    
    See Also:
    
    deprecated since 2.2
  - setMVCC
```
public <DB extends ODatabase<?>> DB setMVCC(boolean mvcc)
```
    Enables or disables the Multi-Version Concurrency Control. If enabled the version of the record is checked before each update and delete against the records.
    
    Specified by:
    
    setMVCC in interface ODatabase<ORecord>
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain. deprecated since 2.2
    
    See Also:
    
    ODatabase.isMVCC()
  - getDictionary
```
public ODictionary<ORecord> getDictionary()
```
    Returns the Dictionary manual index.
    
    Specified by:
    
    getDictionary in interface ODatabase<ORecord>
    
    Returns:
    
    ODictionary instance
  - registerHook
```
public <DB extends ODatabase<?>> DB registerHook(ORecordHook iHookImpl,
                                                 ORecordHook.HOOK_POSITION iPosition)
```
    Specified by:
    
    registerHook in interface ODatabase<ORecord>
  - registerHook
```
public <DB extends ODatabase<?>> DB registerHook(ORecordHook iHookImpl)
```
    Registers a hook to listen all events for Records.
    
    Specified by:
    
    registerHook in interface ODatabase<ORecord>
    
    Parameters:
    
    iHookImpl - ORecordHook implementation
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - unregisterHook
```
public <DB extends ODatabase<?>> DB unregisterHook(ORecordHook iHookImpl)
```
    Unregisters a previously registered hook.
    
    Specified by:
    
    unregisterHook in interface ODatabase<ORecord>
    
    Parameters:
    
    iHookImpl - ORecordHook implementation
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain. deprecated since 2.2
  - getLocalCache
```
public OLocalRecordCache getLocalCache()
```
    Returns the level1 cache. Cannot be null.
    
    Specified by:
    
    getLocalCache in interface ODatabase<ORecord>
    
    Returns:
    
    Current cache.
  - getHooks
```
public Map<ORecordHook,ORecordHook.HOOK_POSITION> getHooks()
```
    Retrieves all the registered hooks.
    
    Specified by:
    
    getHooks in interface ODatabase<ORecord>
    
    Returns:
    
    A not-null unmodifiable map of ORecordHook and position instances. If there are no hooks registered, the Map is empty.
  - callbackHooks
```
public ORecordHook.RESULT callbackHooks(ORecordHook.TYPE type,
                                        OIdentifiable id)
```
    Callback the registered hooks if any.
    
    Specified by:
    
    callbackHooks in interface ODatabaseDocumentInternal
    
    Parameters:
    
    type - Hook type. Define when hook is called.
    
    id - Record received in the callback
    
    Returns:
    
    True if the input record is changed, otherwise false
  - isValidationEnabled
```
public boolean isValidationEnabled()
```
    Tells if validation of record is active. Default is true.
    
    Specified by:
    
    isValidationEnabled in interface ODatabaseDocument
    
    Returns:
    
    true if it's active, otherwise false.
  - setValidationEnabled
```
public <DB extends ODatabaseDocument> DB setValidationEnabled(boolean iEnabled)
```
    Enables or disables the record validation. Since 2.2 this setting is persistent.
    
    Specified by:
    
    setValidationEnabled in interface ODatabaseDocument
    
    Parameters:
    
    iEnabled - True to enable, false to disable
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - getConflictStrategy
```
public ORecordConflictStrategy getConflictStrategy()
```
    Description copied from interface: ODatabase
    
    Returns the current record conflict strategy.
    
    Specified by:
    
    getConflictStrategy in interface ODatabase<ORecord>
  - setConflictStrategy
```
public ODatabaseDocumentTx setConflictStrategy(String iStrategyName)
```
    Description copied from interface: ODatabase
    
    Overrides record conflict strategy selecting the strategy by name.
    
    Specified by:
    
    setConflictStrategy in interface ODatabase<ORecord>
    
    Parameters:
    
    iStrategyName - ORecordConflictStrategy strategy name
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - setConflictStrategy
```
public ODatabaseDocumentTx setConflictStrategy(ORecordConflictStrategy iResolver)
```
    Description copied from interface: ODatabase
    
    Overrides record conflict strategy.
    
    Specified by:
    
    setConflictStrategy in interface ODatabase<ORecord>
    
    Parameters:
    
    iResolver - ORecordConflictStrategy implementation
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - getConfiguration
```
public OContextConfiguration getConfiguration()
```
    Description copied from interface: ODatabase
    
    Returns the database configuration settings. If defined, any database configuration overwrites the global one.
    
    Specified by:
    
    getConfiguration in interface ODatabase<ORecord>
    
    Returns:
    
    OContextConfiguration
  - declareIntent
```
public boolean declareIntent(OIntent iIntent)
```
    Description copied from interface: ODatabase
    
    Declares an intent to the database. Intents aim to optimize common use cases.
    
    Specified by:
    
    declareIntent in interface ODatabase<ORecord>
    
    Parameters:
    
    iIntent - The intent
  - exists
```
public boolean exists()
```
    Description copied from interface: ODatabase
    
    Checks if the database exists.
    
    Specified by:
    
    exists in interface ODatabase<ORecord>
    
    Returns:
    
    True if already exists, otherwise false.
  - close
```
public void close()
```
    Description copied from interface: ODatabase
    
    Closes an opened database.
    
    Specified by:
    
    close in interface ODatabase<ORecord>
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - getStatus
```
public ODatabase.STATUS getStatus()
```
    Description copied from interface: ODatabase
    
    Returns the current status of database.
    
    Specified by:
    
    getStatus in interface ODatabase<ORecord>
  - getSize
```
public long getSize()
```
    Description copied from interface: ODatabase
    
    Returns the total size of database as the real used space.
    
    Specified by:
    
    getSize in interface ODatabase<ORecord>
  - getName
```
public String getName()
```
    Description copied from interface: ODatabase
    
    Returns the database name.
    
    Specified by:
    
    getName in interface ODatabase<ORecord>
    
    Returns:
    
    Name of the database
  - getURL
```
public String getURL()
```
    Description copied from interface: ODatabase
    
    Returns the database URL.
    
    Specified by:
    
    getURL in interface ODatabase<ORecord>
    
    Returns:
    
    URL of the database
  - getDefaultClusterId
```
public int getDefaultClusterId()
```
    Description copied from interface: ODatabase
    
    Returns the default cluster id. If not specified all the new entities will be stored in the default cluster.
    
    Specified by:
    
    getDefaultClusterId in interface ODatabase<ORecord>
    
    Returns:
    
    The default cluster id
  - getClusters
```
public int getClusters()
```
    Description copied from interface: ODatabase
    
    Returns the number of clusters.
    
    Specified by:
    
    getClusters in interface ODatabase<ORecord>
    
    Returns:
    
    Number of the clusters
  - existsCluster
```
public boolean existsCluster(String iClusterName)
```
    Description copied from interface: ODatabase
    
    Returns true if the cluster exists, otherwise false.
    
    Specified by:
    
    existsCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - Cluster name
    
    Returns:
    
    true if the cluster exists, otherwise false
  - getClusterNames
```
public Collection<String> getClusterNames()
```
    Description copied from interface: ODatabase
    
    Returns all the names of the clusters.
    
    Specified by:
    
    getClusterNames in interface ODatabase<ORecord>
    
    Returns:
    
    Collection of cluster names.
  - getClusterIdByName
```
public int getClusterIdByName(String iClusterName)
```
    Description copied from interface: ODatabase
    
    Returns the cluster id by name.
    
    Specified by:
    
    getClusterIdByName in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - Cluster name
    
    Returns:
    
    The id of searched cluster.
  - getClusterNameById
```
public String getClusterNameById(int iClusterId)
```
    Description copied from interface: ODatabase
    
    Returns the cluster name by id.
    
    Specified by:
    
    getClusterNameById in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterId - Cluster id
    
    Returns:
    
    The name of searched cluster.
  - getClusterRecordSizeByName
```
public long getClusterRecordSizeByName(String clusterName)
```
    Description copied from interface: ODatabase
    
    Returns the total size of records contained in the cluster defined by its name.
    
    Specified by:
    
    getClusterRecordSizeByName in interface ODatabase<ORecord>
    
    Parameters:
    
    clusterName - Cluster name
    
    Returns:
    
    Total size of records contained.
  - getClusterRecordSizeById
```
public long getClusterRecordSizeById(int clusterId)
```
    Description copied from interface: ODatabase
    
    Returns the total size of records contained in the cluster defined by its id.
    
    Specified by:
    
    getClusterRecordSizeById in interface ODatabase<ORecord>
    
    Parameters:
    
    clusterId - Cluster id
    
    Returns:
    
    The name of searched cluster.
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: ODatabase
    
    Checks if the database is closed.
    
    Specified by:
    
    isClosed in interface ODatabase<ORecord>
    
    Returns:
    
    true if is closed, otherwise false.
  - addCluster
```
public int addCluster(String iClusterName,
                      Object... iParameters)
```
    Description copied from interface: ODatabase
    
    Adds a new cluster.
    
    Specified by:
    
    addCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - Cluster name
    
    iParameters - Additional parameters to pass to the factories
    
    Returns:
    
    Cluster id
  - addCluster
```
public int addCluster(String iClusterName,
                      int iRequestedId,
                      Object... iParameters)
```
    Description copied from interface: ODatabase
    
    Adds a new cluster.
    
    Specified by:
    
    addCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - Cluster name
    
    iRequestedId - requested id of the cluster
    
    iParameters - Additional parameters to pass to the factories
    
    Returns:
    
    Cluster id
  - alterCluster
```
public Object alterCluster(String iClusterName,
                           OCluster.ATTRIBUTES attribute,
                           Object value)
```
    Description copied from interface: ODatabase
    
    Alters a cluster.
    
    Specified by:
    
    alterCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - The name of the cluster to alter
    
    attribute - The cluster attribute to be modified
    
    Returns:
    
    Dependent on attribute type
  - alterCluster
```
public Object alterCluster(int iClusterId,
                           OCluster.ATTRIBUTES attribute,
                           Object value)
```
    Description copied from interface: ODatabase
    
    Alters a cluster.
    
    Specified by:
    
    alterCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterId - The id of the cluster to alter
    
    attribute - The cluster attribute to be modified
    
    Returns:
    
    Dependent on attribute type
  - dropCluster
```
public boolean dropCluster(String iClusterName,
                           boolean iTruncate)
```
    Description copied from interface: ODatabase
    
    Drops a cluster by its name. Physical clusters will be completely deleted
    
    Specified by:
    
    dropCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - the name of the cluster
    
    Returns:
    
    true if has been removed, otherwise false
  - dropCluster
```
public boolean dropCluster(int iClusterId,
                           boolean iTruncate)
```
    Description copied from interface: ODatabase
    
    Drops a cluster by its id. Physical clusters will be completely deleted.
    
    Specified by:
    
    dropCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterId - id of cluster to delete
    
    Returns:
    
    true if has been removed, otherwise false
  - setProperty
```
public Object setProperty(String iName,
                          Object iValue)
```
    Description copied from interface: ODatabase
    
    Sets a property value
    
    Specified by:
    
    setProperty in interface ODatabase<ORecord>
    
    Parameters:
    
    iName - Property name
    
    iValue - new value to set
    
    Returns:
    
    The previous value if any, otherwise null
  - getProperty
```
public Object getProperty(String iName)
```
    Description copied from interface: ODatabase
    
    Gets the property value.
    
    Specified by:
    
    getProperty in interface ODatabase<ORecord>
    
    Parameters:
    
    iName - Property name
    
    Returns:
    
    The previous value if any, otherwise null
  - getProperties
```
public Iterator<Map.Entry<String,Object>> getProperties()
```
    Description copied from interface: ODatabase
    
    Returns an iterator of the property entries
    
    Specified by:
    
    getProperties in interface ODatabase<ORecord>
  - get
```
public Object get(ODatabase.ATTRIBUTES iAttribute)
```
    Description copied from interface: ODatabase
    
    Returns a database attribute value
    
    Specified by:
    
    get in interface ODatabase<ORecord>
    
    Parameters:
    
    iAttribute - Attributes between #ATTRIBUTES enum
    
    Returns:
    
    The attribute value
  - set
```
public <DB extends ODatabase> DB set(ODatabase.ATTRIBUTES iAttribute,
                                     Object iValue)
```
    Description copied from interface: ODatabase
    
    Sets a database attribute value
    
    Specified by:
    
    set in interface ODatabase<ORecord>
    
    Parameters:
    
    iAttribute - Attributes between #ATTRIBUTES enum
    
    iValue - Value to set
    
    Returns:
    
    underlying
  - getRecordMetadata
```
public ORecordMetadata getRecordMetadata(ORID rid)
```
    Specified by:
    
    getRecordMetadata in interface ODatabase<ORecord>
  - getTransaction
```
public OTransaction getTransaction()
```
    Description copied from interface: ODatabase
    
    Return active transaction. Cannot be null. If no transaction is active, then a OTransactionNoTx instance is returned.
    
    Specified by:
    
    getTransaction in interface ODatabase<ORecord>
    
    Returns:
    
    OTransaction implementation
  - load
```
public <RET extends ORecord> RET load(ORecord iRecord,
                                      String iFetchPlan)
```
    Description copied from interface: ODatabase
    
    Loads a record using a fetch plan.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to load
    
    iFetchPlan - Fetch plan used
    
    Returns:
    
    The record received
  - load
```
@Deprecated
public <RET extends ORecord> RET load(ORecord iRecord,
                                                  String iFetchPlan,
                                                  boolean iIgnoreCache,
                                                  boolean loadTombstone,
                                                  OStorage.LOCKING_STRATEGY iLockingStrategy)
```
    Deprecated.
    
    Description copied from interface: ODatabase
    
    Loads a record using a fetch plan.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to load
    
    iFetchPlan - Fetch plan used
    
    Returns:
    
    The record received
  - load
```
@Deprecated
public <RET extends ORecord> RET load(ORecord iRecord,
                                                  String iFetchPlan,
                                                  boolean iIgnoreCache,
                                                  boolean iUpdateCache,
                                                  boolean loadTombstone,
                                                  OStorage.LOCKING_STRATEGY iLockingStrategy)
```
    Deprecated.
    
    Description copied from interface: ODatabase
    
    Loads a record using a fetch plan.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to load
    
    iFetchPlan - Fetch plan used
    
    Returns:
    
    The record received
  - load
```
public <RET extends ORecord> RET load(ORecord iRecord)
```
    Description copied from interface: ODatabase
    
    Loads the entity and return it.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - The entity to load. If the entity was already loaded it will be reloaded and all the changes will be lost.
    
    Returns:
  - load
```
public <RET extends ORecord> RET load(ORID recordId)
```
    Description copied from interface: ODatabase
    
    Loads the entity by the Record ID.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    recordId - The unique record id of the entity to load.
    
    Returns:
    
    The loaded entity
  - load
```
public <RET extends ORecord> RET load(ORID iRecordId,
                                      String iFetchPlan)
```
    Description copied from interface: ODatabase
    
    Loads the entity by the Record ID using a fetch plan.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecordId - The unique record id of the entity to load.
    
    iFetchPlan - Fetch plan used
    
    Returns:
    
    The loaded entity
  - loadIfVersionIsNotLatest
```
public <RET extends ORecord> RET loadIfVersionIsNotLatest(ORID rid,
                                                          int recordVersion,
                                                          String fetchPlan,
                                                          boolean ignoreCache)
                                                   throws ORecordNotFoundException
```
    Specified by:
    
    loadIfVersionIsNotLatest in interface ODatabaseDocumentInternal
    
    Throws:
    
    ORecordNotFoundException
  - load
```
@Deprecated
public <RET extends ORecord> RET load(ORID iRecordId,
                                                  String iFetchPlan,
                                                  boolean iIgnoreCache,
                                                  boolean loadTombstone,
                                                  OStorage.LOCKING_STRATEGY iLockingStrategy)
```
    Deprecated.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
  - load
```
@Deprecated
public <RET extends ORecord> RET load(ORID iRecordId,
                                                  String iFetchPlan,
                                                  boolean iIgnoreCache,
                                                  boolean iUpdateCache,
                                                  boolean loadTombstone,
                                                  OStorage.LOCKING_STRATEGY iLockingStrategy)
```
    Deprecated.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
  - reload
```
public <RET extends ORecord> RET reload(ORecord iRecord)
```
  - reload
```
public <RET extends ORecord> RET reload(ORecord iRecord,
                                        String iFetchPlan)
```
  - reload
```
public <RET extends ORecord> RET reload(ORecord iRecord,
                                        String iFetchPlan,
                                        boolean iIgnoreCache)
```
    Description copied from interface: ODatabase
    
    Force the reloading of the entity.
    
    Specified by:
    
    reload in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - The entity to load. If the entity was already loaded it will be reloaded and all the changes will be lost.
    
    iFetchPlan - Fetch plan used
    
    iIgnoreCache - Ignore cache or use it
    
    Returns:
    
    The loaded entity
  - reload
```
public <RET extends ORecord> RET reload(ORecord record,
                                        String fetchPlan,
                                        boolean ignoreCache,
                                        boolean force)
```
    Description copied from interface: ODatabase
    
    Force the reloading of the entity.
    
    Specified by:
    
    reload in interface ODatabase<ORecord>
    
    Parameters:
    
    record - The entity to load. If the entity was already loaded it will be reloaded and all the changes will be lost.
    
    fetchPlan - Fetch plan used
    
    ignoreCache - Ignore cache or use it
    
    force - Force to reload record even if storage has the same record as reloaded record, it is useful if fetch plan is not null and alongside with root record linked records will be reloaded.
    
    Returns:
    
    The loaded entity
  - delete
```
public ODatabaseDocument delete(ORID iRecord)
```
    Deletes the record without checking the version.
    
    Specified by:
    
    delete in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - The RecordID to delete.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - recycle
```
public void recycle(ORecord record)
```
    Specified by:
    
    recycle in interface ODatabaseDocumentInternal
  - hide
```
public boolean hide(ORID rid)
```
    Description copied from interface: ODatabase
    
    Hides records content by putting tombstone on the records position but does not delete record itself.
    This method is used in case of record content itself is broken and cannot be read or deleted. So it is emergence method. This method can be used only if there is no active transaction in database.
    
    Specified by:
    
    hide in interface ODatabase<ORecord>
    
    Parameters:
    
    rid - record id.
    
    Returns:
    
    true if record was hidden and false if record does not exits in database.
  - getSerializerFactory
```
public OBinarySerializerFactory getSerializerFactory()
```
    Specified by:
    
    getSerializerFactory in interface ODatabaseDocumentInternal
    
    Returns:
    
    the factory of binary serializers.
  - begin
```
public ODatabaseDocument begin(OTransaction iTx)
```
    Description copied from interface: ODatabase
    
    Attaches a transaction as current.
    
    Specified by:
    
    begin in interface ODatabase<ORecord>
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - load
```
public <RET extends ORecord> RET load(ORecord iRecord,
                                      String iFetchPlan,
                                      boolean iIgnoreCache)
```
    Loads a record using a fetch plan.
    
    Specified by:
    
    load in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to load
    
    iFetchPlan - Fetch plan used
    
    iIgnoreCache - Ignore cache or use it
    
    Returns:
    
    The record received
  - executeReadRecords
```
public Set<ORecord> executeReadRecords(Set<ORecordId> iRids,
                                       boolean ignoreCache)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
  - executeReadRecord
```
public <RET extends ORecord> RET executeReadRecord(ORecordId rid,
                                                   ORecord iRecord,
                                                   int recordVersion,
                                                   String fetchPlan,
                                                   boolean ignoreCache,
                                                   boolean iUpdateCache,
                                                   boolean loadTombstones,
                                                   OStorage.LOCKING_STRATEGY lockingStrategy,
                                                   ODatabaseDocumentTx.RecordReader recordReader)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
  - assignAndCheckCluster
```
public int assignAndCheckCluster(ORecord record,
                                 String iClusterName)
```
    Specified by:
    
    assignAndCheckCluster in interface ODatabaseDocumentInternal
  - executeSaveEmptyRecord
```
public <RET extends ORecord> RET executeSaveEmptyRecord(ORecord record,
                                                        String clusterName)
```
  - 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)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
  - executeDeleteRecord
```
public void executeDeleteRecord(OIdentifiable record,
                                int iVersion,
                                boolean iRequired,
                                ODatabase.OPERATION_MODE iMode,
                                boolean prohibitTombstones)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
  - executeRecycleRecord
```
public void executeRecycleRecord(ORecord record)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
  - executeHideRecord
```
public boolean executeHideRecord(OIdentifiable record,
                                 ODatabase.OPERATION_MODE iMode)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
  - begin
```
public ODatabaseDocumentTx begin()
```
    Description copied from interface: ODatabase
    
    Begins a new transaction. By default the type is OPTIMISTIC. If a previous transaction was started it will be rollbacked and closed before to start a new one. A transaction once begun has to be closed by calling the ODatabase.commit() or ODatabase.rollback().
    
    Specified by:
    
    begin in interface ODatabase<ORecord>
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - begin
```
public ODatabaseDocumentTx begin(OTransaction.TXTYPE iType)
```
    Description copied from interface: ODatabase
    
    Begins a new transaction specifying the transaction type. If a previous transaction was started it will be rollbacked and closed before to start a new one. A transaction once begun has to be closed by calling the ODatabase.commit() or ODatabase.rollback().
    
    Specified by:
    
    begin in interface ODatabase<ORecord>
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - setDefaultTransactionMode
```
public void setDefaultTransactionMode()
```
  - freeze
```
public void freeze(boolean throwException)
```
    Flush all indexes and cached storage content to the disk. After this call users can perform only select queries. All write-related commands will queued till ODatabaseDocument.release() command will be called or exception will be thrown on attempt to modify DB data. Concrete behaviour depends on throwException parameter. IMPORTANT: This command is not reentrant.
    
    Specified by:
    
    freeze in interface ODatabaseDocument
    
    Specified by:
    
    freeze in interface ODatabase<ORecord>
    
    Parameters:
    
    throwException - If true OModificationOperationProhibitedException exception will be thrown in case of write command will be performed.
  - isFrozen
```
public boolean isFrozen()
```
    Description copied from interface: ODatabase
    
    Returns true if the database is frozen (ODatabase.freeze() operation), otherwise false.
    
    Specified by:
    
    isFrozen in interface ODatabase<ORecord>
  - freeze
```
public void freeze()
```
    Flush all indexes and cached storage content to the disk. After this call users can perform only select queries. All write-related commands will queued till ODatabaseDocument.release() command will be called. Given command waits till all on going modifications in indexes or DB will be finished. IMPORTANT: This command is not reentrant.
    
    Specified by:
    
    freeze in interface ODatabaseDocument
    
    Specified by:
    
    freeze in interface ODatabase<ORecord>
    
    See Also:
    
    ODatabase.release()
  - release
```
public void release()
```
    Allows to execute write-related commands on DB. Called after ODatabaseDocument.freeze() command.
    
    Specified by:
    
    release in interface ODatabaseDocument
    
    Specified by:
    
    release in interface ODatabase<ORecord>
    
    See Also:
    
    ODatabase.freeze()
  - newInstance
```
public ODocument newInstance()
```
    Creates a new ODocument.
    
    Specified by:
    
    newInstance in interface ODatabase<ORecord>
    
    Returns:
    
    The new instance.
  - newInstance
```
public ODocument newInstance(String iClassName)
```
    Creates a document with specific class.
    
    Specified by:
    
    newInstance in interface ODatabaseSchemaAware<ORecord>
    
    Parameters:
    
    iClassName - the name of class that should be used as a class of created document.
    
    Returns:
    
    new instance of document.
  - browseClass
```
public ORecordIteratorClass<ODocument> browseClass(String iClassName)
```
    Browses all the records of the specified class and also all the subclasses. If you've a class Vehicle and Car that extends Vehicle then a db.browseClass("Vehicle", true) will return all the instances of Vehicle and Car. The order of the returned instance starts from record id with position 0 until the end. Base classes are worked at first.
    
    Specified by:
    
    browseClass in interface ODatabaseDocument
    
    Parameters:
    
    iClassName - Class name to iterate
    
    Returns:
    
    Iterator of ODocument instances
  - browseClass
```
public ORecordIteratorClass<ODocument> browseClass(String iClassName,
                                                   boolean iPolymorphic)
```
    Browses all the records of the specified class and if iPolymorphic is true also all the subclasses. If you've a class Vehicle and Car that extends Vehicle then a db.browseClass("Vehicle", true) will return all the instances of Vehicle and Car. The order of the returned instance starts from record id with position 0 until the end. Base classes are worked at first.
    
    Specified by:
    
    browseClass in interface ODatabaseDocument
    
    Parameters:
    
    iClassName - Class name to iterate
    
    iPolymorphic - Consider also the instances of the subclasses or not
    
    Returns:
    
    Iterator of ODocument instances
  - browseCluster
```
public ORecordIteratorCluster<ODocument> browseCluster(String iClusterName)
```
    Browses all the records of the specified cluster.
    
    Specified by:
    
    browseCluster in interface ODatabaseDocument
    
    Parameters:
    
    iClusterName - Cluster name to iterate
    
    Returns:
    
    Iterator of ODocument instances
  - getListeners
```
public Iterable<ODatabaseListener> getListeners()
```
    Retrieves all the registered listeners.
    
    Specified by:
    
    getListeners in interface ODatabase<ORecord>
    
    Returns:
    
    An iterable of ODatabaseListener instances.
  - browseCluster
```
@Deprecated
public ORecordIteratorCluster<ODocument> browseCluster(String iClusterName,
                                                                   long startClusterPosition,
                                                                   long endClusterPosition,
                                                                   boolean loadTombstones)
```
    Deprecated.
    
    Specified by:
    
    browseCluster in interface ODatabaseDocument
  - save
```
public <RET extends ORecord> RET save(ORecord iRecord)
```
    Saves a document to the database. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.
    If MVCC is enabled and the version of the document is different by the version stored in the database, then a OConcurrentModificationException exception is thrown.Before to save the document it must be valid following the constraints declared in the schema if any (can work also in schema-less mode). To validate the document the ODocument.validate() is called.
    
    Specified by:
    
    save in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to save.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
    
    Throws:
    
    OConcurrentModificationException - if the version of the document is different by the version contained in the database.
    
    OValidationException - if the document breaks some validation constraints defined in the schema
    
    See Also:
    
    #setMVCC(boolean), {@link #isMVCC()}
  - save
```
public <RET extends ORecord> RET save(ORecord iRecord,
                                      ODatabase.OPERATION_MODE iMode,
                                      boolean iForceCreate,
                                      ORecordCallback<? extends Number> iRecordCreatedCallback,
                                      ORecordCallback<Integer> iRecordUpdatedCallback)
```
    Saves a document to the database. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.
    If MVCC is enabled and the version of the document is different by the version stored in the database, then a OConcurrentModificationException exception is thrown.Before to save the document it must be valid following the constraints declared in the schema if any (can work also in schema-less mode). To validate the document the ODocument.validate() is called.
    
    Specified by:
    
    save in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to save.
    
    iForceCreate - Flag that indicates that record should be created. If record with current rid already exists, exception is thrown
    
    iRecordCreatedCallback - callback that is called after creation of new record
    
    iRecordUpdatedCallback - callback that is called after record update
    
    iMode - Mode of save: synchronous (default) or asynchronous
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
    
    Throws:
    
    OConcurrentModificationException - if the version of the document is different by the version contained in the database.
    
    OValidationException - if the document breaks some validation constraints defined in the schema
    
    See Also:
    
    #setMVCC(boolean), {@link #isMVCC()}
  - save
```
public <RET extends ORecord> RET save(ORecord iRecord,
                                      String iClusterName)
```
    Saves a document specifying a cluster where to store the record. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.
    If MVCC is enabled and the version of the document is different by the version stored in the database, then a OConcurrentModificationException exception is thrown. Before to save the document it must be valid following the constraints declared in the schema if any (can work also in schema-less mode). To validate the document the ODocument.validate() is called.
    
    Specified by:
    
    save in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to save
    
    iClusterName - Cluster name where to save the record
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
    
    Throws:
    
    OConcurrentModificationException - if the version of the document is different by the version contained in the database.
    
    OValidationException - if the document breaks some validation constraints defined in the schema
    
    See Also:
    
    #setMVCC(boolean), {@link #isMVCC()}, ODocument#validate()
  - save
```
public <RET extends ORecord> RET save(ORecord iRecord,
                                      String iClusterName,
                                      ODatabase.OPERATION_MODE iMode,
                                      boolean iForceCreate,
                                      ORecordCallback<? extends Number> iRecordCreatedCallback,
                                      ORecordCallback<Integer> iRecordUpdatedCallback)
```
    Saves a document specifying a cluster where to store the record. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.
    If MVCC is enabled and the version of the document is different by the version stored in the database, then a OConcurrentModificationException exception is thrown. Before to save the document it must be valid following the constraints declared in the schema if any (can work also in schema-less mode). To validate the document the ODocument.validate() is called.
    
    Specified by:
    
    save in interface ODatabase<ORecord>
    
    Parameters:
    
    iRecord - Record to save
    
    iClusterName - Cluster name where to save the record
    
    iMode - Mode of save: synchronous (default) or asynchronous
    
    iForceCreate - Flag that indicates that record should be created. If record with current rid already exists, exception is thrown
    
    iRecordCreatedCallback - callback that is called after creation of new record
    
    iRecordUpdatedCallback - callback that is called after record update
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
    
    Throws:
    
    OConcurrentModificationException - if the version of the document is different by the version contained in the database.
    
    OValidationException - if the document breaks some validation constraints defined in the schema
    
    See Also:
    
    #setMVCC(boolean), {@link #isMVCC()}, ODocument#validate()
  - delete
```
public ODatabaseDocumentTx delete(ORecord record)
```
    Deletes a document. Behavior depends by the current running transaction if any. If no transaction is running then the record is deleted immediately. If an Optimistic transaction is running then the record will be deleted at commit time. The current transaction will continue to see the record as deleted, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as deleted, while others cannot access to it since it's locked.
    If MVCC is enabled and the version of the document is different by the version stored in the database, then a OConcurrentModificationException exception is thrown.
    
    Specified by:
    
    delete in interface ODatabase<ORecord>
    
    Parameters:
    
    record - record to delete
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
    
    See Also:
    
    #setMVCC(boolean), {@link #isMVCC()}
  - countClass
```
public long countClass(String iClassName)
```
    Returns the number of the records of the class iClassName.
    
    Specified by:
    
    countClass in interface ODatabaseSchemaAware<ORecord>
    
    Parameters:
    
    iClassName - Class name
    
    Returns:
    
    Total entities
  - countClass
```
public long countClass(String iClassName,
                       boolean iPolymorphic)
```
    Returns the number of the records of the class iClassName considering also sub classes if polymorphic is true.
    
    Specified by:
    
    countClass in interface ODatabaseSchemaAware<ORecord>
    
    Parameters:
    
    iClassName - Class name
    
    iPolymorphic - True if consider also the sub classes, otherwise false
    
    Returns:
    
    Total entities
  - commit
```
public ODatabase<ORecord> commit()
```
    Commits the current transaction. The approach is all or nothing. All changes will be permanent following the storage type. If the operation succeed all the entities changed inside the transaction context will be effectives. If the operation fails, all the changed entities will be restored in the datastore. Memory instances are not guaranteed to being restored as well.
    
    Specified by:
    
    commit in interface ODatabase<ORecord>
    
    Returns:
  - commit
```
public ODatabaseDocument commit(boolean force)
                         throws OTransactionException
```
    Specified by:
    
    commit in interface ODatabase<ORecord>
    
    Throws:
    
    OTransactionException
  - rollback
```
public ODatabase<ORecord> rollback()
```
    Aborts the current running transaction. All the pending changed entities will be restored in the datastore. Memory instances are not guaranteed to being restored as well.
    
    Specified by:
    
    rollback in interface ODatabase<ORecord>
    
    Returns:
  - rollback
```
public ODatabaseDocument rollback(boolean force)
                           throws OTransactionException
```
    Specified by:
    
    rollback in interface ODatabase<ORecord>
    
    Throws:
    
    OTransactionException
  - getUnderlying
```
public <DB extends ODatabase> DB getUnderlying()
```
    This method is internal, it can be subject to signature change or be removed, do not use.
    
    Specified by:
    
    getUnderlying in interface ODatabaseInternal<ORecord>
    
    Returns:
    
    The underlying ODatabase implementation.
  - getStorage
```
public OStorage getStorage()
```
    This method is internal, it can be subject to signature change or be removed, do not use.
    
    Specified by:
    
    getStorage in interface ODatabaseInternal<ORecord>
    
    Returns:
    
    The underlying storage implementation
    
    See Also:
    
    OStorage
  - replaceStorage
```
public void replaceStorage(OStorage iNewStorage)
```
    This method is internal, it can be subject to signature change or be removed, do not use.
    
    Specified by:
    
    replaceStorage in interface ODatabaseInternal<ORecord>
    
    Parameters:
    
    iNewStorage - The new storage to use. Usually it's a wrapped instance of the current cluster.
  - callInLock
```
public <V> V callInLock(Callable<V> iCallable,
                        boolean iExclusiveLock)
```
    Specified by:
    
    callInLock in interface ODatabaseInternal<ORecord>
  - backup
```
public List<String> backup(OutputStream out,
                           Map<String,Object> options,
                           Callable<Object> callable,
                           OCommandOutputListener iListener,
                           int compressionLevel,
                           int bufferSize)
                    throws IOException
```
    Description copied from interface: OBackupable
    
    Executes a backup of the database. During the backup the database will be frozen in read-only mode.
    
    Specified by:
    
    backup in interface OBackupable
    
    Parameters:
    
    out - OutputStream used to write the backup content. Use a FileOutputStream to make the backup persistent on disk
    
    options - Backup options as Map object. Currently no options are supported, this is just ignored (null is accepted)
    
    callable - Callback to execute when the database is locked
    
    iListener - Listener called for backup messages
    
    compressionLevel - ZIP Compression level between 1 (the minimum) and 9 (maximum). The bigger is the compression, the smaller will be the final backup content, but will consume more CPU and time to execute
    
    bufferSize - Buffer size in bytes, the bigger is the buffer, the more efficient will be the compression
    
    Throws:
    
    IOException
    
    See Also:
    
    ODatabaseExport
  - restore
```
public void restore(InputStream in,
                    Map<String,Object> options,
                    Callable<Object> callable,
                    OCommandOutputListener iListener)
             throws IOException
```
    Description copied from interface: OBackupable
    
    Executes a restore of a database backup. During the restore the database will be frozen in read-only mode.
    
    Specified by:
    
    restore in interface OBackupable
    
    Parameters:
    
    in - InputStream used to read the backup content. Use a FileInputStream to read a backup on a disk
    
    options - Backup options as Map object
    
    callable - Callback to execute when the database is locked
    
    iListener - Listener called for backup messages
    
    Throws:
    
    IOException
    
    See Also:
    
    ODatabaseImport
  - getSbTreeCollectionManager
```
public OSBTreeCollectionManager getSbTreeCollectionManager()
```
    Internal. Gets an instance of sb-tree collection manager for current database.
    
    Specified by:
    
    getSbTreeCollectionManager in interface ODatabaseDocumentInternal
  - getStorageVersions
```
public OCurrentStorageComponentsFactory getStorageVersions()
```
    Description copied from interface: ODatabaseDocumentInternal
    
    Internal. Returns the factory that defines a set of components that current database should use to be compatible to current version of storage. So if you open a database create with old version of OrientDB it defines a components that should be used to provide backward compatibility with that version of database.
    
    Specified by:
    
    getStorageVersions in interface ODatabaseDocumentInternal
  - getSerializer
```
public ORecordSerializer getSerializer()
```
    Specified by:
    
    getSerializer in interface ODatabaseDocumentInternal
    
    Returns:
    
    serializer which is used for document serialization.
  - setSerializer
```
public void setSerializer(ORecordSerializer serializer)
```
    Sets serializer for the database which will be used for document serialization.
    
    Parameters:
    
    serializer - the serializer to set.
  - resetInitialization
```
public void resetInitialization()
```
    Specified by:
    
    resetInitialization in interface ODatabaseInternal<ORecord>
  - incrementalBackup
```
public String incrementalBackup(String path)
```
    Description copied from interface: ODatabase
    
    Performs incremental backup of database content to the selected folder. This is thread safe operation and can be done in normal operational mode.
    If it will be first backup of data full content of database will be copied into folder otherwise only changes after last backup in the same folder will be copied.
    
    Specified by:
    
    incrementalBackup in interface ODatabase<ORecord>
    
    Parameters:
    
    path - Path to backup folder.
    
    Returns:
    
    File name of the backup
  - checkSecurity
```
@Deprecated
public <DB extends ODatabaseDocument> DB checkSecurity(String iResource,
                                                                   int iOperation)
```
    Deprecated.
    
    Description copied from interface: ODatabaseDocument
    
    Checks if the operation on a resource is allowed for the current user.
    
    Specified by:
    
    checkSecurity in interface ODatabaseDocument
    
    Parameters:
    
    iResource - Resource where to execute the operation
    
    iOperation - Operation to execute against the resource
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - checkSecurity
```
@Deprecated
public <DB extends ODatabaseDocument> DB checkSecurity(String iResourceGeneric,
                                                                   int iOperation,
                                                                   Object iResourceSpecific)
```
    Deprecated.
    
    Description copied from interface: ODatabaseDocument
    Checks if the operation on a resource is allowed for the current user. The check is made in two steps:
    1. Access to all the resource as *
    2. Access to the specific target resource
    Specified by:
    
    checkSecurity in interface ODatabaseDocument
    
    Parameters:
    
    iResourceGeneric - Resource where to execute the operation, i.e.: database.clusters
    
    iOperation - Operation to execute against the resource
    
    iResourceSpecific - Target resource, i.e.: "employee" to specify the cluster name.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - checkSecurity
```
@Deprecated
public <DB extends ODatabaseDocument> DB checkSecurity(String iResourceGeneric,
                                                                   int iOperation,
                                                                   Object... iResourcesSpecific)
```
    Deprecated.
    
    Description copied from interface: ODatabaseDocument
    Checks if the operation against multiple resources is allowed for the current user. The check is made in two steps:
    1. Access to all the resource as *
    2. Access to the specific target resources
    Specified by:
    
    checkSecurity in interface ODatabaseDocument
    
    Parameters:
    
    iResourceGeneric - Resource where to execute the operation, i.e.: database.clusters
    
    iOperation - Operation to execute against the resource
    
    iResourcesSpecific - Target resources as an array of Objects, i.e.: ["employee", 2] to specify cluster name and id.
    
    Returns:
    
    The Database instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - isPooled
```
public boolean isPooled()
```
    Specified by:
    
    isPooled in interface ODatabaseDocument
    
    Returns:
    
    true if database is obtained from the pool and false otherwise.
  - setCurrentDatabaseInThreadLocal
```
@Deprecated
public void setCurrentDatabaseInThreadLocal()
```
    Deprecated.
    
    Use #activateOnCurrentThread instead.
  - activateOnCurrentThread
```
public ODatabaseDocumentTx activateOnCurrentThread()
```
    Activates current database instance on current thread.
    
    Specified by:
    
    activateOnCurrentThread in interface ODatabase<ORecord>
  - isActiveOnCurrentThread
```
public boolean isActiveOnCurrentThread()
```
    Description copied from interface: ODatabase
    
    Returns true if the current database instance is active on current thread, otherwise false.
    
    Specified by:
    
    isActiveOnCurrentThread in interface ODatabase<ORecord>
  - checkOpeness
```
protected void checkOpeness()
```
  - checkIfActive
```
public void checkIfActive()
```
  - addBlobCluster
```
public int addBlobCluster(String iClusterName,
                          Object... iParameters)
```
    Description copied from interface: ODatabaseDocument
    
    Add a cluster for blob records.
    
    Specified by:
    
    addBlobCluster in interface ODatabaseDocument
    
    Specified by:
    
    addBlobCluster in interface ODatabase<ORecord>
    
    Parameters:
    
    iClusterName - Cluster name
    
    iParameters - Additional parameters to pass to the factories
    
    Returns:
    
    Cluster id
  - getBlobClusterIds
```
public Set<Integer> getBlobClusterIds()
```
    Description copied from interface: ODatabase
    
    Retrieve the set of defined blob cluster.
    
    Specified by:
    
    getBlobClusterIds in interface ODatabase<ORecord>
    
    Returns:
    
    the set of defined blob cluster ids.
  - executeWithRetries
```
public static Object executeWithRetries(OCallable<Object,Integer> callback,
                                        int maxRetry)
```
  - executeWithRetries
```
public static Object executeWithRetries(OCallable<Object,Integer> callback,
                                        int maxRetry,
                                        int waitBetweenRetry)
```
  - executeWithRetries
```
public static Object executeWithRetries(OCallable<Object,Integer> callback,
                                        int maxRetry,
                                        int waitBetweenRetry,
                                        ORecord[] recordToReloadOnRetry)
```
  - getActiveIntent
```
public OIntent getActiveIntent()
```
    Description copied from interface: ODatabaseDocument
    
    Return the active intent.
    
    Specified by:
    
    getActiveIntent in interface ODatabaseDocument
    
    Returns:

Class ODatabaseDocumentTx

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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.ODatabase

Field Detail

defaultSerializer

serializer

sessionMetadata

Constructor Detail

ODatabaseDocumentTx

ODatabaseDocumentTx

Method Detail

getDefaultSerializer

setDefaultSerializer

open

isPrefetchRecords

setPrefetchRecords

open

callOnOpenListeners

create

create

create

drop

copy

callOnCloseListeners

callOnDropListeners

getRecord

reload

load

delete

cleanOutRecord

getType

delete

delete

browseCluster

browseCluster

browseCluster

command

query

getRecordType

countClusterElements

countClusterElements

truncateCluster

countClusterElements

countClusterElements

countClusterElements

getMetadata

checkSecurity

checkSecurity

checkSecurity

getDatabaseOwner

setDatabaseOwner

isRetainRecords

setRetainRecords

setStatus

setStatusInternal

setDefaultClusterIdInternal

setInternal

getUser

setUser

reloadUser

isMVCC

setMVCC

getDictionary

registerHook

registerHook

unregisterHook

getLocalCache

getHooks

callbackHooks

isValidationEnabled

setValidationEnabled

getConflictStrategy

setConflictStrategy