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

Class OAbstractPaginatedStorage

java.lang.Object

com.orientechnologies.orient.core.storage.OStorageAbstract

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

All Implemented Interfaces:

OSharedContainer, OOrientShutdownListener, OOrientStartupListener, OBackgroundExceptionListener, OFullCheckpointRequestListener, OLowDiskSpaceListener, OPageIsBrokenListener, OIdentifiableStorage, OStorage, OBackupable

Direct Known Subclasses:

ODirectMemoryStorage, OLocalPaginatedStorage

public abstract class OAbstractPaginatedStorage
extends OStorageAbstract
implements OLowDiskSpaceListener, OFullCheckpointRequestListener, OIdentifiableStorage, OOrientStartupListener, OOrientShutdownListener, OBackgroundExceptionListener, OPageIsBrokenListener

Since:

28.03.13

Author:

Andrey Lomakin

Nested Class Summary

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

OStorage.LOCKING_STRATEGY, OStorage.SIZE, OStorage.STATUS

Field Summary

Fields

Modifier and Type	Field and Description
protected OAtomicOperationsManager	atomicOperationsManager
protected OReadCache	readCache
protected OSBTreeCollectionManagerShared	sbTreeCollectionManager
protected OWriteAheadLog	writeAheadLog
protected OWriteCache	writeCache

Fields inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

componentsFactory, configuration, mode, name, sharedContainer, stateLock, status, storageThreadGroup, url, version

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

CLUSTER_DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
OAbstractPaginatedStorage(String name, String filePath, String mode, int id)

Method Summary

