com.orientechnologies.orient.core.db

Interface ODatabaseDocumentInternal

All Superinterfaces:

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

All Known Implementing Classes:

ODatabaseDocumentAbstract, ODatabaseDocumentDistributed, ODatabaseDocumentDistributedPooled, ODatabaseDocumentEmbedded, ODatabaseDocumentEmbeddedPooled, ODatabaseDocumentRemote, ODatabaseDocumentRemotePooled, ODatabaseDocumentTx, ODatabaseDocumentTxPooled

public interface ODatabaseDocumentInternal
extends ODatabaseSession, ODatabaseInternal<ORecord>

Nested Class Summary

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

ODatabase.ATTRIBUTES, ODatabase.OPERATION_MODE, ODatabase.STATUS

Field Summary

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

TYPE

Method Summary

Modifier and Type	Method and Description
void	afterCreateOperations(OIdentifiable id)
void	afterDeleteOperations(OIdentifiable id)
void	afterReadOperations(OIdentifiable identifiable)
void	afterUpdateOperations(OIdentifiable id)
int	assignAndCheckCluster(ORecord record, String iClusterName)
OIdentifiable	beforeCreateOperations(OIdentifiable id, String iClusterName)
void	beforeDeleteOperations(OIdentifiable id, String iClusterName)
boolean	beforeReadOperations(OIdentifiable identifiable)
OIdentifiable	beforeUpdateOperations(OIdentifiable id, String iClusterName)
ORecordHook.RESULT	callbackHooks(ORecordHook.TYPE type, OIdentifiable id)
void	callOnCloseListeners()
void	callOnDropListeners()
void	callOnOpenListeners()
void	checkForClusterPermissions(String name)
void	checkIfActive()
ODatabaseDocumentInternal	cleanOutRecord(ORID rid, int version)
ODatabaseDocumentInternal	copy()
void	executeDeleteRecord(OIdentifiable record, int iVersion, boolean iRequired, ODatabase.OPERATION_MODE iMode, boolean prohibitTombstones)
<RET extends ORecord> RET	executeReadRecord(ORecordId rid, ORecord iRecord, int recordVersion, String fetchPlan, boolean ignoreCache, boolean iUpdateCache, boolean loadTombstones, OStorage.LOCKING_STRATEGY lockingStrategy, RecordReader recordReader)
<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)
default Map<String,OResultSet>	getActiveQueries()
default OResultSet	getActiveQuery(String id)
Map<UUID,OBonsaiCollectionPointer>	getCollectionsChanges()
default int	getCommandInterruptionDepth()
default Map<String,Object>	getHaStatus(boolean servers, boolean db, boolean latency, boolean messages)
OMetadataInternal	getMetadata() Return the OMetadata instance.
OSBTreeCollectionManager	getSbTreeCollectionManager() Internal.
ORecordSerializer	getSerializer()
OBinarySerializerFactory	getSerializerFactory()
OCurrentStorageComponentsFactory	getStorageVersions() Internal.
boolean	hide(ORID rid) Hides records content by putting tombstone on the records position but does not delete record itself.
default OResultSet	indexQuery(String indexName, String query, Object... args)
void	internalClose(boolean recycle)
void	internalCommit(OTransactionInternal transaction) Executed the commit on the storage hiding away storage concepts from the transaction
boolean	isClusterEdge(int cluster)
boolean	isClusterVertex(int cluster)
default boolean	isCommandInterrupted()
boolean	isPrefetchRecords()
default boolean	isStorageCommitHappening() needed for query interrupt
boolean	isUseLightweightEdges()
<RET extends ORecord> RET	loadIfVersionIsNotLatest(ORID rid, int recordVersion, String fetchPlan, boolean ignoreCache)
OEdge	newLightweightEdge(String iClassName, OVertex from, OVertex to)
OEdge	newRegularEdge(String iClassName, OVertex from, OVertex to)
default OResultSet	queryOnNode(String nodeName, OExecutionPlan executionPlan, Map<Object,Object> inputParameters) sends an execution plan to a remote node for a remote query execution
void	rawBegin(OTransaction transaction)
default void	realClose()
void	recycle(ORecord record)
void	reloadUser()
default boolean	removeHaServer(String serverName)
default void	reuse()
default void	setCommandInterrupted(boolean commandInterrupted)
default void	setCommandInterruptionDepth(int commandInterruptionDepth)
<DB extends ODatabase> DB	setCustom(String name, Object iValue)
void	setDefaultTransactionMode()
void	setPrefetchRecords(boolean prefetchRecords)
void	setSerializer(ORecordSerializer serializer)
default void	setStorageCommitHappening(boolean commandInterrupted)
void	setUseLightweightEdges(boolean b)
default OTransaction	swapTx(OTransaction newTx)

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

