Field Detail

• serverInstance

  protected final OServer serverInstance

• dManager

  protected final ODistributedServerManager dManager

• wrapped

  protected OAbstractPaginatedStorage wrapped

• asynchronousOperationsQueue

  protected BlockingQueue<OAsynchDistributedOperation> asynchronousOperationsQueue

• asynchWorker

  protected Thread asynchWorker

• running

  protected volatile boolean running

• lastValidBackup

  protected volatile File lastValidBackup

Constructor Detail

• ODistributedStorage

  public ODistributedStorage(OServer iServer)

Method Detail

• wrap

  public void wrap(OAbstractPaginatedStorage wrapped)

• isDistributed

  public boolean isDistributed()

  Specified by:

  isDistributed in interface OStorage

• isAssigningClusterIds

  public boolean isAssigningClusterIds()

  Specified by:

  isAssigningClusterIds in interface OStorage

• command

  public Object command(OCommandRequestText iCommand)

  Description copied from interface: OStorage
  Execute the command request and return the result back.

  Specified by:

  command in interface OStorage

• executeOnServers

  protected Map<String,Object> executeOnServers(OCommandRequestText iCommand,
                                                Collection<String> involvedClusters,
                                                Map<String,Collection<String>> nodeClusterMap)

• mergeResultByAggregation

  protected Object mergeResultByAggregation(OCommandExecutorSQLSelect select,
                                            Map<String,Object> iResults)

• executeOnlyLocally

  protected boolean executeOnlyLocally(String localNodeName,
                                       ODistributedConfiguration dbCfg,
                                       OCommandExecutor exec,
                                       Collection<String> involvedClusters,
                                       Collection<String> nodes)

  Only idempotent commands that don't involve any other node can be executed locally.

  Returns:

• createRecord

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

  Specified by:

  createRecord in interface OStorage

