Package com.orientechnologies.orient.core.storage.impl.local

Class OAbstractPaginatedStorage

java.lang.Object

com.orientechnologies.orient.core.storage.impl.local.OAbstractPaginatedStorage

All Implemented Interfaces:

OBackgroundExceptionListener, OCheckpointRequestListener, OFreezableStorageComponent, OPageIsBrokenListener, OIdentifiableStorage, OStorage, OStorageInfo, OBackupable

Direct Known Subclasses:

ODirectMemoryStorage, OLocalPaginatedStorage

public abstract class OAbstractPaginatedStorage
extends Object
implements OCheckpointRequestListener, OIdentifiableStorage, OBackgroundExceptionListener, OFreezableStorageComponent, OPageIsBrokenListener, OStorage

Since:

28.03.13

Author:

Andrey Lomakin (a.lomakin-at-orientdb.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.storage.OStorage

OStorage.LOCKING_STRATEGY, OStorage.STATUS

Field Summary

Fields

Modifier and Type	Field	Description
protected OAtomicOperationsManager	atomicOperationsManager
protected AtomicOperationsTable	atomicOperationsTable
protected OCurrentStorageComponentsFactory	componentsFactory
protected OStorageConfiguration	configuration
protected OrientDBInternal	context
protected static final String	DATABASE_INSTANCE_ID
protected AtomicReference<Throwable>	error
protected static final ScheduledExecutorService	fuzzyCheckpointExecutor
protected String	name
protected OReadCache	readCache
protected OSBTreeCollectionManagerShared	sbTreeCollectionManager
protected final ReentrantReadWriteLock	stateLock
protected OStorage.STATUS	status
static final ThreadGroup	storageThreadGroup
protected final String	url
protected OWriteAheadLog	writeAheadLog
protected OWriteCache	writeCache

Fields inherited from interface com.orientechnologies.orient.core.storage.OStorage

CLUSTER_DEFAULT_NAME

Constructor Summary

Constructors

Constructor	Description
OAbstractPaginatedStorage(String name, String filePath, int id, OrientDBInternal context)

Method Summary

Modifier and Type	Method	Description
final void	acquireReadLock(ORID rid)
void	acquireReadLock(ORID rid, long timeout)
final void	acquireWriteLock(ORID rid)
void	acquireWriteLock(ORID rid, long timeout)
final int	addCluster(String clusterName, int requestedId)	Add a new cluster into the storage.
final int	addCluster(String clusterName, Object... parameters)	Add a new cluster into the storage.
protected abstract void	addFileToDirectory(String name, InputStream stream, File directory)
int	addIndexEngine(OIndexMetadata indexMetadata, Map<String,String> engineProperties)
Iterator<OClusterBrowsePage>	browseCluster(int clusterId)
<T> T	callIndexEngine(boolean readOperation, int indexId, OIndexEngineCallback<T> callback)
final OPhysicalPosition[]	ceilingPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
boolean	check(boolean verbose, OCommandOutputListener listener)
protected abstract void	checkBackupRunning()
protected void	checkDatabaseInstanceId(UUID backupUUID)
void	checkErrorState()
final boolean	checkForRecordValidity(OPhysicalPosition ppos)
protected OStartupMetadata	checkIfStorageDirty()
static String	checkName(String name)
protected final void	checkOpennessAndMigration()	Checks if the storage is open.
final boolean	cleanOutRecord(ORecordId recordId, int recordVersion, int iMode, ORecordCallback<Boolean> callback)
void	clearIndex(int indexId)
final void	clearProperties()
protected void	clearStorageDirty()
void	close()
final void	close(boolean force, boolean onDelete)
protected void	closeClusters(boolean onDelete)
protected void	closeIndexes(OAtomicOperation atomicOperation, boolean onDelete)
final Object	command(OCommandRequestText iCommand)	Executes the command request and return the result back.
List<ORecordOperation>	commit(OTransactionInternal clientTx)	Traditional commit that support already temporary rid and already assigned rids
protected List<ORecordOperation>	commit(OTransactionInternal transaction, boolean allocated)	The commit operation can be run in 3 different conditions, embedded commit, pre-allocated commit, other node commit.
List<ORecordOperation>	commitPreAllocated(OTransactionInternal clientTx)	Commit a transaction where the rid where pre-allocated in a previous phase
protected abstract OLogSequenceNumber	copyWALToIncrementalBackup(ZipOutputStream zipOutputStream, long startSegment)
final long	count(int iClusterId)
final long	count(int[] iClusterIds)
final long	count(int[] iClusterIds, boolean countTombstones)
final long	count(int clusterId, boolean countTombstones)
long	countRecords()	Returns the total number of records.
void	create(OContextConfiguration contextConfiguration)
final OStorageOperationResult<OPhysicalPosition>	createRecord(ORecordId rid, byte[] content, int recordVersion, byte recordType, ORecordCallback<Long> callback)
protected abstract OWriteAheadLog	createWalFromIBUFiles(File directory, OContextConfiguration contextConfiguration, Locale locale, byte[] iv)
protected abstract File	createWalTempDirectory()
final void	delete()
void	deleteIndexEngine(int indexId)
final OStorageOperationResult<Boolean>	deleteRecord(ORecordId rid, int version, int mode, ORecordCallback<Boolean> callback)
void	deleteTreeRidBag(OSBTreeRidBag ridBag)
final boolean	dropCluster(int clusterId)	Drops a cluster.
boolean	dropCluster(String iClusterName)
void	endDDL()
final Object	executeCommand(OCommandRequestText iCommand, OCommandExecutor executor)
static int	extractEngineAPIVersion(int externalId)
Optional<OBackgroundNewDelta>	extractTransactionsFromWal(List<OTransactionId> transactionsMetadata)
void	fireConfigurationUpdateNotifications()
final OPhysicalPosition[]	floorPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
protected void	flushAllData()
final void	freeze(boolean throwException)	After this method finished it's execution, all threads that are going to perform data modifications in storage should wait till OFreezableStorageComponent.release() method will be called.
void	fullIncrementalBackup(OutputStream stream)
protected void	generateDatabaseInstanceId(OAtomicOperation atomicOperation)
final OAtomicOperationsManager	getAtomicOperationsManager()
final long[]	getClusterDataRange(int iClusterId)	Returns a pair of long values telling the begin and end positions of data in the requested cluster.
String	getClusterEncryption(int clusterId)
final int	getClusterIdByName(String clusterName)
final Set<OCluster>	getClusterInstances()
String	getClusterName(int clusterId)
String	getClusterNameById(int clusterId)
final Set<String>	getClusterNames()
long	getClusterNextPosition(int clusterId)
String	getClusterRecordConflictStrategy(int clusterId)
long	getClusterRecordsSizeById(int clusterId)
long	getClusterRecordsSizeByName(String clusterName)
final int	getClusters()
int[]	getClustersIds(Set<String> filterClusters)
OCurrentStorageComponentsFactory	getComponentsFactory()
final OStorageConfiguration	getConfiguration()
OrientDBInternal	getContext()
final String	getCreatedAtVersion()
final int	getDefaultClusterId()
final int	getId()
AtomicOperationIdGen	getIdGen()
Stream<ORawPair<Object,ORID>>	getIndexDescStream(int indexId, IndexEngineValuesTransformer valuesTransformer)
OBaseIndexEngine	getIndexEngine(int indexId)
Stream<Object>	getIndexKeyStream(int indexId)
long	getIndexSize(int indexId, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	getIndexStream(int indexId, IndexEngineValuesTransformer valuesTransformer)
Object	getIndexValue(int indexId, Object key)
Stream<ORID>	getIndexValues(int indexId, Object key)
protected abstract byte[]	getIv()
long	getLastCloseTime()
long	getLastClusterPosition(int clusterId)
Optional<byte[]>	getLastMetadata()
OLogSequenceNumber	getLSN()
String	getMode()
String	getName()
protected String	getOpenedAtVersion()
final String	getPhysicalClusterNameById(int iClusterId)
OReadCache	getReadCache()
final ORecordConflictStrategy	getRecordConflictStrategy()
final ORecordMetadata	getRecordMetadata(ORID rid)
long	getRecordScanned()
OPaginatedCluster.RECORD_STATUS	getRecordStatus(ORID rid)
OStorageRecoverListener	getRecoverListener()
protected static Map<Integer,List<ORecordId>>	getRidsGroupedByCluster(Collection<ORecordId> rids)
final OSBTreeCollectionManager	getSBtreeCollectionManager()
int	getSessionCount()
final long	getSize()	Returns the size of the database.
OStorage.STATUS	getStatus()	Returns the current storage's status
OStorage	getUnderlying()	Deprecated.
String	getURL()
UUID	getUuid()
long	getVersion()
int	getVersionForKey(String indexName, Object key)
OWriteAheadLog	getWALInstance()
OWriteCache	getWriteCache()
boolean	hasIndexRangeQuerySupport(int indexId)
final OPhysicalPosition[]	higherPhysicalPositions(int currentClusterId, OPhysicalPosition physicalPosition)
void	incOnOpen()
String	incrementalBackup(String backupDirectory, OCallable<Void,Void> started)
protected void	initConfiguration(OAtomicOperation atomicOperation, OContextConfiguration contextConfiguration)
protected abstract void	initIv()
protected abstract void	initWalAndDiskCache(OContextConfiguration contextConfiguration)
boolean	isAssigningClusterIds()
final boolean	isClosed()
boolean	isDeleted(ORID rid)
protected boolean	isDirty()
boolean	isDistributed()	Deprecated.
protected boolean	isInError()
boolean	isMemory()
final boolean	isRemote()
boolean	isSystemCluster(int clusterId)
protected abstract boolean	isWriteAllowedDuringIncrementalBackup()
Stream<ORawPair<Object,ORID>>	iterateIndexEntriesBetween(int indexId, Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateIndexEntriesMajor(int indexId, Object fromKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
Stream<ORawPair<Object,ORID>>	iterateIndexEntriesMinor(int indexId, Object toKey, boolean isInclusive, boolean ascSortOrder, IndexEngineValuesTransformer transformer)
static OEncryption	loadEncryption(String cfgEncryption, String cfgEncryptionKey)
int	loadExternalIndexEngine(OIndexMetadata indexMetadata, Map<String,String> engineProperties)
int	loadIndexEngine(String name)
protected final Error	logAndPrepareForRethrow(Error error)
protected Error	logAndPrepareForRethrow(Error error, boolean putInReadOnlyMode)
protected final RuntimeException	logAndPrepareForRethrow(RuntimeException runtimeException)
protected RuntimeException	logAndPrepareForRethrow(RuntimeException runtimeException, boolean putInReadOnlyMode)
protected final RuntimeException	logAndPrepareForRethrow(Throwable throwable)
protected RuntimeException	logAndPrepareForRethrow(Throwable throwable, boolean putInReadOnlyMode)
final OPhysicalPosition[]	lowerPhysicalPositions(int currentClusterId, OPhysicalPosition physicalPosition)
final void	makeFuzzyCheckpoint()
protected void	makeStorageDirty()
void	metadataOnly(byte[] metadata)
void	moveToErrorStateIfNeeded(Throwable error)
protected static String	normalizeName(String name)
final void	onException(Throwable e)
final void	open(OContextConfiguration contextConfiguration)
final void	open(String iUserName, String iUserPassword, OContextConfiguration contextConfiguration)
protected final void	openClusters(OAtomicOperation atomicOperation)
protected final void	openIndexes()
final void	pageIsBroken(String fileName, long pageIndex)	Method is called by write cache when it is detected that data page in file is broken.
void	pauseConfigurationUpdateNotifications()
protected abstract void	postCloseSteps(boolean onDelete, boolean internalError, long lastTxId)
protected void	postCloseStepsAfterLock(Map<String,Object> params)
protected final void	postCreateSteps()
protected void	postDeleteSteps()
void	preallocateRids(OTransactionInternal clientTx)	Scan the given transaction for new record and allocate a record id for them, the relative record id is inserted inside the transaction for future use.
protected Map<String,Object>	preCloseSteps()
protected void	preCreateSteps()
void	putIndexValue(int indexId, Object key, Object value)
void	putRidIndexEntry(int indexId, Object key, ORID value)
protected UUID	readDatabaseInstanceId()
protected abstract void	readIv()
OStorageOperationResult<ORawBuffer>	readRecord(ORecordId rid, String iFetchPlan, boolean iIgnoreCache, boolean prefetchRecords, ORecordCallback<ORawBuffer> iCallback)
final OStorageOperationResult<ORawBuffer>	readRecordIfVersionIsNotLatest(ORecordId rid, String fetchPlan, boolean ignoreCache, int recordVersion)
void	registerRecoverListener(OStorageRecoverListener recoverListener)
final void	release()	After this method finished execution all threads that are waiting to perform data modifications in storage will be awaken and will be allowed to continue their execution.
final void	releaseReadLock(ORID rid)
final void	releaseWriteLock(ORID rid)
final void	reload()
boolean	removeKeyFromIndex(int indexId, Object key)
final void	removeProperty(String property)
boolean	removeRidIndexEntry(int indexId, Object key, ORID value)
final void	requestCheckpoint()
OBinarySerializer<?>	resolveObjectSerializer(byte serializerId)
protected final boolean	restoreAtomicUnit(List<OWALRecord> atomicUnit, OModifiableBoolean atLeastOnePageUpdate)
protected OLogSequenceNumber	restoreFrom(OWriteAheadLog writeAheadLog, OLogSequenceNumber lsn)
void	restoreFromIncrementalBackup(String filePath)
void	restoreFullIncrementalBackup(InputStream stream)
final void	setCharset(String charset)
boolean	setClusterAttribute(int id, OCluster.ATTRIBUTES attribute, Object value)
final void	setClusterSelection(String clusterSelection)
final void	setConflictStrategy(ORecordConflictStrategy conflictResolver)
final void	setDateFormat(String dateFormat)
final void	setDateTimeFormat(String dateTimeFormat)
final void	setDefaultClusterId(int defaultClusterId)
final void	setIndexMgrRecordId(String indexMgrRecordId)
final void	setLocaleCountry(String localeCountry)
final void	setLocaleLanguage(String locale)
final void	setMinimumClusters(int minimumClusters)
final void	setProperty(String property, String value)
final void	setRecordSerializer(String recordSerializer, int version)
final void	setSchemaRecordId(String schemaRecordId)
void	setStorageConfigurationUpdateListener(OStorageConfigurationUpdateListener storageConfigurationUpdateListener)
final void	setTimeZone(TimeZone timeZoneValue)
final void	setValidation(boolean validation)
void	shutdown()	This method is called in Orient.shutdown() method.
void	startDDL()
boolean	supportIncremental()
final void	synch()
String	toString()
void	unregisterRecoverListener(OStorageRecoverListener recoverListener)
void	updateIndexEntry(int indexId, Object key, OIndexKeyUpdater<Object> valueCreator)
final OStorageOperationResult<Integer>	updateRecord(ORecordId rid, boolean updateContent, byte[] content, int version, byte recordType, int mode, ORecordCallback<Integer> callback)
boolean	validatedPutIndexValue(int indexId, Object key, ORID value, IndexEngineValidator<Object,ORID> validator)	Puts the given value under the given key into this storage for the index with the given index id.
boolean	wereDataRestoredAfterOpen()
boolean	wereNonTxOperationsPerformedInPreviousOpen()

Methods inherited from class java.lang.Object

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

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

backup, restore

Methods inherited from interface com.orientechnologies.orient.core.storage.OStorage

exists, getType, isIcrementalBackupRunning

Field Details

storageThreadGroup

public static final ThreadGroup storageThreadGroup

fuzzyCheckpointExecutor

protected static final ScheduledExecutorService fuzzyCheckpointExecutor

sbTreeCollectionManager

protected volatile OSBTreeCollectionManagerShared sbTreeCollectionManager

writeAheadLog

protected volatile OWriteAheadLog writeAheadLog

readCache

protected volatile OReadCache readCache

writeCache

protected volatile OWriteCache writeCache

atomicOperationsManager

protected volatile OAtomicOperationsManager atomicOperationsManager

DATABASE_INSTANCE_ID

protected static final String DATABASE_INSTANCE_ID

See Also:

• Constant Field Values

atomicOperationsTable

protected AtomicOperationsTable atomicOperationsTable

url

protected final String url

stateLock

protected final ReentrantReadWriteLock stateLock

configuration

protected volatile OStorageConfiguration configuration

componentsFactory

protected volatile OCurrentStorageComponentsFactory componentsFactory

name

protected String name

status

protected volatile OStorage.STATUS status

error

protected AtomicReference<Throwable> error

context

protected OrientDBInternal context

Constructor Details

OAbstractPaginatedStorage

public OAbstractPaginatedStorage(String name,
 String filePath,
 int id,
 OrientDBInternal context)

Method Details

normalizeName

protected static String normalizeName(String name)

checkName

public static String checkName(String name)

getUnderlying

@Deprecated
public OStorage getUnderlying()

Deprecated.

Specified by:

getUnderlying in interface OStorage

getName

public String getName()

Specified by:

getName in interface OStorage

Specified by:

getName in interface OStorageInfo

getURL

public String getURL()

Specified by:

getURL in interface OStorageInfo

close

public void close()

Specified by:

close in interface OStorage

dropCluster

public boolean dropCluster(String iClusterName)

Specified by:

dropCluster in interface OStorage

countRecords

public long countRecords()

Description copied from interface: OStorage

Returns the total number of records.

Specified by:

countRecords in interface OStorage

toString

public String toString()

Overrides:

toString in class Object

getStatus

public OStorage.STATUS getStatus()

Description copied from interface: OStorage

Returns the current storage's status

Specified by:

getStatus in interface OStorage

isDistributed

@Deprecated
public boolean isDistributed()

Deprecated.

Specified by:

isDistributed in interface OStorage

isAssigningClusterIds

public boolean isAssigningClusterIds()

Specified by:

isAssigningClusterIds in interface OStorage

Specified by:

isAssigningClusterIds in interface OStorageInfo

getComponentsFactory

public OCurrentStorageComponentsFactory getComponentsFactory()

Specified by:

getComponentsFactory in interface OStorage

getVersion

public long getVersion()

Specified by:

getVersion in interface OStorage

shutdown

public void shutdown()

Description copied from interface: OStorage

This method is called in Orient.shutdown() method. For most of the storages it means that storage will be merely closed, but sometimes additional operations are need to be taken in account.

Specified by:

shutdown in interface OStorage

open

public final void open(String iUserName,
 String iUserPassword,
 OContextConfiguration contextConfiguration)

Specified by:

open in interface OStorage

open

public final void open(OContextConfiguration contextConfiguration)

readIv

protected abstract void readIv()
                        throws IOException

Throws:

IOException

getIv

protected abstract byte[] getIv()

getCreatedAtVersion

public final String getCreatedAtVersion()

Specified by:

getCreatedAtVersion in interface OStorage

Returns:

Version of product release under which storage was created.

openIndexes

protected final void openIndexes()

openClusters

protected final void openClusters(OAtomicOperation atomicOperation)
                           throws IOException

Throws:

IOException

create

public void create(OContextConfiguration contextConfiguration)

Specified by:

create in interface OStorage

generateDatabaseInstanceId

protected void generateDatabaseInstanceId(OAtomicOperation atomicOperation)

readDatabaseInstanceId

protected UUID readDatabaseInstanceId()

checkDatabaseInstanceId

protected void checkDatabaseInstanceId(UUID backupUUID)

initIv

protected abstract void initIv()
                        throws IOException

Throws:

IOException

isClosed

public final boolean isClosed()

Specified by:

isClosed in interface OStorage

close

public final void close(boolean force,
 boolean onDelete)

Specified by:

close in interface OStorage

delete

public final void delete()

Specified by:

delete in interface OStorage

check

public boolean check(boolean verbose,
 OCommandOutputListener listener)

addCluster

public final int addCluster(String clusterName,
 Object... parameters)

Description copied from interface: OStorage

Add a new cluster into the storage.

Specified by:

addCluster in interface OStorage

Parameters:

clusterName - name of the cluster

addCluster

public final int addCluster(String clusterName,
 int requestedId)

Description copied from interface: OStorage

Add a new cluster into the storage.

Specified by:

addCluster in interface OStorage

Parameters:

clusterName - name of the cluster

requestedId - requested id of the cluster

dropCluster

public final boolean dropCluster(int clusterId)

Description copied from interface: OStorage

Drops a cluster.

Specified by:

dropCluster in interface OStorage

Parameters:

clusterId - id of the cluster to delete

Returns:

true if has been removed, otherwise false

getClusterNameById

public String getClusterNameById(int clusterId)

Specified by:

getClusterNameById in interface OStorage

getClusterRecordsSizeById

public long getClusterRecordsSizeById(int clusterId)

Specified by:

getClusterRecordsSizeById in interface OStorage

getClusterRecordsSizeByName

public long getClusterRecordsSizeByName(String clusterName)

Specified by:

getClusterRecordsSizeByName in interface OStorage

getClusterRecordConflictStrategy

public String getClusterRecordConflictStrategy(int clusterId)

Specified by:

getClusterRecordConflictStrategy in interface OStorage

getClusterEncryption

public String getClusterEncryption(int clusterId)

Specified by:

getClusterEncryption in interface OStorage

isSystemCluster

public boolean isSystemCluster(int clusterId)

Specified by:

isSystemCluster in interface OStorage

getLastClusterPosition

public long getLastClusterPosition(int clusterId)

Specified by:

getLastClusterPosition in interface OStorage

getClusterNextPosition

public long getClusterNextPosition(int clusterId)

Specified by:

getClusterNextPosition in interface OStorage

getRecordStatus

public OPaginatedCluster.RECORD_STATUS getRecordStatus(ORID rid)

Specified by:

getRecordStatus in interface OStorage

getId

public final int getId()

Specified by:

getId in interface OIdentifiableStorage

getUuid

public UUID getUuid()

getSBtreeCollectionManager

public final OSBTreeCollectionManager getSBtreeCollectionManager()

Specified by:

getSBtreeCollectionManager in interface OStorage

getReadCache

public OReadCache getReadCache()

getWriteCache

public OWriteCache getWriteCache()

count

public final long count(int iClusterId)

Specified by:

count in interface OStorage

count

public final long count(int clusterId,
 boolean countTombstones)

Specified by:

count in interface OStorage

getClusterDataRange

public final long[] getClusterDataRange(int iClusterId)

Description copied from interface: OStorage

Returns a pair of long values telling the begin and end positions of data in the requested cluster. Useful to know the range of the records.

Specified by:

getClusterDataRange in interface OStorage

Parameters:

iClusterId - Cluster id

getLSN

public OLogSequenceNumber getLSN()

count

public final long count(int[] iClusterIds)

Specified by:

count in interface OStorage

onException

public final void onException(Throwable e)

Specified by:

onException in interface OBackgroundExceptionListener

extractTransactionsFromWal

public Optional<OBackgroundNewDelta> extractTransactionsFromWal(List<OTransactionId> transactionsMetadata)

count

public final long count(int[] iClusterIds,
 boolean countTombstones)

Specified by:

count in interface OStorage

createRecord

public final OStorageOperationResult<OPhysicalPosition> createRecord(ORecordId rid,
 byte[] content,
 int recordVersion,
 byte recordType,
 ORecordCallback<Long> callback)

getRecordMetadata

public final ORecordMetadata getRecordMetadata(ORID rid)

Specified by:

getRecordMetadata in interface OStorage

isDeleted

public boolean isDeleted(ORID rid)

browseCluster

public Iterator<OClusterBrowsePage> browseCluster(int clusterId)

readRecord

public OStorageOperationResult<ORawBuffer> readRecord(ORecordId rid,
 String iFetchPlan,
 boolean iIgnoreCache,
 boolean prefetchRecords,
 ORecordCallback<ORawBuffer> iCallback)

Specified by:

readRecord in interface OStorage

readRecordIfVersionIsNotLatest

public final OStorageOperationResult<ORawBuffer> readRecordIfVersionIsNotLatest(ORecordId rid,
 String fetchPlan,
 boolean ignoreCache,
 int recordVersion)
                                                                         throws ORecordNotFoundException

Specified by:

readRecordIfVersionIsNotLatest in interface OStorage

Throws:

ORecordNotFoundException

updateRecord

public final OStorageOperationResult<Integer> updateRecord(ORecordId rid,
 boolean updateContent,
 byte[] content,
 int version,
 byte recordType,
 int mode,
 ORecordCallback<Integer> callback)

getAtomicOperationsManager

public final OAtomicOperationsManager getAtomicOperationsManager()

getWALInstance

public OWriteAheadLog getWALInstance()

getIdGen

public AtomicOperationIdGen getIdGen()

deleteRecord

public final OStorageOperationResult<Boolean> deleteRecord(ORecordId rid,
 int version,
 int mode,
 ORecordCallback<Boolean> callback)

Specified by:

deleteRecord in interface OStorage

getClusterNames

public final Set<String> getClusterNames()

Specified by:

getClusterNames in interface OStorage

Specified by:

getClusterNames in interface OStorageInfo

getClusterIdByName

public final int getClusterIdByName(String clusterName)

Specified by:

getClusterIdByName in interface OStorage

Specified by:

getClusterIdByName in interface OStorageInfo

preallocateRids

public void preallocateRids(OTransactionInternal clientTx)

Scan the given transaction for new record and allocate a record id for them, the relative record id is inserted inside the transaction for future use.

Parameters:

clientTx - the transaction of witch allocate rids

commit

public List<ORecordOperation> commit(OTransactionInternal clientTx)

Traditional commit that support already temporary rid and already assigned rids

Specified by:

commit in interface OStorage

Parameters:

clientTx - the transaction to commit

Returns:

The list of operations applied by the transaction

commitPreAllocated

public List<ORecordOperation> commitPreAllocated(OTransactionInternal clientTx)

Commit a transaction where the rid where pre-allocated in a previous phase

Parameters:

clientTx - the pre-allocated transaction to commit

Returns:

The list of operations applied by the transaction

commit

protected List<ORecordOperation> commit(OTransactionInternal transaction,
 boolean allocated)

The commit operation can be run in 3 different conditions, embedded commit, pre-allocated commit, other node commit. Embedded commit is the basic commit where the operation is run in embedded or server side, the transaction arrive with invalid rids that get allocated and committed. pre-allocated commit is the commit that happen after an preAllocateRids call is done, this is usually run by the coordinator of a tx in distributed. other node commit is the commit that happen when a node execute a transaction of another node where all the rids are already allocated in the other node.

Parameters:

transaction - the transaction to commit

allocated - true if the operation is pre-allocated commit

Returns:

The list of operations applied by the transaction

loadIndexEngine

public int loadIndexEngine(String name)

loadExternalIndexEngine

public int loadExternalIndexEngine(OIndexMetadata indexMetadata,
 Map<String,String> engineProperties)

addIndexEngine

public int addIndexEngine(OIndexMetadata indexMetadata,
 Map<String,String> engineProperties)

resolveObjectSerializer

public OBinarySerializer<?> resolveObjectSerializer(byte serializerId)

loadEncryption

public static OEncryption loadEncryption(String cfgEncryption,
 String cfgEncryptionKey)

extractEngineAPIVersion

public static int extractEngineAPIVersion(int externalId)

deleteIndexEngine

public void deleteIndexEngine(int indexId)
                       throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

removeKeyFromIndex

public boolean removeKeyFromIndex(int indexId,
 Object key)
                           throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

clearIndex

public void clearIndex(int indexId)
                throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexValue

public Object getIndexValue(int indexId,
 Object key)
                     throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexValues

public Stream<ORID> getIndexValues(int indexId,
 Object key)
                            throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexEngine

public OBaseIndexEngine getIndexEngine(int indexId)
                                throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

updateIndexEntry

public void updateIndexEntry(int indexId,
 Object key,
 OIndexKeyUpdater<Object> valueCreator)
                      throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

callIndexEngine

public <T> T callIndexEngine(boolean readOperation,
 int indexId,
 OIndexEngineCallback<T> callback)
                      throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

putRidIndexEntry

public void putRidIndexEntry(int indexId,
 Object key,
 ORID value)
                      throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

removeRidIndexEntry

public boolean removeRidIndexEntry(int indexId,
 Object key,
 ORID value)
                            throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

putIndexValue

public void putIndexValue(int indexId,
 Object key,
 Object value)
                   throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

validatedPutIndexValue

public boolean validatedPutIndexValue(int indexId,
 Object key,
 ORID value,
 IndexEngineValidator<Object,ORID> validator)
                               throws OInvalidIndexEngineIdException

Puts the given value under the given key into this storage for the index with the given index id. Validates the operation using the provided validator.

Parameters:

indexId - the index id of the index to put the value into.

key - the key to put the value under.

value - the value to put.

validator - the operation validator.

Returns:

true if the validator allowed the put, false otherwise.

Throws:

OInvalidIndexEngineIdException

See Also:

• IndexEngineValidator.validate(Object, Object, Object)

iterateIndexEntriesBetween

public Stream<ORawPair<Object,ORID>> iterateIndexEntriesBetween(int indexId,
 Object rangeFrom,
 boolean fromInclusive,
 Object rangeTo,
 boolean toInclusive,
 boolean ascSortOrder,
 IndexEngineValuesTransformer transformer)
                                                         throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesMajor

public Stream<ORawPair<Object,ORID>> iterateIndexEntriesMajor(int indexId,
 Object fromKey,
 boolean isInclusive,
 boolean ascSortOrder,
 IndexEngineValuesTransformer transformer)
                                                       throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesMinor

public Stream<ORawPair<Object,ORID>> iterateIndexEntriesMinor(int indexId,
 Object toKey,
 boolean isInclusive,
 boolean ascSortOrder,
 IndexEngineValuesTransformer transformer)
                                                       throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexStream

public Stream<ORawPair<Object,ORID>> getIndexStream(int indexId,
 IndexEngineValuesTransformer valuesTransformer)
                                             throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexDescStream

public Stream<ORawPair<Object,ORID>> getIndexDescStream(int indexId,
 IndexEngineValuesTransformer valuesTransformer)
                                                 throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexKeyStream

public Stream<Object> getIndexKeyStream(int indexId)
                                 throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexSize

public long getIndexSize(int indexId,
 IndexEngineValuesTransformer transformer)
                  throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

hasIndexRangeQuerySupport

public boolean hasIndexRangeQuerySupport(int indexId)
                                  throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

moveToErrorStateIfNeeded

public void moveToErrorStateIfNeeded(Throwable error)

checkForRecordValidity

public final boolean checkForRecordValidity(OPhysicalPosition ppos)

Specified by:

checkForRecordValidity in interface OStorage

synch

public final void synch()

Specified by:

synch in interface OStorage

getPhysicalClusterNameById

public final String getPhysicalClusterNameById(int iClusterId)

Specified by:

getPhysicalClusterNameById in interface OStorage

Specified by:

getPhysicalClusterNameById in interface OStorageInfo

getDefaultClusterId

public final int getDefaultClusterId()

Specified by:

getDefaultClusterId in interface OStorageInfo

setDefaultClusterId

public final void setDefaultClusterId(int defaultClusterId)

Specified by:

setDefaultClusterId in interface OStorage

getClusterName

public String getClusterName(int clusterId)

Specified by:

getClusterName in interface OStorage

getSize

public final long getSize()

Description copied from interface: OStorage

Returns the size of the database.

Specified by:

getSize in interface OStorage

getClusters

public final int getClusters()

Specified by:

getClusters in interface OStorageInfo

getClusterInstances

public final Set<OCluster> getClusterInstances()

Specified by:

getClusterInstances in interface OStorage

cleanOutRecord

public final boolean cleanOutRecord(ORecordId recordId,
 int recordVersion,
 int iMode,
 ORecordCallback<Boolean> callback)

Specified by:

cleanOutRecord in interface OStorage

freeze

public final void freeze(boolean throwException)

Description copied from interface: OFreezableStorageComponent

After this method finished it's execution, all threads that are going to perform data modifications in storage should wait till OFreezableStorageComponent.release() method will be called. This method will wait till all ongoing modifications will be finished.

Specified by:

freeze in interface OFreezableStorageComponent

Parameters:

throwException - If true OModificationOperationProhibitedException exception will be thrown on call of methods that requires storage modification. Otherwise other threads will wait for OFreezableStorageComponent.release() method call.

release

public final void release()

Description copied from interface: OFreezableStorageComponent

After this method finished execution all threads that are waiting to perform data modifications in storage will be awaken and will be allowed to continue their execution.

Specified by:

release in interface OFreezableStorageComponent

isRemote

public final boolean isRemote()

Specified by:

isRemote in interface OStorage

wereDataRestoredAfterOpen

public boolean wereDataRestoredAfterOpen()

wereNonTxOperationsPerformedInPreviousOpen

public boolean wereNonTxOperationsPerformedInPreviousOpen()

reload

public final void reload()

Specified by:

reload in interface OStorage

getMode

public String getMode()

pageIsBroken

public final void pageIsBroken(String fileName,
 long pageIndex)

Description copied from interface: OPageIsBrokenListener

Method is called by write cache when it is detected that data page in file is broken.

Specified by:

pageIsBroken in interface OPageIsBrokenListener

Parameters:

fileName - Name of broken file.

pageIndex - Index of page which is broken in file.

requestCheckpoint

public final void requestCheckpoint()

Specified by:

requestCheckpoint in interface OCheckpointRequestListener

command

public final Object command(OCommandRequestText iCommand)

Executes the command request and return the result back.

Specified by:

command in interface OStorage

executeCommand

public final Object executeCommand(OCommandRequestText iCommand,
 OCommandExecutor executor)

higherPhysicalPositions

public final OPhysicalPosition[] higherPhysicalPositions(int currentClusterId,
 OPhysicalPosition physicalPosition)

Specified by:

higherPhysicalPositions in interface OStorage

ceilingPhysicalPositions

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

Specified by:

ceilingPhysicalPositions in interface OStorage

lowerPhysicalPositions

public final OPhysicalPosition[] lowerPhysicalPositions(int currentClusterId,
 OPhysicalPosition physicalPosition)

Specified by:

lowerPhysicalPositions in interface OStorage

floorPhysicalPositions

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

Specified by:

floorPhysicalPositions in interface OStorage

acquireWriteLock

public void acquireWriteLock(ORID rid,
 long timeout)

acquireWriteLock

public final void acquireWriteLock(ORID rid)

releaseWriteLock

public final void releaseWriteLock(ORID rid)

acquireReadLock

public final void acquireReadLock(ORID rid)

acquireReadLock

public void acquireReadLock(ORID rid,
 long timeout)

releaseReadLock

public final void releaseReadLock(ORID rid)

getRecordConflictStrategy

public final ORecordConflictStrategy getRecordConflictStrategy()

Specified by:

getRecordConflictStrategy in interface OStorage

Specified by:

getRecordConflictStrategy in interface OStorageInfo

setConflictStrategy

public final void setConflictStrategy(ORecordConflictStrategy conflictResolver)

Specified by:

setConflictStrategy in interface OStorage

getRecordScanned

public long getRecordScanned()

copyWALToIncrementalBackup

protected abstract OLogSequenceNumber copyWALToIncrementalBackup(ZipOutputStream zipOutputStream,
 long startSegment)
                                                          throws IOException

Throws:

IOException

isWriteAllowedDuringIncrementalBackup

protected abstract boolean isWriteAllowedDuringIncrementalBackup()

getRecoverListener

public OStorageRecoverListener getRecoverListener()

registerRecoverListener

public void registerRecoverListener(OStorageRecoverListener recoverListener)

unregisterRecoverListener

public void unregisterRecoverListener(OStorageRecoverListener recoverListener)

createWalTempDirectory

protected abstract File createWalTempDirectory()

addFileToDirectory

protected abstract void addFileToDirectory(String name,
 InputStream stream,
 File directory)
                                    throws IOException

Throws:

IOException

createWalFromIBUFiles

protected abstract OWriteAheadLog createWalFromIBUFiles(File directory,
 OContextConfiguration contextConfiguration,
 Locale locale,
 byte[] iv)
                                                 throws IOException

Throws:

IOException

checkOpennessAndMigration

protected final void checkOpennessAndMigration()

Checks if the storage is open. If it's closed an exception is raised.

isInError

protected boolean isInError()

checkErrorState

public void checkErrorState()

makeFuzzyCheckpoint

public final void makeFuzzyCheckpoint()

deleteTreeRidBag

public void deleteTreeRidBag(OSBTreeRidBag ridBag)

flushAllData

protected void flushAllData()

checkIfStorageDirty

protected OStartupMetadata checkIfStorageDirty()
                                        throws IOException

Throws:

IOException

initConfiguration

protected void initConfiguration(OAtomicOperation atomicOperation,
 OContextConfiguration contextConfiguration)
                          throws IOException

Throws:

IOException

postCreateSteps

protected final void postCreateSteps()

preCreateSteps

protected void preCreateSteps()
                       throws IOException

Throws:

IOException

initWalAndDiskCache

protected abstract void initWalAndDiskCache(OContextConfiguration contextConfiguration)
                                     throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

postCloseSteps

protected abstract void postCloseSteps(boolean onDelete,
 boolean internalError,
 long lastTxId)
                                throws IOException

Throws:

IOException

postCloseStepsAfterLock

protected void postCloseStepsAfterLock(Map<String,Object> params)

preCloseSteps

protected Map<String,Object> preCloseSteps()

postDeleteSteps

protected void postDeleteSteps()

makeStorageDirty

protected void makeStorageDirty()
                         throws IOException

Throws:

IOException

clearStorageDirty

protected void clearStorageDirty()
                          throws IOException

Throws:

IOException

isDirty

protected boolean isDirty()

getOpenedAtVersion

protected String getOpenedAtVersion()

metadataOnly

public void metadataOnly(byte[] metadata)

setClusterAttribute

public boolean setClusterAttribute(int id,
 OCluster.ATTRIBUTES attribute,
 Object value)

Specified by:

setClusterAttribute in interface OStorage

closeClusters

protected void closeClusters(boolean onDelete)
                      throws IOException

Throws:

IOException

closeIndexes

protected void closeIndexes(OAtomicOperation atomicOperation,
 boolean onDelete)

incrementalBackup

public String incrementalBackup(String backupDirectory,
 OCallable<Void,Void> started)
                         throws UnsupportedOperationException

Specified by:

incrementalBackup in interface OStorage

Returns:

Backup file name

Throws:

UnsupportedOperationException

supportIncremental

public boolean supportIncremental()

Specified by:

supportIncremental in interface OStorage

fullIncrementalBackup

public void fullIncrementalBackup(OutputStream stream)
                           throws UnsupportedOperationException

Specified by:

fullIncrementalBackup in interface OStorage

Throws:

UnsupportedOperationException

restoreFromIncrementalBackup

public void restoreFromIncrementalBackup(String filePath)

Specified by:

restoreFromIncrementalBackup in interface OStorage

restoreFullIncrementalBackup

public void restoreFullIncrementalBackup(InputStream stream)
                                  throws UnsupportedOperationException

Specified by:

restoreFullIncrementalBackup in interface OStorage

Throws:

UnsupportedOperationException

restoreFrom

protected OLogSequenceNumber restoreFrom(OWriteAheadLog writeAheadLog,
 OLogSequenceNumber lsn)
                                  throws IOException

Throws:

IOException

restoreAtomicUnit

protected final boolean restoreAtomicUnit(List<OWALRecord> atomicUnit,
 OModifiableBoolean atLeastOnePageUpdate)
                                   throws IOException

Throws:

IOException

setStorageConfigurationUpdateListener

public void setStorageConfigurationUpdateListener(OStorageConfigurationUpdateListener storageConfigurationUpdateListener)

pauseConfigurationUpdateNotifications

public void pauseConfigurationUpdateNotifications()

fireConfigurationUpdateNotifications

public void fireConfigurationUpdateNotifications()

getRidsGroupedByCluster

protected static Map<Integer,List<ORecordId>> getRidsGroupedByCluster(Collection<ORecordId> rids)

logAndPrepareForRethrow

protected final RuntimeException logAndPrepareForRethrow(RuntimeException runtimeException)

logAndPrepareForRethrow

protected RuntimeException logAndPrepareForRethrow(RuntimeException runtimeException,
 boolean putInReadOnlyMode)

logAndPrepareForRethrow

protected final Error logAndPrepareForRethrow(Error error)

logAndPrepareForRethrow

protected Error logAndPrepareForRethrow(Error error,
 boolean putInReadOnlyMode)

logAndPrepareForRethrow

protected final RuntimeException logAndPrepareForRethrow(Throwable throwable)

logAndPrepareForRethrow

protected RuntimeException logAndPrepareForRethrow(Throwable throwable,
 boolean putInReadOnlyMode)

getConfiguration

public final OStorageConfiguration getConfiguration()

Specified by:

getConfiguration in interface OStorageInfo

setSchemaRecordId

public final void setSchemaRecordId(String schemaRecordId)

Specified by:

setSchemaRecordId in interface OStorage

setDateFormat

public final void setDateFormat(String dateFormat)

Specified by:

setDateFormat in interface OStorage

setTimeZone

public final void setTimeZone(TimeZone timeZoneValue)

Specified by:

setTimeZone in interface OStorage

setLocaleLanguage

public final void setLocaleLanguage(String locale)

Specified by:

setLocaleLanguage in interface OStorage

setCharset

public final void setCharset(String charset)

Specified by:

setCharset in interface OStorage

setIndexMgrRecordId

public final void setIndexMgrRecordId(String indexMgrRecordId)

Specified by:

setIndexMgrRecordId in interface OStorage

setDateTimeFormat

public final void setDateTimeFormat(String dateTimeFormat)

Specified by:

setDateTimeFormat in interface OStorage

setLocaleCountry

public final void setLocaleCountry(String localeCountry)

Specified by:

setLocaleCountry in interface OStorage

setClusterSelection

public final void setClusterSelection(String clusterSelection)

Specified by:

setClusterSelection in interface OStorage

setMinimumClusters

public final void setMinimumClusters(int minimumClusters)

Specified by:

setMinimumClusters in interface OStorage

setValidation

public final void setValidation(boolean validation)

Specified by:

setValidation in interface OStorage

removeProperty

public final void removeProperty(String property)

Specified by:

removeProperty in interface OStorage

setProperty

public final void setProperty(String property,
 String value)

Specified by:

setProperty in interface OStorage

setRecordSerializer

public final void setRecordSerializer(String recordSerializer,
 int version)

Specified by:

setRecordSerializer in interface OStorage

clearProperties

public final void clearProperties()

Specified by:

clearProperties in interface OStorage

getLastMetadata

public Optional<byte[]> getLastMetadata()

incOnOpen

public void incOnOpen()

getSessionCount

public int getSessionCount()

getLastCloseTime

public long getLastCloseTime()

getVersionForKey

public int getVersionForKey(String indexName,
 Object key)

getClustersIds

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

Specified by:

getClustersIds in interface OStorage

checkBackupRunning

protected abstract void checkBackupRunning()

startDDL

public void startDDL()

endDDL

public void endDDL()

getContext

public OrientDBInternal getContext()

Specified by:

getContext in interface OStorage

isMemory

public boolean isMemory()