addBlobCluster, browseClass, browseClass, browseCluster, browseCluster, browseCluster, browseCluster, browseCluster, checkSecurity, checkSecurity, checkSecurity, checkSecurity, checkSecurity, checkSecurity, countClass, countClass, createClassIfNotExist, createEdgeClass, createVertexClass, freeze, freeze, getRecord, getRecordType, isPooled, isRetainRecords, isValidationEnabled, newBlob, newBlob, newEdge, newEdge, newEdge, newElement, newElement, newInstance, newVertex, newVertex, newVertex, release, setRetainRecords, setValidationEnabled

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

activateOnCurrentThread, addCluster, addCluster, begin, begin, begin, close, command, command, command, commit, commit, countClusterElements, countClusterElements, countClusterElements, countClusterElements, countClusterElements, create, create, create, createClass, declareIntent, delete, delete, delete, drop, dropCluster, dropCluster, execute, execute, executeWithRetry, exists, existsCluster, get, getActiveIntent, getBlobClusterIds, getClass, getClusterIdByName, getClusterNameById, getClusterNames, getClusterRecordSizeById, getClusterRecordSizeByName, getClusters, getConfiguration, getConflictStrategy, getDefaultClusterId, getDictionary, getHooks, getListeners, getLocalCache, getName, getProperties, getProperty, getRecordMetadata, getSize, getStatus, getTransaction, getType, getURL, getUser, incrementalBackup, isActiveOnCurrentThread, isClosed, isMVCC, live, live, load, load, load, load, load, load, load, load, load, load, newInstance, open, query, query, query, registerHook, registerHook, registerListener, reload, reload, reload, rollback, rollback, save, save, save, save, set, setConflictStrategy, setConflictStrategy, setMVCC, setProperty, setStatus, truncateCluster, unregisterHook, unregisterListener

Methods inherited from interface com.orientechnologies.orient.core.util.OBackupable

backup, restore

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

addRidbagPrefetchStats, createInterruptTimerTask, getActiveClusterMap, getActiveDataCenterMap, getDatabaseOwner, getEnterpriseEndpoint, getLocalNodeName, getMicroOrRegularTransaction, getSharedContext, getStats, getStorage, getUnderlying, interruptExecution, isSharded, open, replaceStorage, resetInitialization, resetRecordLoadStats, setDatabaseOwner, setInternal, setUser

Method Detail

getStorageVersions

OCurrentStorageComponentsFactory getStorageVersions()

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.

getSbTreeCollectionManager

OSBTreeCollectionManager getSbTreeCollectionManager()

Internal. Gets an instance of sb-tree collection manager for current database.

getSerializerFactory

OBinarySerializerFactory getSerializerFactory()

Returns:

the factory of binary serializers.

getSerializer

ORecordSerializer getSerializer()

Returns:

serializer which is used for document serialization.

setSerializer

void setSerializer(ORecordSerializer serializer)

assignAndCheckCluster

int assignAndCheckCluster(ORecord record,
                          String iClusterName)

loadIfVersionIsNotLatest

<RET extends ORecord> RET loadIfVersionIsNotLatest(ORID rid,
                                                   int recordVersion,
                                                   String fetchPlan,
                                                   boolean ignoreCache)
                                            throws ORecordNotFoundException

Throws:

ORecordNotFoundException

reloadUser

void reloadUser()

afterReadOperations

void afterReadOperations(OIdentifiable identifiable)

beforeReadOperations

boolean beforeReadOperations(OIdentifiable identifiable)

Parameters:

identifiable -

Returns:

true if the record should be skipped

beforeCreateOperations

OIdentifiable beforeCreateOperations(OIdentifiable id,
                                     String iClusterName)

Parameters:

id -

iClusterName -

Returns:

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

beforeUpdateOperations

OIdentifiable beforeUpdateOperations(OIdentifiable id,
                                     String iClusterName)

Parameters:

id -

iClusterName -

Returns:

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

beforeDeleteOperations

void beforeDeleteOperations(OIdentifiable id,
                            String iClusterName)

afterUpdateOperations

void afterUpdateOperations(OIdentifiable id)

afterCreateOperations

void afterCreateOperations(OIdentifiable id)

afterDeleteOperations

void afterDeleteOperations(OIdentifiable id)

callbackHooks

ORecordHook.RESULT callbackHooks(ORecordHook.TYPE type,
                                 OIdentifiable id)

executeReadRecord

