Package com.orientechnologies.orient.core.db.document

Class ODatabaseDocumentEmbedded

java.lang.Object

com.orientechnologies.common.listener.OListenerManger<ODatabaseListener>

com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract

com.orientechnologies.orient.core.db.document.ODatabaseDocumentEmbedded

All Implemented Interfaces:

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

Direct Known Subclasses:

ODatabaseDocumentDistributed, ODatabaseDocumentEmbeddedPooled

public class ODatabaseDocumentEmbedded
extends ODatabaseDocumentAbstract
implements OQueryLifecycleListener

Created by tglman on 27/06/16.

Nested Class Summary

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

ODatabase.ATTRIBUTES, ODatabase.STATUS

Field Summary

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

activeQueries, componentsFactory, currentTx, databaseOwner, hooks, hooksByScope, inHook, initialized, loadedRecordsCount, localCache, maxRecordLoadMs, maxRidbagPrefetchMs, metadata, minRecordLoadMs, minRidbagPrefetchMs, properties, queryState, recordType, retainRecords, ridbagPrefetchCount, serializer, sharedContext, status, totalRecordLoadMs, totalRidbagPrefetchMs, unmodifiableHooks, url, user

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

TYPE

Constructor Summary

Constructors

Constructor	Description
ODatabaseDocumentEmbedded(OStorage storage)

Method Summary

