Package com.orientechnologies.orient.core.storage.disk

Class OLocalPaginatedStorage

java.lang.Object

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

com.orientechnologies.orient.core.storage.disk.OLocalPaginatedStorage

All Implemented Interfaces:

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

public class OLocalPaginatedStorage
extends OAbstractPaginatedStorage

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 byte[]	iv
protected static final String	IV_NAME
protected static final long	IV_SEED

Fields inherited from class com.orientechnologies.orient.core.storage.impl.local.OAbstractPaginatedStorage

atomicOperationsManager, atomicOperationsTable, componentsFactory, configuration, context, DATABASE_INSTANCE_ID, error, fuzzyCheckpointExecutor, name, readCache, sbTreeCollectionManager, stateLock, status, storageThreadGroup, url, writeAheadLog, writeCache

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

CLUSTER_DEFAULT_NAME

Constructor Summary

Constructors

Constructor	Description
OLocalPaginatedStorage(String name, String filePath, int id, OReadCache readCache, OClosableLinkedContainer<Long,OFile> files, long walMaxSegSize, long doubleWriteLogMaxSegSize, OrientDBInternal context)

Method Summary

Modifier and Type	Method	Description
protected void	addFileToDirectory(String name, InputStream stream, File directory)
final List<String>	backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iOutput, int compressionLevel, int bufferSize)	Executes a backup of the database.
protected void	checkBackupRunning()
protected OStartupMetadata	checkIfStorageDirty()
protected void	clearStorageDirty()
protected OLogSequenceNumber	copyWALToIncrementalBackup(ZipOutputStream zipOutputStream, long startSegment)
void	create(OContextConfiguration contextConfiguration)
protected OWriteAheadLog	createWalFromIBUFiles(File directory, OContextConfiguration contextConfiguration, Locale locale, byte[] iv)
protected File	createWalTempDirectory()
static void	deleteFilesFromDisc(String name, int maxRetries, int waitTime, String databaseDirectory)
final boolean	exists()
static boolean	exists(Path path)
protected byte[]	getIv()
protected String	getOpenedAtVersion()
final Path	getStoragePath()
String	getType()	Returns the storage's type.
String	getURL()
protected void	initConfiguration(OAtomicOperation atomicOperation, OContextConfiguration contextConfiguration)
protected void	initIv()
protected void	initWalAndDiskCache(OContextConfiguration contextConfiguration)
protected boolean	isDirty()
protected boolean	isWriteAllowedDuringIncrementalBackup()
protected void	makeStorageDirty()
protected void	postCloseSteps(boolean onDelete, boolean internalError, long lastTxId)
protected void	postCloseStepsAfterLock(Map<String,Object> params)
protected void	postDeleteSteps()
protected Map<String,Object>	preCloseSteps()
protected void	preCreateSteps()
protected void	readIv()
final void	restore(InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener)	Executes a restore of a database backup.

Methods inherited from class com.orientechnologies.orient.core.storage.impl.local.OAbstractPaginatedStorage