• readRecord

  public OStorageOperationResult<ORawBuffer> readRecord(ORecordId iRecordId,
                                                        String iFetchPlan,
                                                        boolean iIgnoreCache,
                                                        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

• getSBtreeCollectionManager

  public OSBTreeCollectionManager getSBtreeCollectionManager()

  Specified by:

  getSBtreeCollectionManager in interface OStorage

• updateRecord

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

  Specified by:

  updateRecord in interface OStorage

• recyclePosition

  public OStorageOperationResult<Integer> recyclePosition(ORecordId iRecordId,
                                                          byte[] iContent,
                                                          int iVersion,
                                                          byte recordType)

  Description copied from interface: OStorage
  Resurrects a record that was previously deleted, with a new content.

  Specified by:

  recyclePosition in interface OStorage

• deleteRecord

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

  Specified by:

  deleteRecord in interface OStorage

• hideRecord

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

  Specified by:

  hideRecord in interface OStorage

• getRecordMetadata

  public ORecordMetadata getRecordMetadata(ORID rid)

  Specified by:

  getRecordMetadata in interface OStorage

• cleanOutRecord

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

  Specified by:

  cleanOutRecord in interface OStorage

• existsResource

  public boolean existsResource(String iName)

  Specified by:

  existsResource in interface OSharedContainer

• getClusterByName

  public OCluster getClusterByName(String iName)

  Specified by:

  getClusterByName in interface OStorage

• getConflictStrategy

  public ORecordConflictStrategy getConflictStrategy()

  Specified by:

  getConflictStrategy in interface OStorage

• setConflictStrategy

  public void setConflictStrategy(ORecordConflictStrategy iResolver)

  Specified by:

  setConflictStrategy in interface OStorage

• removeResource

  public <T> T removeResource(String iName)

  Specified by:

  removeResource in interface OSharedContainer

• getResource

  public <T> T getResource(String iName,
                           Callable<T> iCallback)

  Specified by:

  getResource in interface OSharedContainer

• open

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

  Specified by:

  open in interface OStorage

• create

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

  Specified by:

  create in interface OStorage

• exists

  public boolean exists()

  Specified by:

  exists in interface OStorage

• reload

  public void reload()

  Specified by:

  reload in interface OStorage

• delete

  public void delete()

  Specified by:

  delete in interface OStorage

• 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

• close

  public void close()

  Specified by:

  close in interface OStorage

• close

  public void close(boolean iForce,
                    boolean onDelete)

  Specified by:

  close in interface OStorage

• isClosed

  public boolean isClosed()

  Specified by:

  isClosed in interface OStorage

• commit

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

  Specified by:

  commit in interface OStorage

• initiateCommit

  public OUncompletedCommit<List<ORecordOperation>> initiateCommit(OTransaction iTx,
                                                                   Runnable callback)

  Specified by:

  initiateCommit in interface OStorage

• acquireRecordLock

  protected ODistributedRequestId acquireRecordLock(ORecordId rid)

• rollback

  public void rollback(OTransaction iTx)

  Specified by:

  rollback in interface OStorage

• getConfiguration

  public OStorageConfiguration getConfiguration()

  Specified by:

  getConfiguration in interface OStorage

• getClusters

  public int getClusters()

  Specified by:

  getClusters in interface OStorage

• getClusterNames

  public Set<String> getClusterNames()

  Specified by:

  getClusterNames in interface OStorage

• getClusterById

  public OCluster getClusterById(int iId)

  Specified by:

  getClusterById in interface OStorage

• getClusterInstances

  public Collection<? extends OCluster> getClusterInstances()

  Specified by:

  getClusterInstances in interface OStorage

• addCluster

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

  Description copied from interface: OStorage
  Add a new cluster into the storage.

  Specified by:

  addCluster in interface OStorage

  Parameters:

  iClusterName - name of the cluster

• addCluster

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

  Description copied from interface: OStorage
  Add a new cluster into the storage.

  Specified by:

  addCluster in interface OStorage

  Parameters:

  iClusterName - name of the cluster

  iRequestedId - requested id of the cluster

• dropCluster

  public boolean dropCluster(String iClusterName,
                             boolean iTruncate)

  Specified by:

  dropCluster in interface OStorage

• dropCluster

  public boolean dropCluster(int iId,
                             boolean iTruncate)

  Description copied from interface: OStorage
  Drops a cluster.

  Specified by:

  dropCluster in interface OStorage

  Parameters:

  iId - id of the cluster to delete

  Returns:

  true if has been removed, otherwise false

• count

  public long count(int iClusterId)

  Specified by:

  count in interface OStorage

• count

  public long count(int iClusterId,
                    boolean countTombstones)

  Specified by:

  count in interface OStorage

• count

  public long count(int[] iClusterIds)

  Specified by:

  count in interface OStorage

• count

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

  Specified by:

  count in interface OStorage

• getSize

  public long getSize()

  Description copied from interface: OStorage
  Returns the size of the database.

  Specified by:

  getSize in interface OStorage

• countRecords

  public long countRecords()

  Description copied from interface: OStorage
  Returns the total number of records.

  Specified by:

  countRecords 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

• getClusterIdByName

  public int getClusterIdByName(String iClusterName)

  Specified by:

  getClusterIdByName in interface OStorage

• getPhysicalClusterNameById

  public String getPhysicalClusterNameById(int iClusterId)

  Specified by:

  getPhysicalClusterNameById in interface OStorage

• checkForRecordValidity

  public boolean checkForRecordValidity(OPhysicalPosition ppos)

  Specified by:

  checkForRecordValidity in interface OStorage

• getName

  public String getName()

  Specified by:

  getName in interface OStorage

• getURL

  public String getURL()

  Specified by:

  getURL in interface OStorage

• getVersion

  public long getVersion()

  Specified by:

  getVersion in interface OStorage

• synch

  public void synch()

  Specified by:

  synch in interface OStorage

• getClusterDataRange

  public long[] getClusterDataRange(int currentClusterId)

  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:

  currentClusterId - Cluster id

• callInLock

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

  Specified by:

  callInLock in interface OStorage

• getStatus

  public OStorage.STATUS getStatus()

  Description copied from interface: OStorage
  Returns the current storage's status

  Specified by:

  getStatus in interface OStorage

  Returns:

• getEventListener

  public ODistributedStorageEventListener getEventListener()

• setEventListener

  public void setEventListener(ODistributedStorageEventListener eventListener)

• checkForClusterPermissions

  public void checkForClusterPermissions(String iClusterName)

  Specified by:

  checkForClusterPermissions in interface OStorage

• higherPhysicalPositions

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

  Specified by:

  higherPhysicalPositions in interface OStorage

• getServer

  public OServer getServer()

• getDistributedManager

  public ODistributedServerManager getDistributedManager()

• getDistributedConfiguration

  public ODistributedConfiguration getDistributedConfiguration()

• setDistributedConfiguration

  public void setDistributedConfiguration(ODistributedConfiguration distributedConfiguration)

• ceilingPhysicalPositions

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

  Specified by:

  ceilingPhysicalPositions in interface OStorage

• floorPhysicalPositions

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

  Specified by:

  floorPhysicalPositions in interface OStorage

• lowerPhysicalPositions

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

  Specified by:

  lowerPhysicalPositions in interface OStorage

• getUnderlying

  public OStorage getUnderlying()

  Specified by:

  getUnderlying in interface OStorage

• isRemote

  public boolean isRemote()

  Specified by:

  isRemote in interface OStorage

• getComponentsFactory

  public OCurrentStorageComponentsFactory getComponentsFactory()

  Specified by:

  getComponentsFactory in interface OStorage

• getType

  public String getType()

  Description copied from interface: OStorage
  Returns the storage's type.

  Specified by:

  getType in interface OStorage

  Returns:

• freeze

  public void freeze(boolean throwException)

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

  Specified by:

  freeze in interface OFreezableStorage

  Parameters:

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

• release

  public void release()

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

  Specified by:

  release in interface OFreezableStorage

• backup

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

  Description copied from interface: OBackupable
  Executes a backup of the database. During the backup the database will be frozen in read-only mode.

  Specified by:

  backup in interface OBackupable

  Parameters:

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

  options - Backup options as Map 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

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

  Description copied from interface: OBackupable
  Executes a restore of a database backup. During the restore the database will be frozen in read-only mode.

  Specified by:

  restore in interface OBackupable

  Parameters:

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

  options - Backup options as Map object

  callable - Callback to execute when the database is locked

  iListener - Listener called for backup messages

  Throws:

  IOException

  See Also:

  ODatabaseImport

• getClusterNameByRID

  public String getClusterNameByRID(ORecordId iRid)

• getStorageId

  public String getStorageId()

  Description copied from interface: OAutoshardedStorage
  Storage unique id, made by node name + database name

  Specified by:

  getStorageId in interface OAutoshardedStorage

  Returns:

  storage unique id

• getNodeId

  public String getNodeId()

  Specified by:

  getNodeId in interface OAutoshardedStorage

• shutdown

  public void shutdown()

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

  Specified by:

  shutdown in interface OStorage

• shutdownAsynchronousWorker

  public void shutdownAsynchronousWorker()

• checkNodeIsMaster

  protected void checkNodeIsMaster(String localNodeName,
                                   ODistributedConfiguration dbCfg)

• checkLocalNodeIsAvailable

  protected void checkLocalNodeIsAvailable()

• getLastValidBackup

  public File getLastValidBackup()

• setLastValidBackup

  public void setLastValidBackup(File lastValidBackup)

• asynchronousExecution

  protected void asynchronousExecution(OAsynchDistributedOperation iOperation)

• getAsyncReplicationError

  protected OAsyncReplicationError getAsyncReplicationError()

• handleDistributedException

  protected void handleDistributedException(String iMessage,
                                            Exception e,
                                            Object... iParams)

• dropStorageFiles

  protected void dropStorageFiles()