Modifier and Type	Method and Description
void	acquireReadLock(ORID rid)
void	acquireWriteLock(ORID rid)
int	addCluster(String clusterName, boolean forceListBased, Object... parameters) Add a new cluster into the storage.
int	addCluster(String clusterName, int requestedId, boolean forceListBased, Object... parameters) Add a new cluster into the storage.
protected abstract void	addFileToDirectory(String name, InputStream stream, File directory)
int	addIndexEngine(String engineName, String algorithm, String indexType, OIndexDefinition indexDefinition, OBinarySerializer valueSerializer, boolean isAutomatic, Boolean durableInNonTxMode, int version, Map<String,String> engineProperties, Set<String> clustersToIndex, ODocument metadata)
<T> T	callIndexEngine(boolean atomicOperation, boolean readOperation, int indexId, OIndexEngineCallback<T> callback)
<V> V	callInLock(Callable<V> iCallable, boolean iExclusiveLock)
void	cancelIndexRebuild()
OPhysicalPosition[]	ceilingPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
boolean	check(boolean verbose, OCommandOutputListener listener)
int	checkClustersConsistency()
boolean	checkForRecordValidity(OPhysicalPosition ppos)
protected void	checkOpeness() Checks if the storage is open.
boolean	cleanOutRecord(ORecordId recordId, int recordVersion, int iMode, ORecordCallback<Boolean> callback)
void	clearIndex(int indexId)
void	clearProperties()
protected void	clearStorageDirty()
void	close(boolean force, boolean onDelete)
protected void	closeClusters(boolean onDelete)
protected void	closeIndexes(boolean onDelete)
Object	command(OCommandRequestText iCommand) Executes the command request and return the result back.
List<ORecordOperation>	commit(OTransaction clientTx, Runnable callback)
void	compactCluster(String clusterName)
OSessionStoragePerformanceStatistic	completeGatheringPerformanceStatisticForCurrentThread() Completes gathering performance characteristics for current thread initiated by call of startGatheringPerformanceStatisticForCurrentThread()
protected abstract OLogSequenceNumber	copyWALToIncrementalBackup(ZipOutputStream zipOutputStream, long startSegment)
long	count(int iClusterId)
long	count(int[] iClusterIds)
long	count(int[] iClusterIds, boolean countTombstones)
long	count(int clusterId, boolean countTombstones)
void	create(Map<String,Object> iProperties)
OStorageOperationResult<OPhysicalPosition>	createRecord(ORecordId rid, byte[] content, int recordVersion, byte recordType, int mode, ORecordCallback<Long> callback)
protected abstract OWriteAheadLog	createWalFromIBUFiles(File directory)
protected abstract File	createWalTempDirectory()
void	delete()
void	deleteIndexEngine(int indexId)
OStorageOperationResult<Boolean>	deleteRecord(ORecordId rid, int version, int mode, ORecordCallback<Boolean> callback)
boolean	dropCluster(int clusterId, boolean iTruncate) Drops a cluster.
Object	executeCommand(OCommandRequestText iCommand, OCommandExecutor executor)
OPhysicalPosition[]	floorPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
void	freeze(boolean throwException)
OAtomicOperationsManager	getAtomicOperationsManager()
OCluster	getClusterById(int iClusterId)
OCluster	getClusterByName(String clusterName)
long[]	getClusterDataRange(int iClusterId) Returns a pair of long values telling the begin and end positions of data in the requested cluster.
int	getClusterIdByName(String clusterName)
Set<OCluster>	getClusterInstances()
Set<String>	getClusterNames()
int	getClusters()
ORecordConflictStrategy	getConflictStrategy()
int	getDefaultClusterId()
long	getFullCheckpointCount()
int	getId()
OIndexCursor	getIndexCursor(int indexId, OIndexEngine.ValuesTransformer valuesTransformer)
OIndexCursor	getIndexDescCursor(int indexId, OIndexEngine.ValuesTransformer valuesTransformer)
OIndexEngine	getIndexEngine(int indexId)
Object	getIndexFirstKey(int indexId)
OIndexKeyCursor	getIndexKeyCursor(int indexId)
Object	getIndexLastKey(int indexId)
long	getIndexSize(int indexId, OIndexEngine.ValuesTransformer transformer)
Object	getIndexValue(int indexId, Object key)
OLogSequenceNumber	getLSN()
String	getMode()
OPerformanceStatisticManager	getPerformanceStatisticManager()
String	getPhysicalClusterNameById(int iClusterId)
OReadCache	getReadCache()
ORecordMetadata	getRecordMetadata(ORID rid)
AtomicLong	getRecordScanned()
OStorageRecoverListener	getRecoverListener()
protected Map<Integer,List<ORecordId>>	getRidsGroupedByCluster(Collection<ORecordId> iRids)
OSBTreeCollectionManager	getSBtreeCollectionManager()
long	getSize() Returns the size of the database.
OStorageTransaction	getStorageTransaction()
OWriteAheadLog	getWALInstance()
OWriteCache	getWriteCache()
boolean	hasIndexRangeQuerySupport(int indexId)
OStorageOperationResult<Boolean>	hideRecord(ORecordId rid, int mode, ORecordCallback<Boolean> callback)
OPhysicalPosition[]	higherPhysicalPositions(int currentClusterId, OPhysicalPosition physicalPosition)
String	incrementalBackup(String backupDirectory)
boolean	indexContainsKey(int indexId, Object key)
protected abstract void	initWalAndDiskCache()
boolean	isClosed()
protected boolean	isDirty()
boolean	isFrozen()
boolean	isIndexRebuildScheduled()
protected boolean	isIndexRebuildScheduledInternal()
boolean	isRemote()
protected abstract boolean	isWriteAllowedDuringIncrementalBackup()
OIndexCursor	iterateIndexEntriesBetween(int indexId, Object rangeFrom, boolean fromInclusive, Object rangeTo, boolean toInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateIndexEntriesMajor(int indexId, Object fromKey, boolean isInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)
OIndexCursor	iterateIndexEntriesMinor(int indexId, Object toKey, boolean isInclusive, boolean ascSortOrder, OIndexEngine.ValuesTransformer transformer)
int	loadExternalIndexEngine(String engineName, String algorithm, String indexType, OIndexDefinition indexDefinition, OBinarySerializer valueSerializer, boolean isAutomatic, Boolean durableInNonTxMode, int version, Map<String,String> engineProperties)
int	loadIndexEngine(String name)
protected Error	logAndPrepareForRethrow(Error error)
protected RuntimeException	logAndPrepareForRethrow(RuntimeException runtimeException)
protected RuntimeException	logAndPrepareForRethrow(Throwable throwable)
void	lowDiskSpace(OLowDiskSpaceInformation information)
OPhysicalPosition[]	lowerPhysicalPositions(int currentClusterId, OPhysicalPosition physicalPosition)
protected void	makeFullCheckpoint()
protected void	makeStorageDirty()
void	onException(Throwable e)
void	onShutdown()
void	onStartup()
void	open(OToken iToken, Map<String,Object> iProperties)
void	open(String iUserName, String iUserPassword, Map<String,Object> iProperties)
protected void	openClusters()
protected void	openIndexes()
void	pageIsBroken(String fileName, long pageIndex) Method is called by write cache when it is detected that data page in file is broken.
protected abstract void	postCloseSteps(boolean onDelete, boolean jvmError)
protected void	postCreateSteps()
protected void	postDeleteSteps()
protected void	preCloseSteps()
protected void	preCreateSteps()
protected void	preOpenSteps()
void	putIndexValue(int indexId, Object key, Object value)
OStorageOperationResult<ORawBuffer>	readRecord(ORecordId iRid, String iFetchPlan, boolean iIgnoreCache, boolean prefetchRecords, ORecordCallback<ORawBuffer> iCallback)
OStorageOperationResult<ORawBuffer>	readRecordIfVersionIsNotLatest(ORecordId rid, String fetchPlan, boolean ignoreCache, int recordVersion)
Collection<OPair<ORecordId,ORawBuffer>>	readRecords(Collection<ORecordId> iRids) Returns the requested records.
OLogSequenceNumber	recordsChangedAfterLSN(OLogSequenceNumber lsn, OutputStream stream, Set<String> includeClusterNames, OCommandOutputListener outputListener) This method finds all the records which were updated starting from (but not including) current LSN and write result in provided output stream.
Set<ORecordId>	recordsChangedRecently(int maxEntries, Set<String> includeClusterNames) This method finds all the records changed in the last X transactions.
void	recyclePosition(ORecordId record, byte[] content, int recordVersion, byte recordType) Resurrects a record that was previously deleted.
void	registerRecoverListener(OStorageRecoverListener recoverListener)
void	release()
void	releaseReadLock(ORID rid)
void	releaseWriteLock(ORID rid)
void	reload()
boolean	removeKeyFromIndex(int indexId, Object key)
void	removeProperty(String property)
void	renameCluster(String oldName, String newName) Method that completes the cluster rename operation.
void	requestCheckpoint()
protected void	restoreAtomicUnit(List<OWALRecord> atomicUnit, OModifiableBoolean atLeastOnePageUpdate)
protected OLogSequenceNumber	restoreFrom(OLogSequenceNumber lsn, OWriteAheadLog writeAheadLog)
void	restoreFromIncrementalBackup(String filePath)
void	rollback(OTransaction clientTx)
protected void	scheduleIndexRebuild()
void	setCharset(String charset)
void	setClusterSelection(String clusterSelection)
boolean	setClusterStatus(int clusterId, OStorageClusterConfiguration.STATUS iStatus)
void	setConflictStrategy(ORecordConflictStrategy conflictResolver)
void	setDateFormat(String dateFormat)
void	setDateTimeFormat(String dateTimeFormat)
void	setDefaultClusterId(int defaultClusterId)
void	setIndexMgrRecordId(String indexMgrRecordId)
void	setLocaleCountry(String localeCountry)
void	setLocaleLanguage(String localeLanguage)
void	setMinimumClusters(int minimumClusters)
void	setProperty(String property, String value)
void	setRecordSerializer(String recordSerializer, int version)
void	setSchemaRecordId(String schemaRecordId)
void	setTimeZone(TimeZone timeZone)
void	setValidation(boolean validation)
void	startGatheringPerformanceStatisticForCurrentThread() Starts to gather information about storage performance for current thread.
void	synch()
void	underDistributedStorage() This method is called by distributed storage during initialization to indicate that database is used in distributed cluster configuration
void	unregisterRecoverListener(OStorageRecoverListener recoverListener)
void	updateConfiguration()
void	updateIndexEntry(int indexId, Object key, Callable<Object> valueCreator)
OStorageOperationResult<Integer>	updateRecord(ORecordId rid, boolean updateContent, byte[] content, int version, byte recordType, int mode, ORecordCallback<Integer> callback)
boolean	validatedPutIndexValue(int indexId, Object key, OIdentifiable value, OIndexEngine.Validator<Object,OIdentifiable> validator) Puts the given value under the given key into this storage for the index with the given index id.

Methods inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

checkForClusterPermissions, close, countRecords, dropCluster, existsResource, getComponentsFactory, getConfiguration, getName, getResource, getStatus, getUnderlying, getURL, getVersion, isAssigningClusterIds, isDistributed, normalizeName, removeResource, shutdown, toString

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.storage.OStorage

checkForClusterPermissions, close, countRecords, dropCluster, exists, getComponentsFactory, getConfiguration, getName, getStatus, getType, getUnderlying, getURL, getVersion, isAssigningClusterIds, isDistributed, shutdown

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

backup, restore

Methods inherited from interface com.orientechnologies.common.concur.resource.OSharedContainer

existsResource, getResource, removeResource

Field Detail

sbTreeCollectionManager

protected final OSBTreeCollectionManagerShared sbTreeCollectionManager

writeAheadLog

protected volatile OWriteAheadLog writeAheadLog

readCache

protected volatile OReadCache readCache

writeCache

protected volatile OWriteCache writeCache

atomicOperationsManager

protected volatile OAtomicOperationsManager atomicOperationsManager

Constructor Detail

OAbstractPaginatedStorage

public OAbstractPaginatedStorage(String name,
                                 String filePath,
                                 String mode,
                                 int id)

Method Detail

underDistributedStorage

public void underDistributedStorage()

This method is called by distributed storage during initialization to indicate that database is used in distributed cluster configuration

open

public void open(String iUserName,
                 String iUserPassword,
                 Map<String,Object> iProperties)

Specified by:

open in interface OStorage

openIndexes

protected void openIndexes()

openClusters

protected void openClusters()
                     throws IOException

Throws:

IOException

open

public void open(OToken iToken,
                 Map<String,Object> iProperties)

create

public void create(Map<String,Object> iProperties)

Specified by:

create in interface OStorage

isClosed

public boolean isClosed()

Specified by:

isClosed in interface OStorage

Overrides:

isClosed in class OStorageAbstract

onShutdown

public void onShutdown()

Specified by:

onShutdown in interface OOrientShutdownListener

onStartup

public void onStartup()

Specified by:

onStartup in interface OOrientStartupListener

close

public void close(boolean force,
                  boolean onDelete)

Specified by:

close in interface OStorage

Overrides:

close in class OStorageAbstract

delete

public void delete()

Specified by:

delete in interface OStorage

check

public boolean check(boolean verbose,
                     OCommandOutputListener listener)

addCluster

public int addCluster(String clusterName,
                      boolean forceListBased,
                      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

compactCluster

public void compactCluster(String clusterName)

addCluster

public int addCluster(String clusterName,
                      int requestedId,
                      boolean forceListBased,
                      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

requestedId - requested id of the cluster

dropCluster

public boolean dropCluster(int clusterId,
                           boolean iTruncate)

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

getId

public int getId()

Specified by:

getId in interface OIdentifiableStorage

setClusterStatus

public boolean setClusterStatus(int clusterId,
                                OStorageClusterConfiguration.STATUS iStatus)

getSBtreeCollectionManager

public OSBTreeCollectionManager getSBtreeCollectionManager()

Specified by:

getSBtreeCollectionManager in interface OStorage

getReadCache

public OReadCache getReadCache()

getWriteCache

public OWriteCache getWriteCache()

count

public long count(int iClusterId)

Specified by:

count in interface OStorage

count

public long count(int clusterId,
                  boolean countTombstones)

Specified by:

count in interface OStorage

getClusterDataRange

public 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 long count(int[] iClusterIds)

Specified by:

count in interface OStorage

recordsChangedAfterLSN

public OLogSequenceNumber recordsChangedAfterLSN(OLogSequenceNumber lsn,
                                                 OutputStream stream,
                                                 Set<String> includeClusterNames,
                                                 OCommandOutputListener outputListener)

This method finds all the records which were updated starting from (but not including) current LSN and write result in provided output stream. In output stream will be included all thw records which were updated/deleted/created since passed in LSN till the current moment. Deleted records are written in output stream first, then created/updated records. All records are sorted by record id. Data format:

1. Amount of records (single entry) - 8 bytes
2. Record's cluster id - 4 bytes
3. Record's cluster position - 8 bytes
4. Delete flag, 1 if record is deleted - 1 byte
5. Record version , only if record is not deleted - 4 bytes
6. Record type, only if record is not deleted - 1 byte
7. Length of binary presentation of record, only if record is not deleted - 4 bytes
8. Binary presentation of the record, only if record is not deleted - length of content is provided in above entity

Parameters:

lsn - LSN from which we should find changed records

stream - Stream which will contain found records

includeClusterNames - Array of cluster ids to include from the export

Returns:

Last LSN processed during examination of changed records, or null if it was impossible to find changed records: write ahead log is absent, record with start LSN was not found in WAL, etc.

See Also:

OGlobalConfiguration.STORAGE_TRACK_CHANGED_RECORDS_IN_WAL

recordsChangedRecently

public Set<ORecordId> recordsChangedRecently(int maxEntries,
                                             Set<String> includeClusterNames)

This method finds all the records changed in the last X transactions.

Parameters:

maxEntries - Maximum number of entries to check back from last log.

Returns:

A set of record ids of the changed records

See Also:

OGlobalConfiguration.STORAGE_TRACK_CHANGED_RECORDS_IN_WAL

count

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

Specified by:

count in interface OStorage

createRecord

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

Specified by:

createRecord in interface OStorage

getRecordMetadata

public ORecordMetadata getRecordMetadata(ORID rid)

Specified by:

getRecordMetadata in interface OStorage

readRecord

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

Specified by:

readRecord in interface OStorage

readRecordIfVersionIsNotLatest

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

Specified by:

readRecordIfVersionIsNotLatest in interface OStorage

Throws:

ORecordNotFoundException

updateRecord

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

Specified by:

updateRecord in interface OStorage

recyclePosition

public void recyclePosition(ORecordId record,
                            byte[] content,
                            int recordVersion,
                            byte recordType)

Description copied from interface: OStorage

Resurrects a record that was previously deleted.

Specified by:

recyclePosition in interface OStorage

getStorageTransaction

public OStorageTransaction getStorageTransaction()

getAtomicOperationsManager

public OAtomicOperationsManager getAtomicOperationsManager()

getWALInstance

public OWriteAheadLog getWALInstance()

deleteRecord

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

Specified by:

deleteRecord in interface OStorage

hideRecord

public OStorageOperationResult<Boolean> hideRecord(ORecordId rid,
                                                   int mode,
                                                   ORecordCallback<Boolean> callback)

Specified by:

hideRecord in interface OStorage

getPerformanceStatisticManager

public OPerformanceStatisticManager getPerformanceStatisticManager()

startGatheringPerformanceStatisticForCurrentThread

public void startGatheringPerformanceStatisticForCurrentThread()

Starts to gather information about storage performance for current thread. Details which performance characteristics are gathered can be found at OSessionStoragePerformanceStatistic.

See Also:

completeGatheringPerformanceStatisticForCurrentThread()

completeGatheringPerformanceStatisticForCurrentThread

public OSessionStoragePerformanceStatistic completeGatheringPerformanceStatisticForCurrentThread()

Completes gathering performance characteristics for current thread initiated by call of startGatheringPerformanceStatisticForCurrentThread()

Returns:

Performance statistic gathered after call of startGatheringPerformanceStatisticForCurrentThread() or null if profiling of storage was not started.

callInLock

public <V> V callInLock(Callable<V> iCallable,
                        boolean iExclusiveLock)

Specified by:

callInLock in interface OStorage

Overrides:

callInLock in class OStorageAbstract

getClusterNames

public Set<String> getClusterNames()

Specified by:

getClusterNames in interface OStorage

getClusterIdByName

public int getClusterIdByName(String clusterName)

Specified by:

getClusterIdByName in interface OStorage

commit

public List<ORecordOperation> commit(OTransaction clientTx,
                                     Runnable callback)

Specified by:

commit in interface OStorage

loadIndexEngine

public int loadIndexEngine(String name)

loadExternalIndexEngine

public int loadExternalIndexEngine(String engineName,
                                   String algorithm,
                                   String indexType,
                                   OIndexDefinition indexDefinition,
                                   OBinarySerializer valueSerializer,
                                   boolean isAutomatic,
                                   Boolean durableInNonTxMode,
                                   int version,
                                   Map<String,String> engineProperties)

addIndexEngine

public int addIndexEngine(String engineName,
                          String algorithm,
                          String indexType,
                          OIndexDefinition indexDefinition,
                          OBinarySerializer valueSerializer,
                          boolean isAutomatic,
                          Boolean durableInNonTxMode,
                          int version,
                          Map<String,String> engineProperties,
                          Set<String> clustersToIndex,
                          ODocument metadata)

deleteIndexEngine

public void deleteIndexEngine(int indexId)
                       throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

indexContainsKey

public boolean indexContainsKey(int indexId,
                                Object key)
                         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

getIndexEngine

public OIndexEngine getIndexEngine(int indexId)
                            throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

updateIndexEntry

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

Throws:

OInvalidIndexEngineIdException

callIndexEngine

public <T> T callIndexEngine(boolean atomicOperation,
                             boolean readOperation,
                             int indexId,
                             OIndexEngineCallback<T> callback)
                      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,
                                      OIdentifiable value,
                                      OIndexEngine.Validator<Object,OIdentifiable> 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:

OIndexEngine.Validator#validate(Object, Object, Object)

getIndexFirstKey

public Object getIndexFirstKey(int indexId)
                        throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexLastKey

public Object getIndexLastKey(int indexId)
                       throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesBetween

public OIndexCursor iterateIndexEntriesBetween(int indexId,
                                               Object rangeFrom,
                                               boolean fromInclusive,
                                               Object rangeTo,
                                               boolean toInclusive,
                                               boolean ascSortOrder,
                                               OIndexEngine.ValuesTransformer transformer)
                                        throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesMajor

public OIndexCursor iterateIndexEntriesMajor(int indexId,
                                             Object fromKey,
                                             boolean isInclusive,
                                             boolean ascSortOrder,
                                             OIndexEngine.ValuesTransformer transformer)
                                      throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesMinor

public OIndexCursor iterateIndexEntriesMinor(int indexId,
                                             Object toKey,
                                             boolean isInclusive,
                                             boolean ascSortOrder,
                                             OIndexEngine.ValuesTransformer transformer)
                                      throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexCursor

public OIndexCursor getIndexCursor(int indexId,
                                   OIndexEngine.ValuesTransformer valuesTransformer)
                            throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexDescCursor

public OIndexCursor getIndexDescCursor(int indexId,
                                       OIndexEngine.ValuesTransformer valuesTransformer)
                                throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexKeyCursor

public OIndexKeyCursor getIndexKeyCursor(int indexId)
                                  throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexSize

public long getIndexSize(int indexId,
                         OIndexEngine.ValuesTransformer transformer)
                  throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

hasIndexRangeQuerySupport

public boolean hasIndexRangeQuerySupport(int indexId)
                                  throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

rollback

public void rollback(OTransaction clientTx)

Specified by:

rollback in interface OStorage

checkForRecordValidity

public boolean checkForRecordValidity(OPhysicalPosition ppos)

Specified by:

checkForRecordValidity in interface OStorage

Overrides:

checkForRecordValidity in class OStorageAbstract

synch

public void synch()

Specified by:

synch in interface OStorage

getPhysicalClusterNameById

public String getPhysicalClusterNameById(int iClusterId)

Specified by:

getPhysicalClusterNameById in interface OStorage

getDefaultClusterId

public int getDefaultClusterId()

Specified by:

getDefaultClusterId in interface OStorage

setDefaultClusterId

public void setDefaultClusterId(int defaultClusterId)

Specified by:

setDefaultClusterId in interface OStorage

getClusterById

public OCluster getClusterById(int iClusterId)

Specified by:

getClusterById in interface OStorage

getClusterByName

public OCluster getClusterByName(String clusterName)

Specified by:

getClusterByName in interface OStorage

Specified by:

getClusterByName in class OStorageAbstract

getSize

public long getSize()

Description copied from interface: OStorage

Returns the size of the database.

Specified by:

getSize in interface OStorage

getClusters

public int getClusters()

Specified by:

getClusters in interface OStorage

getClusterInstances

public Set<OCluster> getClusterInstances()

Specified by:

getClusterInstances in interface OStorage

renameCluster

public void renameCluster(String oldName,
                          String newName)

Method that completes the cluster rename operation. IT WILL NOT RENAME A CLUSTER, IT JUST CHANGES THE NAME IN THE INTERNAL MAPPING

cleanOutRecord

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

Specified by:

cleanOutRecord in interface OStorage

isFrozen

public boolean isFrozen()

freeze

public void freeze(boolean throwException)

release

public void release()

isRemote

public boolean isRemote()

Specified by:

isRemote in interface OStorage

reload

public void reload()

Specified by:

reload in interface OStorage

getMode

public String getMode()

lowDiskSpace

public void lowDiskSpace(OLowDiskSpaceInformation information)

Specified by:

lowDiskSpace in interface OLowDiskSpaceListener

pageIsBroken

public 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 void requestCheckpoint()

Specified by:

requestCheckpoint in interface OFullCheckpointRequestListener

command

public Object command(OCommandRequestText iCommand)

Executes the command request and return the result back.

Specified by:

command in interface OStorage

executeCommand

public Object executeCommand(OCommandRequestText iCommand,
                             OCommandExecutor executor)

higherPhysicalPositions

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

Specified by:

higherPhysicalPositions in interface OStorage

ceilingPhysicalPositions

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

Specified by:

ceilingPhysicalPositions in interface OStorage

lowerPhysicalPositions

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

Specified by:

lowerPhysicalPositions in interface OStorage

floorPhysicalPositions

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

Specified by:

floorPhysicalPositions in interface OStorage

acquireWriteLock

public void acquireWriteLock(ORID rid)

releaseWriteLock

public void releaseWriteLock(ORID rid)

acquireReadLock

public void acquireReadLock(ORID rid)

releaseReadLock

public void releaseReadLock(ORID rid)

getConflictStrategy

public ORecordConflictStrategy getConflictStrategy()

Specified by:

getConflictStrategy in interface OStorage

setConflictStrategy

public void setConflictStrategy(ORecordConflictStrategy conflictResolver)

Specified by:

setConflictStrategy in interface OStorage

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)
                                                 throws IOException

Throws:

IOException

checkOpeness

protected void checkOpeness()

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

makeFullCheckpoint

protected void makeFullCheckpoint()
                           throws IOException

Throws:

IOException

getFullCheckpointCount

public long getFullCheckpointCount()

preOpenSteps

protected void preOpenSteps()
                     throws IOException

Throws:

IOException

postCreateSteps

protected void postCreateSteps()

preCreateSteps

protected void preCreateSteps()
                       throws IOException

Throws:

IOException

initWalAndDiskCache

protected abstract void initWalAndDiskCache()
                                     throws IOException

Throws:

IOException

postCloseSteps

protected abstract void postCloseSteps(boolean onDelete,
                                       boolean jvmError)
                                throws IOException

Throws:

IOException

preCloseSteps

protected void preCloseSteps()
                      throws IOException

Throws:

IOException

postDeleteSteps

protected void postDeleteSteps()

makeStorageDirty

protected void makeStorageDirty()
                         throws IOException

Throws:

IOException

clearStorageDirty

protected void clearStorageDirty()
                          throws IOException

Throws:

IOException

isDirty

protected boolean isDirty()
                   throws IOException

Throws:

IOException

isIndexRebuildScheduled

public boolean isIndexRebuildScheduled()

isIndexRebuildScheduledInternal

protected boolean isIndexRebuildScheduledInternal()

scheduleIndexRebuild

protected void scheduleIndexRebuild()
                             throws IOException

Throws:

IOException

cancelIndexRebuild

public void cancelIndexRebuild()
                        throws IOException

Throws:

IOException

readRecords

public Collection<OPair<ORecordId,ORawBuffer>> readRecords(Collection<ORecordId> iRids)

Returns the requested records. The returned order could be different than the requested.

Parameters:

iRids - Set of rids to load in one shot

checkClustersConsistency

public int checkClustersConsistency()

onException

public void onException(Throwable e)

Specified by:

onException in interface OBackgroundExceptionListener

closeClusters

protected void closeClusters(boolean onDelete)
                      throws IOException

Throws:

IOException

closeIndexes

protected void closeIndexes(boolean onDelete)

incrementalBackup

public String incrementalBackup(String backupDirectory)

Specified by:

incrementalBackup in interface OStorage

Returns:

Backup file name

restoreFromIncrementalBackup

public void restoreFromIncrementalBackup(String filePath)

Specified by:

restoreFromIncrementalBackup in interface OStorage

restoreFrom

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

Throws:

IOException

restoreAtomicUnit

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

Throws:

IOException

getRidsGroupedByCluster

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

getRecordScanned

public AtomicLong getRecordScanned()

logAndPrepareForRethrow

protected RuntimeException logAndPrepareForRethrow(RuntimeException runtimeException)

logAndPrepareForRethrow

protected Error logAndPrepareForRethrow(Error error)

logAndPrepareForRethrow

protected RuntimeException logAndPrepareForRethrow(Throwable throwable)

updateConfiguration

public void updateConfiguration()

Specified by:

updateConfiguration in interface OStorage

setRecordSerializer

public void setRecordSerializer(String recordSerializer,
                                int version)

Specified by:

setRecordSerializer in interface OStorage

setProperty

public void setProperty(String property,
                        String value)

Specified by:

setProperty in interface OStorage

setDateFormat

public void setDateFormat(String dateFormat)

Specified by:

setDateFormat in interface OStorage

setDateTimeFormat

public void setDateTimeFormat(String dateTimeFormat)

Specified by:

setDateTimeFormat in interface OStorage

setTimeZone

public void setTimeZone(TimeZone timeZone)

Specified by:

setTimeZone in interface OStorage

setLocaleCountry

public void setLocaleCountry(String localeCountry)

Specified by:

setLocaleCountry in interface OStorage

setLocaleLanguage

public void setLocaleLanguage(String localeLanguage)

Specified by:

setLocaleLanguage in interface OStorage

setCharset

public void setCharset(String charset)

Specified by:

setCharset in interface OStorage

setClusterSelection

public void setClusterSelection(String clusterSelection)

Specified by:

setClusterSelection in interface OStorage

setMinimumClusters

public void setMinimumClusters(int minimumClusters)

Specified by:

setMinimumClusters in interface OStorage

setValidation

public void setValidation(boolean validation)

Specified by:

setValidation in interface OStorage

clearProperties

public void clearProperties()

Specified by:

clearProperties in interface OStorage

removeProperty

public void removeProperty(String property)

Specified by:

removeProperty in interface OStorage

setSchemaRecordId

public void setSchemaRecordId(String schemaRecordId)

Specified by:

setSchemaRecordId in interface OStorage

setIndexMgrRecordId

public void setIndexMgrRecordId(String indexMgrRecordId)

Specified by:

setIndexMgrRecordId in interface OStorage