Package com.orientechnologies.orient.core.storage

Interface OStorage

All Superinterfaces:

OStorageInfo

All Known Subinterfaces:

OIdentifiableStorage

All Known Implementing Classes:

OAbstractPaginatedStorage, ODirectMemoryStorage, OEnterpriseLocalPaginatedStorage, OLocalPaginatedStorage

public interface OStorage
extends OStorageInfo

This is the gateway interface between the Database side and the storage. Provided implementations are: Local, Remote and Memory.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

See Also:

• ODirectMemoryStorage

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OStorage.LOCKING_STRATEGY
static enum	OStorage.STATUS

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLUSTER_DEFAULT_NAME

Method Summary

Modifier and Type	Method	Description
void	acquireReadLock(ORID rid, long timeout)
void	acquireWriteLock(ORID rid, long timeout)
int	addCluster(String iClusterName, int iRequestedId)	Add a new cluster into the storage.
int	addCluster(String iClusterName, Object... iParameters)	Add a new cluster into the storage.
int	addIndexEngine(OIndexMetadata indexMetadata, Map<String,String> engineProperties)
List<String>	backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener, int compressionLevel, int bufferSize)	Executes a backup of the database.
void	backupTransactions(OutputStream output, List<OTransactionId> transactionsMetadata)
<T> T	callIndexEngine(boolean readOperation, int indexId, OIndexEngineCallback<T> callback)
OPhysicalPosition[]	ceilingPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
boolean	check(boolean verbose, OCommandOutputListener listener)
boolean	cleanOutRecord(ORecordId recordId, int recordVersion)
void	clearIndex(int indexId)
void	clearProperties()
void	close()
void	commit(OStorageTransaction iTx)
void	commitPreAllocated(OStorageTransaction clientTx)
long	count(int iClusterId)
long	count(int[] iClusterIds)
long	countRecords()	Returns the total number of records.
void	create(OContextConfiguration contextConfiguration, ODatabaseId id)
OBonsaiCollectionPointer	createSBTree(int clusterId, UUID ownerUUID)
void	delete()
void	deleteIndexEngine(int indexId)
OStorageOperationResult<Boolean>	deleteRecord(ORecordId iRecordId, int iVersion)
boolean	dropCluster(int iId)	Drops a cluster.
boolean	dropCluster(String iClusterName)
void	endDDL()
boolean	exists()
Optional<OBackgroundNewDelta>	extractTransactionsFromWal(List<OTransactionId> transactionsMetadata)
void	fireConfigurationUpdateNotifications()
OPhysicalPosition[]	floorPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
void	fullIncrementalBackup(OutputStream stream)
long[]	getClusterDataRange(int currentClusterId)	Returns a pair of long values telling the begin and end positions of data in the requested cluster.
String	getClusterEncryption(int clusterId)
int	getClusterIdByName(String iClusterName)
Collection<? extends OClusterInfo>	getClusterInstances()
String	getClusterName(int clusterId)
String	getClusterNameById(int clusterId)
Set<String>	getClusterNames()
long	getClusterNextPosition(int clusterId)
String	getClusterRecordConflictStrategy(int clusterId)
long	getClusterRecordsSizeById(int clusterId)
long	getClusterRecordsSizeByName(String clusterName)
int[]	getClustersIds(Set<String> filterClusters)
OCurrentStorageComponentsFactory	getComponentsFactory()
OrientDBInternal	getContext()
String	getCreatedAtVersion()
ODatabaseId	getDatbaseId()
int	getIndexApiVersion(int indexId)
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)
long	getLastClusterPosition(int clusterId)
Optional<byte[]>	getLastMetadata()
String	getName()
Optional<Path>	getPath()
String	getPhysicalClusterNameById(int iClusterId)
ORecordConflictStrategy	getRecordConflictStrategy()
ORecordMetadata	getRecordMetadata(ORID rid)
OPaginatedCluster.RECORD_STATUS	getRecordStatus(ORID rid)
OSBTreeCollectionManager	getSBtreeCollectionManager()
long	getSize()	Returns the size of the database.
OStorage.STATUS	getStatus()	Returns the current storage's status
String	getType()	Returns the storage's type.
long	getVersion()
int	getVersionForKey(String indexName, Object key)
boolean	hasIndexRangeQuerySupport(int indexId)
OPhysicalPosition[]	higherPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
String	incrementalBackup(String backupDirectory, OCallable<Void,Void> started)
void	incrementalSync(OutputStream dest, Runnable started)
boolean	isAssigningClusterIds()
boolean	isClosed()
boolean	isDeleted(ORID rid)
default boolean	isIcrementalBackupRunning()
boolean	isMemory()
boolean	isSystemCluster(int clusterId)
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)
int	loadIndexEngine(OIndexMetadata indexMetadata)
OPhysicalPosition[]	lowerPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
void	metadataOnly(byte[] metadata)
void	open(OContextConfiguration configurations)
void	pauseConfigurationUpdateNotifications()
void	preallocateRids(OAllocationTransaction clientTx)
ORawBuffer	readRecord(ORecordId iRid)
ORawBuffer	readRecordIfVersionIsNotLatest(ORecordId rid, int recordVersion)
void	releaseReadLock(ORID rid)
void	releaseWriteLock(ORID rid)
void	reload()
void	removeIndexValuesContainer(OIndexMetadata im)
void	removeProperty(String property)
OBinarySerializer<?>	resolveObjectSerializer(byte serializerId)
void	restore(InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener)	Executes a restore of a database backup.
void	restoreFromIncrementalBackup(String filePath)
void	restoreFullIncrementalBackup(InputStream stream)
void	setCharset(String charset)
boolean	setClusterAttribute(int id, OCluster.ATTRIBUTES attribute, Object value)
void	setClusterSelection(String clusterSelection)
void	setConflictStrategy(ORecordConflictStrategy iResolver)
void	setDateFormat(String dateFormat)
void	setDateTimeFormat(String dateTimeFormat)
void	setDefaultClusterId(int defaultClusterId)
void	setIndexMgrRecordId(String indexMgrRecordId)
void	setLocaleCountry(String localeCountry)
void	setLocaleLanguage(String locale)
void	setMinimumClusters(int minimumClusters)
void	setProperty(String property, String value)
void	setRecordSerializer(String recordSerializer, int version)
void	setSchemaRecordId(String schemaRecordId)
void	setStorageConfigurationUpdateListener(OStorageConfigurationUpdateListener storageConfigurationUpdateListener)
void	setTimeZone(TimeZone timeZoneValue)
void	setValidation(boolean validation)
void	shutdown()	This method is called in Orient.shutdown() method.
void	startDDL()
boolean	supportIncremental()
void	synch()
boolean	wereDataRestoredAfterOpen()
boolean	wereNonTxOperationsPerformedInPreviousOpen()

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