acquireReadLock, acquireReadLock, acquireWriteLock, acquireWriteLock, addCluster, addCluster, addIndexEngine, browseCluster, callIndexEngine, ceilingPhysicalPositions, check, checkDatabaseInstanceId, checkErrorState, checkForRecordValidity, checkName, checkOpennessAndMigration, cleanOutRecord, clearIndex, clearProperties, close, close, closeClusters, closeIndexes, command, commit, commit, commitPreAllocated, count, count, count, count, countRecords, createRecord, delete, deleteIndexEngine, deleteRecord, deleteTreeRidBag, dropCluster, dropCluster, endDDL, executeCommand, extractEngineAPIVersion, extractTransactionsFromWal, fireConfigurationUpdateNotifications, floorPhysicalPositions, flushAllData, freeze, fullIncrementalBackup, generateDatabaseInstanceId, getAtomicOperationsManager, getClusterDataRange, getClusterEncryption, getClusterIdByName, getClusterInstances, getClusterName, getClusterNameById, getClusterNames, getClusterNextPosition, getClusterRecordConflictStrategy, getClusterRecordsSizeById, getClusterRecordsSizeByName, getClusters, getClustersIds, getComponentsFactory, getConfiguration, getContext, getCreatedAtVersion, getDefaultClusterId, getId, getIdGen, getIndexDescStream, getIndexEngine, getIndexKeyStream, getIndexSize, getIndexStream, getIndexValue, getIndexValues, getLastCloseTime, getLastClusterPosition, getLastMetadata, getLSN, getMode, getName, getPhysicalClusterNameById, getReadCache, getRecordConflictStrategy, getRecordMetadata, getRecordScanned, getRecordStatus, getRecoverListener, getRidsGroupedByCluster, getSBtreeCollectionManager, getSessionCount, getSize, getStatus, getUnderlying, getUuid, getVersion, getVersionForKey, getWALInstance, getWriteCache, hasIndexRangeQuerySupport, higherPhysicalPositions, incOnOpen, incrementalBackup, isAssigningClusterIds, isClosed, isDeleted, isDistributed, isInError, isMemory, isRemote, isSystemCluster, iterateIndexEntriesBetween, iterateIndexEntriesMajor, iterateIndexEntriesMinor, loadEncryption, loadExternalIndexEngine, loadIndexEngine, logAndPrepareForRethrow, logAndPrepareForRethrow, logAndPrepareForRethrow, logAndPrepareForRethrow, logAndPrepareForRethrow, logAndPrepareForRethrow, lowerPhysicalPositions, makeFuzzyCheckpoint, metadataOnly, moveToErrorStateIfNeeded, normalizeName, onException, open, open, openClusters, openIndexes, pageIsBroken, pauseConfigurationUpdateNotifications, postCreateSteps, preallocateRids, putIndexValue, putRidIndexEntry, readDatabaseInstanceId, readRecord, readRecordIfVersionIsNotLatest, registerRecoverListener, release, releaseReadLock, releaseWriteLock, reload, removeKeyFromIndex, removeProperty, removeRidIndexEntry, requestCheckpoint, resolveObjectSerializer, restoreAtomicUnit, restoreFrom, restoreFromIncrementalBackup, restoreFullIncrementalBackup, setCharset, setClusterAttribute, setClusterSelection, setConflictStrategy, setDateFormat, setDateTimeFormat, setDefaultClusterId, setIndexMgrRecordId, setLocaleCountry, setLocaleLanguage, setMinimumClusters, setProperty, setRecordSerializer, setSchemaRecordId, setStorageConfigurationUpdateListener, setTimeZone, setValidation, shutdown, startDDL, supportIncremental, synch, toString, unregisterRecoverListener, updateIndexEntry, updateRecord, validatedPutIndexValue, wereDataRestoredAfterOpen, 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.storage.OStorage

isIcrementalBackupRunning

Field Details

IV_SEED

protected static final long IV_SEED

See Also:

• Constant Field Values

IV_NAME

protected static final String IV_NAME

See Also:

• Constant Field Values

iv

protected volatile byte[] iv

Constructor Details

OLocalPaginatedStorage

public OLocalPaginatedStorage(String name,
 String filePath,
 int id,
 OReadCache readCache,
 OClosableLinkedContainer<Long,OFile> files,
 long walMaxSegSize,
 long doubleWriteLogMaxSegSize,
 OrientDBInternal context)

Method Details

create

public void create(OContextConfiguration contextConfiguration)

Specified by:

create in interface OStorage

Overrides:

create in class OAbstractPaginatedStorage

exists

public final boolean exists()

getURL

public String getURL()

Specified by:

getURL in interface OStorageInfo

Overrides:

getURL in class OAbstractPaginatedStorage

getStoragePath

public final Path getStoragePath()

getType

public String getType()

Description copied from interface: OStorage