Modifier and Type	Method	Description
int	addBlobCluster(String iClusterName, Object... iParameters)	Add a cluster for blob records.
int	addCluster(String iClusterName, int iRequestedId)	Adds a new cluster.
int	addCluster(String iClusterName, Object... iParameters)	Adds a new cluster.
void	addRidbagPrefetchStats(long execTimeMs)
protected void	afterCommitOperations()
void	afterCreateOperations(OIdentifiable id)
void	afterDeleteOperations(OIdentifiable id)
void	afterReadOperations(OIdentifiable identifiable)
protected void	afterRollbackOperations()
void	afterUpdateOperations(OIdentifiable id)
List<String>	backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener, int compressionLevel, int bufferSize)	Executes a backup of the database.
OIdentifiable	beforeCreateOperations(OIdentifiable id, String iClusterName)
void	beforeDeleteOperations(OIdentifiable id, String iClusterName)
boolean	beforeReadOperations(OIdentifiable identifiable)
OIdentifiable	beforeUpdateOperations(OIdentifiable id, String iClusterName)
void	callOnCreateListeners()
OPhysicalPosition[]	ceilingPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
<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 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 resourceGeneric, String resourceSpecific, int iOperation)	Checks if the operation on a resource is allowed for the current user.
OResultSet	command(String query, Object... args)	Executes a generic (idempotent or non idempotent) command.
OResultSet	command(String query, Map args)	Executes a generic (idempotent or non idempotent) command.
List<ODocument>	commandLikeLegacy(String query, Map<Object,Object> params)
void	commitPreallocate()
ODatabaseDocumentInternal	copy()	Returns a copy of current database if it's open.
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(String iClusterName)	Counts all the entities in the specified cluster name.
long	countRecords()
protected void	createMetadata(OSharedContext shared)
OBonsaiCollectionPointer	createSBTree(int clusterId, UUID ownerUUID)
ODatabaseDocumentAbstract	delete(ORecord record)	Deletes a document.
ORawBuffer	directRead(ORecordId rid, String fetchPlan, boolean ignoreCache, int recordVersion)
boolean	dropCluster(int clusterId)	Drops a cluster by its id.
boolean	dropCluster(String iClusterName)	Drops a cluster by its name.
boolean	dropClusterInternal(int clusterId)
protected boolean	dropClusterInternal(String iClusterName)
void	endEsclusiveMetadataChange()
OResultSet	execute(String language, String script, Object... args)	Execute a script in a specified query language.
OResultSet	execute(String language, String script, Map<String,?> args)	Execute a script of a specified query language The result set has to be closed after usage Sample usage:
void	executeDeleteRecord(OIdentifiable identifiable, int iVersion, boolean iRequired)	This method is internal, it can be subject to signature change or be removed, do not use.
List<ODocument>	executeLikeLegacy(String language, String script, Map<Object,Object> params)
<RET extends ORecord> RET	executeReadRecord(ORecordId rid, ORecord iRecord, int recordVersion, String fetchPlan, boolean ignoreCache, boolean iUpdateCache, RecordReader recordReader)	This method is internal, it can be subject to signature change or be removed, do not use.
OPhysicalPosition[]	floorPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
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.
long[]	getClusterDataRange(int currentClusterId)
String	getClusterName(ORecord record)
String	getClusterRecordConflictStrategy(int clusterId)
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[]	getClustersIds(Set<String> filterClusters)
OrientDBConfig	getConfig()
ORecordConflictStrategy	getConflictStrategy()	Returns the current record conflict strategy.
long	getLastClusterPosition(int clusterId)
ORecordMetadata	getRecordMetadata(ORID rid)
OSBTreeCollectionManager	getSbTreeCollectionManager()	Internal.
long	getSize()	Returns the total size of the records in the database.
ODatabaseStats	getStats()
OStorage	getStorage()	Returns the underlying storage implementation.
OStorageInfo	getStorageInfo()
OView	getViewFromCluster(int cluster)
OPhysicalPosition[]	higherPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
String	incrementalBackup(String path)	Performs incremental backup of database content to the selected folder.
void	init(OrientDBConfig config, OSharedContext sharedContext)
protected void	installHooksEmbedded()
void	internalClose(boolean recycle)
void	internalCommit(OTransactionInternal transaction)	Executed the commit on the storage hiding away storage concepts from the transaction
void	internalCommitPreallocate(OTransactionOptimistic oTransactionOptimistic)
void	internalCreate(OrientDBConfig config, OSharedContext ctx)
void	internalLockRecord(OIdentifiable iRecord, OStorage.LOCKING_STRATEGY lockingStrategy)
void	internalLockRecord(OIdentifiable iRecord, OStorage.LOCKING_STRATEGY lockingStrategy, long timeout)
void	internalOpen(OAuthenticationInfo authenticationInfo)
void	internalOpen(String iUserName, String iUserPassword)
void	internalOpen(String iUserName, String iUserPassword, boolean checkPassword)
void	internalUnlockRecord(OIdentifiable iRecord)
boolean	isClosed()	Checks if the database is closed.
boolean	isReusable()
OLiveQueryMonitor	live(String query, OLiveQueryResultListener listener, Object... args)	Subscribe a query as a live query for future create/update event with the referred conditions
OLiveQueryMonitor	live(String query, OLiveQueryResultListener listener, Map<String,?> args)	Subscribe a query as a live query for future create/update event with the referred conditions
protected void	loadMetadata()
<RET extends ORecord> RET	lock(ORID recordId)	Pessimistic lock a record.
<RET extends ORecord> RET	lock(ORID recordId, long timeout, TimeUnit timeoutUnit)	Pessimistic lock a record.
OPhysicalPosition[]	lowerPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
OResultSet	query(OInternalExecutionPlan plan, Map<Object,Object> params)
OResultSet	query(String query, Object... args)	Executes an SQL query.
OResultSet	query(String query, Map args)	Executes an SQL query (idempotent).
List<ODocument>	queryLikeLegacy(String query, Map<Object,Object> params, int limit, String fetchPlan)
void	queryStarted(String id, OResultSet resultSet)
void	queryStartUsingViewCluster(int clusterId)
void	queryStartUsingViewIndex(String index)
ORawBuffer	readIfVersionIsNotLatest(ORecordId rid, String fetchPlan, boolean ignoreCache, int recordVersion)
void	rebuildIndexes()
void	release()	Allows to execute write-related commands on DB.
void	reload()	Reloads the database information like the cluster list.
void	replaceStorage(OStorage iNewStorage)	Internal only: replace the storage with a new one.
void	resetRecordLoadStats()
void	restore(InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener)	Executes a restore of a database backup.
ORecord	saveAll(ORecord iRecord, String iClusterName, boolean iForceCreate)
<T> T	sendSequenceAction(OSequenceAction action)
<DB extends ODatabase> DB	set(ODatabase.ATTRIBUTES iAttribute, Object iValue)	Sets a database attribute value
ODatabaseDocumentEmbedded	setConflictStrategy(ORecordConflictStrategy iResolver)	Overrides record conflict strategy.
ODatabaseDocumentEmbedded	setConflictStrategy(String iStrategyName)	Overrides record conflict strategy selecting the strategy by name.
<DB extends ODatabase> DB	setCustom(String name, Object iValue)
void	setDefaultClusterId(int addCluster)
void	startEsclusiveMetadataChange()
void	truncateClass(String name)
long	truncateClass(String name, boolean polimorfic)
void	truncateCluster(String clusterName)	Removes all data in the cluster with given name.
long	truncateClusterInternal(String clusterName)
void	unlock(ORID recordId)	Pessimistic unlock

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