getClusters, getConfiguration, getDefaultClusterId, getURL

Field Details

CLUSTER_DEFAULT_NAME

static final String CLUSTER_DEFAULT_NAME

See Also:

• Constant Field Values

Method Details

create

void create(OContextConfiguration contextConfiguration,
 ODatabaseId id)

exists

boolean exists()

reload

void reload()

delete

void delete()

close

void close()

isClosed

boolean isClosed()

readRecord

ORawBuffer readRecord(ORecordId iRid)

readRecordIfVersionIsNotLatest

ORawBuffer readRecordIfVersionIsNotLatest(ORecordId rid,
 int recordVersion)
                                   throws ORecordNotFoundException

Throws:

ORecordNotFoundException

deleteRecord

OStorageOperationResult<Boolean> deleteRecord(ORecordId iRecordId,
 int iVersion)

getRecordMetadata

ORecordMetadata getRecordMetadata(ORID rid)

cleanOutRecord

boolean cleanOutRecord(ORecordId recordId,
 int recordVersion)

commit

void commit(OStorageTransaction iTx)

getClusterNames

Set<String> getClusterNames()

Specified by:

getClusterNames in interface OStorageInfo

getClusterInstances

Collection<? extends OClusterInfo> getClusterInstances()

addCluster

int addCluster(String iClusterName,
 Object... iParameters)

Add a new cluster into the storage.

Parameters:

iClusterName - name of the cluster

addCluster

int addCluster(String iClusterName,
 int iRequestedId)

Add a new cluster into the storage.

Parameters:

iClusterName - name of the cluster

iRequestedId - requested id of the cluster

dropCluster

boolean dropCluster(String iClusterName)

getClusterName

String getClusterName(int clusterId)

setClusterAttribute

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

dropCluster

boolean dropCluster(int iId)

Drops a cluster.

Parameters:

iId - id of the cluster to delete

Returns:

true if has been removed, otherwise false

getClusterNameById

String getClusterNameById(int clusterId)

getClusterRecordsSizeById

long getClusterRecordsSizeById(int clusterId)

getClusterRecordsSizeByName

long getClusterRecordsSizeByName(String clusterName)

getClusterRecordConflictStrategy