Returns the storage's type.

backup

public final List<String> backup(OutputStream out,
 Map<String,Object> options,
 Callable<Object> callable,
 OCommandOutputListener iOutput,
 int compressionLevel,
 int bufferSize)

Description copied from interface: OBackupable

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 Map<String, Object> object

callable - Callback to execute when the database is locked

iOutput - 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

See Also:

• ODatabaseExport

restore

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

Description copied from interface: OBackupable

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 Map<String, Object> object

callable - Callback to execute when the database is locked

iListener - Listener called for backup messages

See Also:

• ODatabaseImport

copyWALToIncrementalBackup

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

Specified by:

copyWALToIncrementalBackup in class OAbstractPaginatedStorage

Throws:

IOException

createWalTempDirectory

protected File createWalTempDirectory()

Specified by:

createWalTempDirectory in class OAbstractPaginatedStorage

addFileToDirectory

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

Specified by:

addFileToDirectory in class OAbstractPaginatedStorage

Throws:

IOException

createWalFromIBUFiles

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

Specified by:

createWalFromIBUFiles in class OAbstractPaginatedStorage

Throws:

IOException

checkIfStorageDirty

protected OStartupMetadata checkIfStorageDirty()
                                        throws IOException

Overrides:

checkIfStorageDirty in class OAbstractPaginatedStorage

Throws:

IOException

initConfiguration

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

Overrides:

initConfiguration in class OAbstractPaginatedStorage

Throws:

IOException

preCloseSteps

protected Map<String,Object> preCloseSteps()

Overrides:

preCloseSteps in class OAbstractPaginatedStorage

postCloseStepsAfterLock

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

Overrides:

postCloseStepsAfterLock in class OAbstractPaginatedStorage

preCreateSteps

protected void preCreateSteps()
                       throws IOException

Overrides:

preCreateSteps in class OAbstractPaginatedStorage

Throws:

IOException

postCloseSteps

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

Specified by:

postCloseSteps in class OAbstractPaginatedStorage

Throws:

IOException

postDeleteSteps

protected void postDeleteSteps()

Overrides:

postDeleteSteps in class OAbstractPaginatedStorage

deleteFilesFromDisc

public static void deleteFilesFromDisc(String name,
 int maxRetries,
 int waitTime,
 String databaseDirectory)

makeStorageDirty

protected void makeStorageDirty()
                         throws IOException

Overrides:

makeStorageDirty in class OAbstractPaginatedStorage

Throws:

IOException

clearStorageDirty

protected void clearStorageDirty()
                          throws IOException

Overrides:

clearStorageDirty in class OAbstractPaginatedStorage

Throws:

IOException

isDirty

protected boolean isDirty()

Overrides:

isDirty in class OAbstractPaginatedStorage

getOpenedAtVersion

protected String getOpenedAtVersion()

Overrides:

getOpenedAtVersion in class OAbstractPaginatedStorage

isWriteAllowedDuringIncrementalBackup

protected boolean isWriteAllowedDuringIncrementalBackup()

Specified by:

isWriteAllowedDuringIncrementalBackup in class OAbstractPaginatedStorage

initIv

protected void initIv()
               throws IOException

Specified by:

initIv in class OAbstractPaginatedStorage

Throws:

IOException

readIv

protected void readIv()
               throws IOException

Specified by:

readIv in class OAbstractPaginatedStorage

Throws:

IOException

getIv

protected byte[] getIv()

Specified by:

getIv in class OAbstractPaginatedStorage

initWalAndDiskCache

protected void initWalAndDiskCache(OContextConfiguration contextConfiguration)
                            throws IOException,
InterruptedException

Specified by:

initWalAndDiskCache in class OAbstractPaginatedStorage

Throws:

IOException

InterruptedException

exists

public static boolean exists(Path path)

checkBackupRunning

protected void checkBackupRunning()

Specified by:

checkBackupRunning in class OAbstractPaginatedStorage