activateOnCurrentThread, assignAndCheckCluster, beforeCommitOperations, beforeRollbackOperations, begin, begin, browseClass, browseClass, browseCluster, browseCluster, browseCluster, callbackHookFailure, callbackHookFinalize, callbackHooks, callbackHookSuccess, callOnCloseListeners, callOnDropListeners, callOnOpenListeners, checkForClusterPermissions, checkIfActive, checkOpenness, checkRecordClass, checkSecurity, cleanOutRecord, clearDocumentTracking, close, closeActiveQueries, commit, commit, countClass, countClass, countClass, countView, delete, delete, executeWithRetries, executeWithRetries, executeWithRetries, existsCluster, get, getActiveQueries, getActiveQuery, getBlobClusterIds, getClusterIdByName, getClusterNameById, getClusterNames, getClusters, getCollectionsChanges, getConfiguration, getDatabaseOwner, getDefaultClusterId, getDefaultSerializer, getDictionary, getHooks, getListeners, getLocalCache, getMetadata, getName, getProperties, getProperty, getRecord, getRecordType, getSerializer, getSerializerFactory, getSharedContext, getStatus, getStorageVersions, getTransaction, getType, getUnderlying, getURL, getUser, init, isActiveOnCurrentThread, isClusterEdge, isClusterVertex, isClusterView, isPooled, isPrefetchRecords, isUseLightweightEdges, isValidationEnabled, load, load, load, load, load, load, loadIfVersionIsNotLatest, newBlob, newBlob, newEdge, newEdge, newElement, newElement, newElement, newEmbeddedElement, newEmbeddedElement, newInstance, newInstance, newLightweightEdge, newRegularEdge, newVertex, newVertex, pessimisticLockChecks, queryClosed, queryStarted, rawBegin, registerHook, registerHook, reload, reload, reload, reload, reloadUser, resetInitialization, rollback, rollback, save, save, save, setCurrentDatabaseInThreadLocal, setDatabaseOwner, setDefaultSerializer, setDefaultTransactionMode, setInternal, setPrefetchRecords, setProperty, setSerializer, setStatus, setStatusInternal, setUseLightweightEdges, setUser, setValidationEnabled, swapTx, unregisterHook

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

browseListeners, getListenersCopy, registerListener, resetListeners, unregisterListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

createClass, executeWithRetry, getClass, registerListener, unregisterListener

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

createClassIfNotExist, createEdgeClass, createVertexClass, newEdge, newVertex, reload

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

getHaStatus, getStorageId, indexQuery, isDistributed, isLocalEnv, isRemote, queryOnNode, realClose, remoteRollback, removeHaServer, reuse, sync, syncCommit

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

createInterruptTimerTask, getActiveDataCenterMap, getEnterpriseEndpoint, getLocalNodeName, isSharded

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

queryClosed

Constructor Details

ODatabaseDocumentEmbedded

public ODatabaseDocumentEmbedded(OStorage storage)

Method Details

init

public void init(OrientDBConfig config,
 OSharedContext sharedContext)

internalOpen

public void internalOpen(OAuthenticationInfo authenticationInfo)

internalOpen

public void internalOpen(String iUserName,
 String iUserPassword)

internalOpen

public void internalOpen(String iUserName,
 String iUserPassword,
 boolean checkPassword)

internalCreate

public void internalCreate(OrientDBConfig config,
 OSharedContext ctx)

callOnCreateListeners

public void callOnCreateListeners()

createMetadata

protected void createMetadata(OSharedContext shared)

loadMetadata

protected void loadMetadata()

Specified by:

loadMetadata in class ODatabaseDocumentAbstract

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

setCustom

public <DB extends ODatabase> DB setCustom(String name,
 Object iValue)

Specified by:

setCustom in interface ODatabaseDocumentInternal

copy

public ODatabaseDocumentInternal 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

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.

rebuildIndexes

public void rebuildIndexes()

installHooksEmbedded

protected void installHooksEmbedded()

getStorage

public OStorage getStorage()

Description copied from interface: ODatabaseInternal

Returns the underlying storage implementation.