String getClusterRecordConflictStrategy(int clusterId)

getClusterEncryption

String getClusterEncryption(int clusterId)

isSystemCluster

boolean isSystemCluster(int clusterId)

getLastClusterPosition

long getLastClusterPosition(int clusterId)

getClusterNextPosition

long getClusterNextPosition(int clusterId)

getRecordStatus

OPaginatedCluster.RECORD_STATUS getRecordStatus(ORID rid)

count

long count(int iClusterId)

count

long count(int[] iClusterIds)

getSize

long getSize()

Returns the size of the database.

countRecords

long countRecords()

Returns the total number of records.

setDefaultClusterId

void setDefaultClusterId(int defaultClusterId)

getClusterIdByName

int getClusterIdByName(String iClusterName)

Specified by:

getClusterIdByName in interface OStorageInfo

getPhysicalClusterNameById

String getPhysicalClusterNameById(int iClusterId)

Specified by:

getPhysicalClusterNameById in interface OStorageInfo

getName

String getName()

Specified by:

getName in interface OStorageInfo

getVersion

long getVersion()

getCreatedAtVersion

String getCreatedAtVersion()

Returns:

Version of product release under which storage was created.

synch

void synch()

getClusterDataRange

long[] getClusterDataRange(int currentClusterId)

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.

Parameters:

currentClusterId - Cluster id

higherPhysicalPositions

OPhysicalPosition[] higherPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

lowerPhysicalPositions

OPhysicalPosition[] lowerPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

ceilingPhysicalPositions

OPhysicalPosition[] ceilingPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

floorPhysicalPositions

OPhysicalPosition[] floorPhysicalPositions(int clusterId,
 OPhysicalPosition physicalPosition)

getStatus

OStorage.STATUS getStatus()

Returns the current storage's status

getType

String getType()

Returns the storage's type.

Specified by:

getType in interface OStorageInfo

isAssigningClusterIds

boolean isAssigningClusterIds()

Specified by:

isAssigningClusterIds in interface OStorageInfo

getSBtreeCollectionManager

OSBTreeCollectionManager getSBtreeCollectionManager()

getComponentsFactory

OCurrentStorageComponentsFactory getComponentsFactory()

getRecordConflictStrategy

ORecordConflictStrategy getRecordConflictStrategy()

Specified by:

getRecordConflictStrategy in interface OStorageInfo

setConflictStrategy

void setConflictStrategy(ORecordConflictStrategy iResolver)

incrementalBackup

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

Returns:

Backup file name

Throws:

UnsupportedOperationException

supportIncremental

boolean supportIncremental()

fullIncrementalBackup

void fullIncrementalBackup(OutputStream stream)
                    throws UnsupportedOperationException

Throws:

UnsupportedOperationException

restoreFromIncrementalBackup

void restoreFromIncrementalBackup(String filePath)

restoreFullIncrementalBackup

void restoreFullIncrementalBackup(InputStream stream)
                           throws UnsupportedOperationException

Throws:

UnsupportedOperationException

shutdown

void shutdown()

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.

setSchemaRecordId

void setSchemaRecordId(String schemaRecordId)

setDateFormat

void setDateFormat(String dateFormat)

setTimeZone

void setTimeZone(TimeZone timeZoneValue)

setLocaleLanguage

void setLocaleLanguage(String locale)

setCharset

void setCharset(String charset)

setIndexMgrRecordId

void setIndexMgrRecordId(String indexMgrRecordId)

setDateTimeFormat

void setDateTimeFormat(String dateTimeFormat)

setLocaleCountry

void setLocaleCountry(String localeCountry)

setClusterSelection

void setClusterSelection(String clusterSelection)

setMinimumClusters

void setMinimumClusters(int minimumClusters)

setValidation

void setValidation(boolean validation)

removeProperty

void removeProperty(String property)

setProperty

void setProperty(String property,
 String value)

setRecordSerializer

void setRecordSerializer(String recordSerializer,
 int version)

clearProperties

void clearProperties()

getClustersIds

int[] getClustersIds(Set<String> filterClusters)

isIcrementalBackupRunning

default boolean isIcrementalBackupRunning()

getContext

OrientDBInternal getContext()

getLastMetadata

Optional<byte[]> getLastMetadata()

open

void open(OContextConfiguration configurations)

setStorageConfigurationUpdateListener

void setStorageConfigurationUpdateListener(OStorageConfigurationUpdateListener storageConfigurationUpdateListener)

startDDL

void startDDL()

endDDL

void endDDL()