<RET extends ORecord> RET executeReadRecord(ORecordId rid,
                                            ORecord iRecord,
                                            int recordVersion,
                                            String fetchPlan,
                                            boolean ignoreCache,
                                            boolean iUpdateCache,
                                            boolean loadTombstones,
                                            OStorage.LOCKING_STRATEGY lockingStrategy,
                                            RecordReader recordReader)

executeSaveRecord

<RET extends ORecord> RET executeSaveRecord(ORecord record,
                                            String clusterName,
                                            int ver,
                                            ODatabase.OPERATION_MODE mode,
                                            boolean forceCreate,
                                            ORecordCallback<? extends Number> recordCreatedCallback,
                                            ORecordCallback<Integer> recordUpdatedCallback)

executeDeleteRecord

void executeDeleteRecord(OIdentifiable record,
                         int iVersion,
                         boolean iRequired,
                         ODatabase.OPERATION_MODE iMode,
                         boolean prohibitTombstones)

executeSaveEmptyRecord

<RET extends ORecord> RET executeSaveEmptyRecord(ORecord record,
                                                 String clusterName)

setDefaultTransactionMode

void setDefaultTransactionMode()

getMetadata

OMetadataInternal getMetadata()

Description copied from interface: ODatabase

Return the OMetadata instance. Cannot be null.

Specified by:

getMetadata in interface ODatabase<ORecord>

Returns:

The OMetadata instance.

copy

ODatabaseDocumentInternal copy()

recycle

void recycle(ORecord record)

checkIfActive

void checkIfActive()

callOnOpenListeners

void callOnOpenListeners()

callOnCloseListeners

void callOnCloseListeners()

callOnDropListeners

void callOnDropListeners()

setCustom

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

setPrefetchRecords

void setPrefetchRecords(boolean prefetchRecords)

isPrefetchRecords

boolean isPrefetchRecords()

checkForClusterPermissions

void checkForClusterPermissions(String name)

rawBegin

void rawBegin(OTransaction transaction)

getActiveQuery

default OResultSet getActiveQuery(String id)

getActiveQueries

default Map<String,OResultSet> getActiveQueries()

isUseLightweightEdges

boolean isUseLightweightEdges()

newLightweightEdge

OEdge newLightweightEdge(String iClassName,
                         OVertex from,
                         OVertex to)

newRegularEdge

OEdge newRegularEdge(String iClassName,
                     OVertex from,
                     OVertex to)

setUseLightweightEdges

void setUseLightweightEdges(boolean b)

hide

boolean hide(ORID rid)

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.

Parameters:

rid - record id.

Returns:

true if record was hidden and false if record does not exits in database.

Throws:

UnsupportedOperationException - In case current version of cluster does not support given operation.

ORecordNotFoundException - if record is already deleted/hidden.

cleanOutRecord

ODatabaseDocumentInternal cleanOutRecord(ORID rid,
                                         int version)

realClose

default void realClose()

reuse

default void reuse()

getHaStatus

default Map<String,Object> getHaStatus(boolean servers,
                                       boolean db,
                                       boolean latency,
                                       boolean messages)

removeHaServer

default boolean removeHaServer(String serverName)

queryOnNode

default OResultSet queryOnNode(String nodeName,
                               OExecutionPlan executionPlan,
                               Map<Object,Object> inputParameters)

sends an execution plan to a remote node for a remote query execution

Parameters:

nodeName - the node name

executionPlan - the execution plan

inputParameters - the input parameters for execution

Returns:

an OResultSet to fetch the results of the query execution

internalCommit

void internalCommit(OTransactionInternal transaction)

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

Parameters:

transaction -

isClusterVertex

boolean isClusterVertex(int cluster)

isClusterEdge

boolean isClusterEdge(int cluster)

swapTx

default OTransaction swapTx(OTransaction newTx)

internalClose

void internalClose(boolean recycle)

indexQuery

default OResultSet indexQuery(String indexName,
                              String query,
                              Object... args)

getCollectionsChanges

Map<UUID,OBonsaiCollectionPointer> getCollectionsChanges()

isCommandInterrupted

default boolean isCommandInterrupted()

setCommandInterrupted

default void setCommandInterrupted(boolean commandInterrupted)

getCommandInterruptionDepth

default int getCommandInterruptionDepth()

setCommandInterruptionDepth

default void setCommandInterruptionDepth(int commandInterruptionDepth)

isStorageCommitHappening

default boolean isStorageCommitHappening()

needed for query interrupt

Returns:

setStorageCommitHappening

default void setStorageCommitHappening(boolean commandInterrupted)