Specified by:

getStorage in interface ODatabaseInternal<ORecord>

Returns:

The underlying storage implementation

See Also:

• OStorage

getStorageInfo

public OStorageInfo getStorageInfo()

Specified by:

getStorageInfo in interface ODatabaseInternal<ORecord>

replaceStorage

public void replaceStorage(OStorage iNewStorage)

Description copied from interface: ODatabaseInternal

Internal only: replace the storage with a new one.

Specified by:

replaceStorage in interface ODatabaseInternal<ORecord>

Parameters:

iNewStorage - The new storage to use. Usually it's a wrapped instance of the current cluster.

query

public OResultSet query(String query,
 Object... args)

Description copied from interface: ODatabase

Executes an SQL query. The result set has to be closed after usage

Sample usage:

OResultSet rs = db.query("SELECT FROM V where name = ?", "John"); while(rs.hasNext()){ OResult item = rs.next(); ... } rs.close();

Specified by:

query in interface ODatabase<ORecord>

Parameters:

query - the query string

args - query parameters (positional)

Returns:

the query result set

query

public OResultSet query(String query,
 Map args)

Description copied from interface: ODatabase

Executes an SQL query (idempotent). The result set has to be closed after usage

Sample usage:

Map<String, Object&gt params = new HashMapMap<&gt(); params.put("name", "John"); OResultSet rs = db.query("SELECT FROM V where name = :name", params); while(rs.hasNext()){ OResult item = rs.next(); ... } rs.close();

Specified by:

query in interface ODatabase<ORecord>

Parameters:

query - the query string

args - query parameters (named)

Returns:

command

public OResultSet command(String query,
 Object... args)

Description copied from interface: ODatabase

Executes a generic (idempotent or non idempotent) command. The result set has to be closed after usage

Sample usage:

OResultSet rs = db.command("INSERT INTO Person SET name = ?", "John"); ... rs.close();

Specified by:

command in interface ODatabase<ORecord>

args - query arguments

Returns:

queryLikeLegacy

public List<ODocument> queryLikeLegacy(String query,
 Map<Object,Object> params,
 int limit,
 String fetchPlan)

Specified by:

queryLikeLegacy in interface ODatabaseDocumentInternal

commandLikeLegacy

public List<ODocument> commandLikeLegacy(String query,
 Map<Object,Object> params)

Specified by:

commandLikeLegacy in interface ODatabaseDocumentInternal

executeLikeLegacy

public List<ODocument> executeLikeLegacy(String language,
 String script,
 Map<Object,Object> params)

Specified by:

executeLikeLegacy in interface ODatabaseDocumentInternal

command

public OResultSet command(String query,
 Map args)

Description copied from interface: ODatabase

Executes a generic (idempotent or non idempotent) command. The result set has to be closed after usage

Sample usage:

Map<String, Object&gt params = new HashMapMap<&gt(); params.put("name", "John"); OResultSet rs = db.query("INSERT INTO Person SET name = :name", params); ... rs.close();

Specified by:

command in interface ODatabase<ORecord>

Returns:

execute

public OResultSet execute(String language,
 String script,
 Object... args)

Description copied from interface: ODatabase

Execute a script in a specified query language. The result set has to be closed after usage

Sample usage:

String script = "INSERT INTO Person SET name = 'foo', surname = ?;"+ "INSERT INTO Person SET name = 'bar', surname = ?;"+ "INSERT INTO Person SET name = 'baz', surname = ?;";

OResultSet rs = db.execute("sql", script, "Surname1", "Surname2", "Surname3"); ... rs.close();

Specified by:

execute in interface ODatabase<ORecord>

Returns:

execute

public OResultSet execute(String language,
 String script,
 Map<String,?> args)

Description copied from interface: ODatabase

Execute a script of a specified query language The result set has to be closed after usage

Sample usage:

Map<String, Object&gt params = new HashMapMap<&gt(); params.put("surname1", "Jones"); params.put("surname2", "May"); params.put("surname3", "Ali");

String script = "INSERT INTO Person SET name = 'foo', surname = :surname1;"+ "INSERT INTO Person SET name = 'bar', surname = :surname2;"+ "INSERT INTO Person SET name = 'baz', surname = :surname3;";

OResultSet rs = db.execute("sql", script, params); ... rs.close();

Specified by:

execute in interface ODatabase<ORecord>

Returns:

query