fireConfigurationUpdateNotifications

void fireConfigurationUpdateNotifications()

pauseConfigurationUpdateNotifications

void pauseConfigurationUpdateNotifications()

preallocateRids

void preallocateRids(OAllocationTransaction clientTx)

commitPreAllocated

void commitPreAllocated(OStorageTransaction clientTx)

acquireWriteLock

void acquireWriteLock(ORID rid,
 long timeout)

releaseWriteLock

void releaseWriteLock(ORID rid)

acquireReadLock

void acquireReadLock(ORID rid,
 long timeout)

releaseReadLock

void releaseReadLock(ORID rid)

wereDataRestoredAfterOpen

boolean wereDataRestoredAfterOpen()

wereNonTxOperationsPerformedInPreviousOpen

boolean wereNonTxOperationsPerformedInPreviousOpen()

hasIndexRangeQuerySupport

boolean hasIndexRangeQuerySupport(int indexId)
                           throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

addIndexEngine

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

loadIndexEngine

int loadIndexEngine(OIndexMetadata indexMetadata)

clearIndex

void clearIndex(int indexId)
         throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

deleteIndexEngine

void deleteIndexEngine(int indexId)
                throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexStream

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

Throws:

OInvalidIndexEngineIdException

callIndexEngine

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

Throws:

OInvalidIndexEngineIdException

getIndexKeyStream

Stream<Object> getIndexKeyStream(int indexId)
                          throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexEngine

OBaseIndexEngine getIndexEngine(int indexId)
                         throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

removeIndexValuesContainer

void removeIndexValuesContainer(OIndexMetadata im)

iterateIndexEntriesBetween

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

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesMajor

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

Throws:

OInvalidIndexEngineIdException

iterateIndexEntriesMinor

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

Throws:

OInvalidIndexEngineIdException

getIndexValue

Object getIndexValue(int indexId,
 Object key)
              throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexValues

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

Throws:

OInvalidIndexEngineIdException

getIndexSize

long getIndexSize(int indexId,
 IndexEngineValuesTransformer transformer)
           throws OInvalidIndexEngineIdException

Throws:

OInvalidIndexEngineIdException

getIndexDescStream

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

Throws:

OInvalidIndexEngineIdException

getVersionForKey

int getVersionForKey(String indexName,
 Object key)

metadataOnly

void metadataOnly(byte[] metadata)

isMemory

boolean isMemory()

extractTransactionsFromWal

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

backupTransactions

void backupTransactions(OutputStream output,
 List<OTransactionId> transactionsMetadata)

check

boolean check(boolean verbose,
 OCommandOutputListener listener)

resolveObjectSerializer

OBinarySerializer<?> resolveObjectSerializer(byte serializerId)

createSBTree

OBonsaiCollectionPointer createSBTree(int clusterId,
 UUID ownerUUID)

isDeleted

boolean isDeleted(ORID rid)

incrementalSync

void incrementalSync(OutputStream dest,
 Runnable started)

getPath

Optional<Path> getPath()

getDatbaseId

ODatabaseId getDatbaseId()

getIndexApiVersion

int getIndexApiVersion(int indexId)

backup

List<String> backup(OutputStream out,
 Map<String,Object> options,
 Callable<Object> callable,
 OCommandOutputListener iListener,
 int compressionLevel,
 int bufferSize)
             throws IOException

Executes a backup of the database. During the backup the database will be frozen in read-only mode.

Parameters:

out - OutputStream used to write the backup content. Use a FileOutputStream to make the backup persistent on disk

options - Backup options as Mapinvalid input: '<'String, Object> object

callable - Callback to execute when the database is locked

iListener - Listener called for backup messages

compressionLevel - ZIP Compression level between 1 (the minimum) and 9 (maximum). The bigger is the compression, the smaller will be the final backup content, but will consume more CPU and time to execute

bufferSize - Buffer size in bytes, the bigger is the buffer, the more efficient will be the compression

Throws:

IOException

See Also:

• ODatabaseExport

restore

void restore(InputStream in,
 Map<String,Object> options,
 Callable<Object> callable,
 OCommandOutputListener iListener)
      throws IOException

Executes a restore of a database backup. During the restore the database will be frozen in read-only mode.

Parameters:

in - InputStream used to read the backup content. Use a FileInputStream to read a backup on a disk

options - Backup options as Mapinvalid input: '<'String, Object> object

callable - Callback to execute when the database is locked

iListener - Listener called for backup messages

Throws:

IOException

See Also:

• ODatabaseImport