com.orientechnologies.orient.core.storage

Interface OStorage

All Superinterfaces:

OBackupable, OSharedContainer

All Known Subinterfaces:

OIdentifiableStorage, OStorageProxy

All Known Implementing Classes:

OAbstractPaginatedStorage, ODirectMemoryStorage, ODistributedStorage, OLocalPaginatedStorage, OStorageAbstract, OStorageRemote

public interface OStorage
extends OBackupable, OSharedContainer

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

Author:

Luca Garulli

See Also:

ODirectMemoryStorage

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OStorage.LOCKING_STRATEGY
static class	OStorage.SIZE
static class	OStorage.STATUS

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_DEFAULT_NAME

Method Summary

Modifier and Type	Method and Description
int	addCluster(String iClusterName, boolean forceListBased, Object... iParameters) Add a new cluster into the storage.
int	addCluster(String iClusterName, int iRequestedId, boolean forceListBased, Object... iParameters) Add a new cluster into the storage.
<V> V	callInLock(Callable<V> iCallable, boolean iExclusiveLock)
OPhysicalPosition[]	ceilingPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
void	checkForClusterPermissions(String iClusterName)
boolean	checkForRecordValidity(OPhysicalPosition ppos)
boolean	cleanOutRecord(ORecordId recordId, int recordVersion, int iMode, ORecordCallback<Boolean> callback)
void	clearProperties()
void	close()
void	close(boolean iForce, boolean onDelete)
Object	command(OCommandRequestText iCommand) Execute the command request and return the result back.
List<ORecordOperation>	commit(OTransaction iTx, Runnable callback)
long	count(int iClusterId)
long	count(int[] iClusterIds)
long	count(int[] iClusterIds, boolean countTombstones)
long	count(int iClusterId, boolean countTombstones)
long	countRecords() Returns the total number of records.
void	create(Map<String,Object> iProperties)
OStorageOperationResult<OPhysicalPosition>	createRecord(ORecordId iRecordId, byte[] iContent, int iRecordVersion, byte iRecordType, int iMode, ORecordCallback<Long> iCallback)
void	delete()
OStorageOperationResult<Boolean>	deleteRecord(ORecordId iRecordId, int iVersion, int iMode, ORecordCallback<Boolean> iCallback)
boolean	dropCluster(int iId, boolean iTruncate) Drops a cluster.
boolean	dropCluster(String iClusterName, boolean iTruncate)
boolean	exists()
OPhysicalPosition[]	floorPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
OCluster	getClusterById(int iId)
OCluster	getClusterByName(String clusterName)
long[]	getClusterDataRange(int currentClusterId) Returns a pair of long values telling the begin and end positions of data in the requested cluster.
int	getClusterIdByName(String iClusterName)
Collection<? extends OCluster>	getClusterInstances()
Set<String>	getClusterNames()
int	getClusters()
OCurrentStorageComponentsFactory	getComponentsFactory()
OStorageConfiguration	getConfiguration()
ORecordConflictStrategy	getConflictStrategy()
int	getDefaultClusterId()
String	getName()
String	getPhysicalClusterNameById(int iClusterId)
ORecordMetadata	getRecordMetadata(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.
OStorage	getUnderlying()
String	getURL()
long	getVersion()
OStorageOperationResult<Boolean>	hideRecord(ORecordId recordId, int mode, ORecordCallback<Boolean> callback)
OPhysicalPosition[]	higherPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
String	incrementalBackup(String backupDirectory)
boolean	isAssigningClusterIds()
boolean	isClosed()
boolean	isDistributed()
boolean	isRemote()
OPhysicalPosition[]	lowerPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)
void	open(String iUserName, String iUserPassword, Map<String,Object> iProperties)
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)
void	recyclePosition(ORecordId record, byte[] content, int recordVersion, byte recordType) Resurrects a record that was previously deleted.
void	reload()
void	removeProperty(String property)
void	restoreFromIncrementalBackup(String filePath)
void	rollback(OTransaction iTx)
void	setCharset(String charset)
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 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	shutdown() This method is called in Orient.shutdown() method.
void	synch()
void	updateConfiguration()
OStorageOperationResult<Integer>	updateRecord(ORecordId iRecordId, boolean updateContent, byte[] iContent, int iVersion, byte iRecordType, int iMode, ORecordCallback<Integer> iCallback)

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

CLUSTER_DEFAULT_NAME

static final String CLUSTER_DEFAULT_NAME

See Also:

Constant Field Values

Method Detail

open

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

create

void create(Map<String,Object> iProperties)

exists

boolean exists()

reload

void reload()

delete

void delete()

close

void close()

close

void close(boolean iForce,
           boolean onDelete)

isClosed

boolean isClosed()