public OResultSet query(OInternalExecutionPlan plan,
 Map<Object,Object> params)

queryStartUsingViewCluster

public void queryStartUsingViewCluster(int clusterId)

Specified by:

queryStartUsingViewCluster in interface ODatabaseDocumentInternal

queryStartUsingViewIndex

public void queryStartUsingViewIndex(String index)

Specified by:

queryStartUsingViewIndex in interface ODatabaseDocumentInternal

queryStarted

public void queryStarted(String id,
 OResultSet resultSet)

Specified by:

queryStarted in interface OQueryLifecycleListener

getConfig

public OrientDBConfig getConfig()

live

public OLiveQueryMonitor live(String query,
 OLiveQueryResultListener listener,
 Object... args)

Description copied from interface: ODatabase

Subscribe a query as a live query for future create/update event with the referred conditions

Specified by:

live in interface ODatabase<ORecord>

Parameters:

query - live query

listener - the listener that receive the query results

args - the live query args

live

public OLiveQueryMonitor live(String query,
 OLiveQueryResultListener listener,
 Map<String,?> args)

Description copied from interface: ODatabase

Subscribe a query as a live query for future create/update event with the referred conditions

Specified by:

live in interface ODatabase<ORecord>

Parameters:

query - live query

listener - the listener that receive the query results

args - the live query args

addBlobCluster

public int addBlobCluster(String iClusterName,
 Object... iParameters)

Description copied from interface: ODatabaseDocument

Add a cluster for blob records.

Specified by:

addBlobCluster in interface ODatabase<ORecord>

Specified by:

addBlobCluster in interface ODatabaseDocument

Parameters:

iClusterName - Cluster name

iParameters - Additional parameters to pass to the factories

Returns:

Cluster id

executeDeleteRecord

public void executeDeleteRecord(OIdentifiable identifiable,
 int iVersion,
 boolean iRequired)

This method is internal, it can be subject to signature change or be removed, do not use. @Internal

Specified by:

executeDeleteRecord in interface ODatabaseDocumentInternal

beforeCreateOperations

public OIdentifiable beforeCreateOperations(OIdentifiable id,
 String iClusterName)

Specified by:

beforeCreateOperations in interface ODatabaseDocumentInternal

Returns:

null if nothing changed the instance if has been modified or replaced

beforeUpdateOperations

public OIdentifiable beforeUpdateOperations(OIdentifiable id,
 String iClusterName)

Specified by:

beforeUpdateOperations in interface ODatabaseDocumentInternal

Returns:

null if nothing changed the instance if has been modified or replaced

delete

public ODatabaseDocumentAbstract 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.

beforeDeleteOperations

public void beforeDeleteOperations(OIdentifiable id,
 String iClusterName)

Specified by:

beforeDeleteOperations in interface ODatabaseDocumentInternal

afterCreateOperations

public void afterCreateOperations(OIdentifiable id)

Specified by:

afterCreateOperations in interface ODatabaseDocumentInternal

afterUpdateOperations

public void afterUpdateOperations(OIdentifiable id)

Specified by:

afterUpdateOperations in interface ODatabaseDocumentInternal

afterDeleteOperations

public void afterDeleteOperations(OIdentifiable id)

Specified by:

afterDeleteOperations in interface ODatabaseDocumentInternal

afterReadOperations

public void afterReadOperations(OIdentifiable identifiable)

Specified by:

afterReadOperations in interface ODatabaseDocumentInternal

beforeReadOperations

public boolean beforeReadOperations(OIdentifiable identifiable)

Specified by:

beforeReadOperations in interface ODatabaseDocumentInternal

Returns:

true if the record should be skipped

afterCommitOperations

protected void afterCommitOperations()

Overrides:

afterCommitOperations in class ODatabaseDocumentAbstract

afterRollbackOperations

protected void afterRollbackOperations()

Overrides:

afterRollbackOperations in class ODatabaseDocumentAbstract

saveAll

public ORecord saveAll(ORecord iRecord,
 String iClusterName,
 boolean iForceCreate)

Specified by:

saveAll in interface ODatabaseDocumentInternal

getClusterName

public String getClusterName(ORecord record)

Specified by:

getClusterName in interface ODatabaseDocumentInternal

getViewFromCluster

public OView getViewFromCluster(int cluster)

Specified by:

getViewFromCluster in interface ODatabaseDocumentInternal

Overrides:

getViewFromCluster in class ODatabaseDocumentAbstract

executeReadRecord

public <RET extends ORecord> RET executeReadRecord(ORecordId rid,
 ORecord iRecord,
 int recordVersion,
 String fetchPlan,
 boolean ignoreCache,
 boolean iUpdateCache,
 RecordReader recordReader)

This method is internal, it can be subject to signature change or be removed, do not use. @Internal

Specified by:

executeReadRecord in interface ODatabaseDocumentInternal

Specified by:

executeReadRecord in class ODatabaseDocumentAbstract

internalLockRecord

public void internalLockRecord(OIdentifiable iRecord,
 OStorage.LOCKING_STRATEGY lockingStrategy)

Specified by:

internalLockRecord in interface ODatabaseDocumentInternal

internalLockRecord

public void internalLockRecord(OIdentifiable iRecord,
 OStorage.LOCKING_STRATEGY lockingStrategy,
 long timeout)

internalUnlockRecord

public void internalUnlockRecord(OIdentifiable iRecord)

Specified by:

internalUnlockRecord in interface ODatabaseDocumentInternal

lock

public <RET extends ORecord> RET lock(ORID recordId)
                               throws OLockException

Description copied from interface: ODatabase

Pessimistic lock a record.

In case of lock inside the transaction the lock will be release by the commit operation, In case of lock outside a transaction unlock need to be call manually.

Specified by:

lock in interface ODatabase<ORecord>

Parameters:

recordId - the id of the record that need to be locked

Returns:

the record updated to the last state after the lock.

Throws:

OLockException - In case of deadlock detected

lock

public <RET extends ORecord> RET lock(ORID recordId,
 long timeout,
 TimeUnit timeoutUnit)
                               throws OLockException

Description copied from interface: ODatabase

Pessimistic lock a record.

Specified by:

lock in interface ODatabase<ORecord>

Parameters:

recordId - the id of the record that need to be locked

timeout - for the record locking

timeoutUnit - relative for the timeout

Returns:

the record updated to the last state after the lock.

Throws:

OLockException - In case of deadlock detected

unlock

public void unlock(ORID recordId)
            throws OLockException

Description copied from interface: ODatabase

Pessimistic unlock

Specified by:

unlock in interface ODatabase<ORecord>

Parameters:

recordId - the id of the record to unlock

Throws:

OLockException - if the record is not locked.

sendSequenceAction

public <T> T sendSequenceAction(OSequenceAction action)
                         throws ExecutionException,
InterruptedException

Specified by:

sendSequenceAction in interface ODatabaseDocumentInternal

Throws:

ExecutionException

InterruptedException

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.

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)

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

Returns:

Cluster id

getConflictStrategy

public ORecordConflictStrategy getConflictStrategy()

Description copied from interface: ODatabase

Returns the current record conflict strategy.

Specified by:

getConflictStrategy in interface ODatabase<ORecord>

setConflictStrategy