createRecord

OStorageOperationResult<OPhysicalPosition> createRecord(ORecordId iRecordId,
                                                        byte[] iContent,
                                                        int iRecordVersion,
                                                        byte iRecordType,
                                                        int iMode,
                                                        ORecordCallback<Long> iCallback)

readRecord

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

readRecordIfVersionIsNotLatest

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

Throws:

ORecordNotFoundException

updateRecord

OStorageOperationResult<Integer> updateRecord(ORecordId iRecordId,
                                              boolean updateContent,
                                              byte[] iContent,
                                              int iVersion,
                                              byte iRecordType,
                                              int iMode,
                                              ORecordCallback<Integer> iCallback)

recyclePosition

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

Resurrects a record that was previously deleted.

deleteRecord

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

getRecordMetadata

ORecordMetadata getRecordMetadata(ORID rid)

cleanOutRecord

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

commit

List<ORecordOperation> commit(OTransaction iTx,
                              Runnable callback)

rollback

void rollback(OTransaction iTx)

getConfiguration

OStorageConfiguration getConfiguration()

getClusters

int getClusters()

getClusterNames

Set<String> getClusterNames()

getClusterById

OCluster getClusterById(int iId)

getClusterInstances

Collection<? extends OCluster> getClusterInstances()

addCluster

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

Add a new cluster into the storage.

Parameters:

iClusterName - name of the cluster

addCluster

int addCluster(String iClusterName,
               int iRequestedId,
               boolean forceListBased,
               Object... iParameters)

Add a new cluster into the storage.

Parameters:

iClusterName - name of the cluster

iRequestedId - requested id of the cluster

dropCluster

boolean dropCluster(String iClusterName,
                    boolean iTruncate)

dropCluster

boolean dropCluster(int iId,
                    boolean iTruncate)

Drops a cluster.

Parameters:

iId - id of the cluster to delete

Returns:

true if has been removed, otherwise false

count

long count(int iClusterId)

count

long count(int iClusterId,
           boolean countTombstones)

count

long count(int[] iClusterIds)

count

long count(int[] iClusterIds,
           boolean countTombstones)

getSize

long getSize()

Returns the size of the database.

countRecords

long countRecords()

Returns the total number of records.

getDefaultClusterId

int getDefaultClusterId()

setDefaultClusterId

void setDefaultClusterId(int defaultClusterId)

getClusterIdByName

int getClusterIdByName(String iClusterName)

getPhysicalClusterNameById

String getPhysicalClusterNameById(int iClusterId)

checkForRecordValidity

boolean checkForRecordValidity(OPhysicalPosition ppos)

getName

String getName()

getURL

String getURL()

getVersion

long getVersion()

synch

void synch()

command

Object command(OCommandRequestText iCommand)

Execute the command request and return the result back.

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

callInLock

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

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.

checkForClusterPermissions

void checkForClusterPermissions(String iClusterName)

getUnderlying

OStorage getUnderlying()

isRemote

boolean isRemote()

isDistributed

boolean isDistributed()

isAssigningClusterIds

boolean isAssigningClusterIds()

getSBtreeCollectionManager

OSBTreeCollectionManager getSBtreeCollectionManager()

getComponentsFactory

OCurrentStorageComponentsFactory getComponentsFactory()

hideRecord

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

getClusterByName

OCluster getClusterByName(String clusterName)

getConflictStrategy

ORecordConflictStrategy getConflictStrategy()

setConflictStrategy

void setConflictStrategy(ORecordConflictStrategy iResolver)

incrementalBackup

String incrementalBackup(String backupDirectory)

Returns:

Backup file name

restoreFromIncrementalBackup

void restoreFromIncrementalBackup(String filePath)

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.

updateConfiguration

void updateConfiguration()

setRecordSerializer

void setRecordSerializer(String recordSerializer,
                         int version)

setProperty

void setProperty(String property,
                 String value)

setDateFormat

void setDateFormat(String dateFormat)

setDateTimeFormat

void setDateTimeFormat(String dateTimeFormat)

setTimeZone

void setTimeZone(TimeZone timeZone)

setLocaleCountry

void setLocaleCountry(String localeCountry)

setLocaleLanguage

void setLocaleLanguage(String localeLanguage)

setCharset

void setCharset(String charset)

setClusterSelection

void setClusterSelection(String clusterSelection)

setMinimumClusters

void setMinimumClusters(int minimumClusters)

setValidation

void setValidation(boolean validation)

clearProperties

void clearProperties()

removeProperty

void removeProperty(String property)

setSchemaRecordId

void setSchemaRecordId(String schemaRecordId)

setIndexMgrRecordId

void setIndexMgrRecordId(String indexMgrRecordId)