public ODatabaseDocumentEmbedded 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 ODatabaseDocumentEmbedded 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.

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.

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

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(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

dropCluster

public boolean dropCluster(String iClusterName)

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

dropClusterInternal

protected boolean dropClusterInternal(String iClusterName)

dropCluster

public boolean dropCluster(int clusterId)

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:

clusterId - id of cluster to delete

Returns:

true if has been removed, otherwise false

dropClusterInternal

public boolean dropClusterInternal(int clusterId)

Specified by:

dropClusterInternal in interface ODatabaseDocumentInternal

getSize

public long getSize()

Description copied from interface: ODatabase

Returns the total size of the records in the database.

Specified by:

getSize in interface ODatabase<ORecord>

getStats

public ODatabaseStats getStats()

Specified by:

getStats in interface ODatabaseInternal<ORecord>

addRidbagPrefetchStats

public void addRidbagPrefetchStats(long execTimeMs)

Specified by:

addRidbagPrefetchStats in interface ODatabaseInternal<ORecord>

resetRecordLoadStats

public void resetRecordLoadStats()

Specified by:

resetRecordLoadStats in interface ODatabaseInternal<ORecord>

incrementalBackup

public String incrementalBackup(String path)
                         throws UnsupportedOperationException

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

Throws:

UnsupportedOperationException

getRecordMetadata

public ORecordMetadata getRecordMetadata(ORID rid)

Specified by:

getRecordMetadata in interface ODatabase<ORecord>

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

Specified by:

freeze in interface ODatabaseDocument

Parameters:

throwException - If true OModificationOperationProhibitedException exception will be thrown in case of write command will be performed.

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

Specified by:

freeze in interface ODatabaseDocument

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

Specified by:

release in interface ODatabaseDocument

See Also:

• ODatabase.freeze()

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<String, Object> object

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<String, Object> 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

reload

public void reload()

Description copied from interface: ODatabase

Reloads the database information like the cluster list.

Specified by:

reload in interface ODatabase<ORecord>

internalCommit

public void internalCommit(OTransactionInternal transaction)

Description copied from interface: ODatabaseDocumentInternal

Executed the commit on the storage hiding away storage concepts from the transaction

Specified by:

internalCommit in interface ODatabaseDocumentInternal

internalClose

public void internalClose(boolean recycle)

Specified by:

internalClose in interface ODatabaseDocumentInternal

getClusterDataRange

public long[] getClusterDataRange(int currentClusterId)

Specified by:

getClusterDataRange in interface ODatabaseDocumentInternal

setDefaultClusterId

public void setDefaultClusterId(int addCluster)

Specified by:

setDefaultClusterId in interface ODatabaseDocumentInternal

getLastClusterPosition

public long getLastClusterPosition(int clusterId)

Specified by:

getLastClusterPosition in interface ODatabaseDocumentInternal

getClusterRecordConflictStrategy

public String getClusterRecordConflictStrategy(int clusterId)

Specified by:

getClusterRecordConflictStrategy in interface ODatabaseDocumentInternal

getClustersIds

public int[] getClustersIds(Set<String> filterClusters)

Specified by:

getClustersIds in interface ODatabaseDocumentInternal

startEsclusiveMetadataChange

public void startEsclusiveMetadataChange()

Specified by:

startEsclusiveMetadataChange in interface ODatabaseDocumentInternal

endEsclusiveMetadataChange

public void endEsclusiveMetadataChange()

Specified by:

endEsclusiveMetadataChange in interface ODatabaseDocumentInternal

truncateClass

public long truncateClass(String name,
 boolean polimorfic)

Specified by:

truncateClass in interface ODatabaseDocumentInternal

truncateClass

public void truncateClass(String name)

Specified by:

truncateClass in interface ODatabaseDocumentInternal

truncateClusterInternal

public long truncateClusterInternal(String clusterName)

Specified by:

truncateClusterInternal in interface ODatabaseDocumentInternal

truncateCluster

public void truncateCluster(String clusterName)

Description copied from interface: ODatabase

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.

commitPreallocate

public void commitPreallocate()

Specified by:

commitPreallocate in interface ODatabaseDocumentInternal

internalCommitPreallocate

public void internalCommitPreallocate(OTransactionOptimistic oTransactionOptimistic)

Specified by:

internalCommitPreallocate in interface ODatabaseDocumentInternal

higherPhysicalPositions

public OPhysicalPosition[] higherPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

Specified by:

higherPhysicalPositions in interface ODatabaseDocumentInternal

lowerPhysicalPositions

public OPhysicalPosition[] lowerPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

Specified by:

lowerPhysicalPositions in interface ODatabaseDocumentInternal

ceilingPhysicalPositions

public OPhysicalPosition[] ceilingPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

Specified by:

ceilingPhysicalPositions in interface ODatabaseDocumentInternal

floorPhysicalPositions

public OPhysicalPosition[] floorPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

Specified by:

floorPhysicalPositions in interface ODatabaseDocumentInternal

countRecords

public long countRecords()

Specified by:

countRecords in interface ODatabaseDocumentInternal

isReusable

public boolean isReusable()

Specified by:

isReusable in interface ODatabaseDocumentInternal

createSBTree

public OBonsaiCollectionPointer createSBTree(int clusterId,
 UUID ownerUUID)

Specified by:

createSBTree in interface ODatabaseDocumentInternal

directRead

public ORawBuffer directRead(ORecordId rid,
 String fetchPlan,
 boolean ignoreCache,
 int recordVersion)

Specified by:

directRead in interface ODatabaseDocumentInternal

readIfVersionIsNotLatest

public ORawBuffer readIfVersionIsNotLatest(ORecordId rid,
 String fetchPlan,
 boolean ignoreCache,
 int recordVersion)

Specified by:

readIfVersionIsNotLatest in interface ODatabaseDocumentInternal