Package com.orientechnologies.orient.server.distributed.impl

Class ODatabaseDocumentDistributed

java.lang.Object

com.orientechnologies.common.listener.OListenerManger<ODatabaseListener>

com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract

com.orientechnologies.orient.core.db.document.ODatabaseDocumentEmbedded

com.orientechnologies.orient.server.distributed.impl.ODatabaseDocumentDistributed

All Implemented Interfaces:

ODatabaseDocument, OQueryLifecycleListener, ODatabase<ORecord>, ODatabaseDocumentInternal, ODatabaseInternal<ORecord>, ODatabaseSession, OBackupable, Closeable, AutoCloseable

Direct Known Subclasses:

ODatabaseDocumentDistributedPooled

public class ODatabaseDocumentDistributed
extends ODatabaseDocumentEmbedded

Created by tglman on 30/03/17.

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.ODatabase

ODatabase.ATTRIBUTES, ODatabase.STATUS

Field Summary

Fields inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract

activeQueries, componentsFactory, currentTx, databaseOwner, hooks, hooksByScope, inHook, initialized, loadedRecordsCount, localCache, maxRecordLoadMs, maxRidbagPrefetchMs, metadata, minRecordLoadMs, minRidbagPrefetchMs, properties, queryState, recordType, retainRecords, ridbagPrefetchCount, serializer, sharedContext, status, totalRecordLoadMs, totalRidbagPrefetchMs, unmodifiableHooks, url, user

Fields inherited from interface com.orientechnologies.orient.core.db.document.ODatabaseDocument

TYPE

Constructor Summary

Constructors

Constructor	Description
ODatabaseDocumentDistributed(OStorage storage, ODistributedPlugin distributedPlugin)

Method Summary

Modifier and Type	Method	Description
void	acquireLocksForTx(OTransactionInternal tx, ODistributedTxContext txContext, boolean isCoordinator, boolean force)
int	addCluster(String iClusterName, int iRequestedId)	Adds a new cluster.
int	addCluster(String iClusterName, Object... iParameters)	Adds a new cluster.
int	assignAndCheckCluster(ORecord record, String iClusterName)
List<String>	backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener, int compressionLevel, int bufferSize)	Executes a backup of the database.
boolean	beginDistributedTx(ODistributedRequestId requestId, OTransactionIdPromise id, OTransactionInternal tx, boolean isCoordinator, int retryCount)
protected void	checkNodeIsMaster(String localNodeName, ODistributedConfiguration dbCfg, String operation)
boolean	commit2pc(ODistributedRequestId transactionId, boolean isCoordinator, ODistributedRequestId requestId)
void	commit2pcLocal(ODistributedRequestId transactionId)	The Local commit is different from a remote commit due to local rid pre-allocation
ODatabaseDocumentInternal	copy()	Returns a copy of current database if it's open.
protected void	createMetadata(OSharedContext ctx)
void	distributedCommitV1(OTransactionInternal iTx)
boolean	dropClusterInternal(int clusterId)
protected boolean	dropClusterInternal(String clusterName)
ODistributedResponse	executeTaskOnNode(ORemoteTask task, String nodeName)
OTransactionResultPayload	firstPhaseDDL(String query, OTransactionIdPromise preChangeId, OTransactionIdPromise afterChangeId, ODistributedRequestId requestId)
void	forceRsync()
void	freeze(boolean throwException)	Flush all indexes and cached storage content to the disk.
Map<String,Set<String>>	getActiveDataCenterMap()	returns the data center map for current deploy.
ODistributedConfiguration	getDistributedConfiguration()
ODistributedServerManager	getDistributedManager()
ODistributedDatabase	getDistributedShared()
OEnterpriseEndpoint	getEnterpriseEndpoint()
Map<String,Object>	getHaStatus(boolean servers, boolean db, boolean latency, boolean messages)
protected Set<String>	getInvolvedClusters(Iterable<ORecordOperation> uResult)
String	getLocalNodeName()	return the name of local node in the cluster
String	getStorageId()
OView	getViewFromCluster(int cluster)
protected void	handleDistributedException(String iMessage, Exception e, Object... iParams)
void	init(OrientDBConfig config, OSharedContext sharedContext)
void	internalBegin2pc(ONewDistributedTxContextImpl txContext, boolean isCoordinator)
void	internalBegin2pc(ONewDistributedTxContextImpl txContext, boolean isCoordinator, boolean force)
void	internalCommit(OTransactionInternal iTx)	Executed the commit on the storage hiding away storage concepts from the transaction
void	internalCommit2pc(ONewDistributedTxContextImpl txContext)
void	internalCommitPreallocate(OTransactionOptimistic iTx)
boolean	isDistributed()
boolean	isLocalEnv()
boolean	isSharded()	checks the cluster map and tells whether this is a sharded database (ie. a distributed DB where at least two nodes contain distinct subsets of data) or not
OExecutionStream	queryOnNode(String nodeName, OInternalExecutionPlan executionPlan, Map<Object,Object> inputParameters)	sends an execution plan to a remote node for a remote query execution
void	register(ODistributedRequestId requestId, ODistributedDatabase localDistributedDatabase, ODistributedTxContext txContext)
void	release()	Allows to execute write-related commands on DB.
boolean	removeHaServer(String serverName)
boolean	rollback2pc(ODistributedRequestId transactionId)
void	secondPhaseDDL(ODistributedRequestId confirmSentRequest, boolean apply)
void	sendDDLCommand(String command, boolean excludeLocal)
<T> T	sendSequenceAction(OSequenceAction action)
boolean	sync(boolean forceDeployment, boolean tryWithDelta)	synchronizes current database instance with the rest of the cluster (if in distributed mode).
void	syncCommit(OTransactionData data)
void	twoPhaseDDL(String command)

Methods inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentEmbedded

addBlobCluster, addRidbagPrefetchStats, afterCommitOperations, afterCreateOperations, afterDeleteOperations, afterReadOperations, afterRollbackOperations, afterUpdateOperations, beforeCreateOperations, beforeDeleteOperations, beforeReadOperations, beforeUpdateOperations, callOnCreateListeners, ceilingPhysicalPositions, checkSecurity, checkSecurity, checkSecurity, command, command, commandLikeLegacy, commitPreallocate, countClusterElements, countClusterElements, countClusterElements, countRecords, createSBTree, delete, directRead, dropCluster, dropCluster, endEsclusiveMetadataChange, execute, execute, executeDeleteRecord, executeLikeLegacy, executeReadRecord, floorPhysicalPositions, freeze, getClusterDataRange, getClusterName, getClusterRecordConflictStrategy, getClusterRecordSizeById, getClusterRecordSizeByName, getClustersIds, getConfig, getConflictStrategy, getLastClusterPosition, getRecordMetadata, getSbTreeCollectionManager, getSize, getStats, getStorage, getStorageInfo, higherPhysicalPositions, incrementalBackup, installHooksEmbedded, internalClose, internalCreate, internalLockRecord, internalLockRecord, internalOpen, internalOpen, internalOpen, internalUnlockRecord, isClosed, isReusable, live, live, loadMetadata, lock, lock, lowerPhysicalPositions, query, query, query, queryLikeLegacy, queryStarted, queryStartUsingViewCluster, queryStartUsingViewIndex, readIfVersionIsNotLatest, rebuildIndexes, reload, replaceStorage, resetRecordLoadStats, restore, saveAll, set, setConflictStrategy, setConflictStrategy, setCustom, setDefaultClusterId, startEsclusiveMetadataChange, truncateClass, truncateClass, truncateCluster, truncateClusterInternal, unlock

Methods inherited from class com.orientechnologies.orient.core.db.document.ODatabaseDocumentAbstract

activateOnCurrentThread, beforeCommitOperations, beforeRollbackOperations, begin, begin, browseClass, browseClass, browseCluster, browseCluster, browseCluster, callbackHookFailure, callbackHookFinalize, callbackHooks, callbackHookSuccess, callOnCloseListeners, callOnDropListeners, callOnOpenListeners, checkForClusterPermissions, checkIfActive, checkOpenness, checkRecordClass, checkSecurity, cleanOutRecord, clearDocumentTracking, close, closeActiveQueries, commit, commit, countClass, countClass, countClass, countView, delete, delete, executeWithRetries, executeWithRetries, executeWithRetries, existsCluster, get, getActiveQueries, getActiveQuery, getBlobClusterIds, getClusterIdByName, getClusterNameById, getClusterNames, getClusters, getCollectionsChanges, getConfiguration, getDatabaseOwner, getDefaultClusterId, getDefaultSerializer, getDictionary, getHooks, getListeners, getLocalCache, getMetadata, getName, getProperties, getProperty, getRecord, getRecordType, getSerializer, getSerializerFactory, getSharedContext, getStatus, getStorageVersions, getTransaction, getType, getUnderlying, getURL, getUser, init, isActiveOnCurrentThread, isClusterEdge, isClusterVertex, isClusterView, isPooled, isPrefetchRecords, isUseLightweightEdges, isValidationEnabled, load, load, load, load, load, load, loadIfVersionIsNotLatest, newBlob, newBlob, newEdge, newEdge, newElement, newElement, newElement, newEmbeddedElement, newEmbeddedElement, newInstance, newInstance, newLightweightEdge, newRegularEdge, newVertex, newVertex, pessimisticLockChecks, queryClosed, queryStarted, rawBegin, registerHook, registerHook, reload, reload, reload, reload, reloadUser, resetInitialization, rollback, rollback, save, save, save, setCurrentDatabaseInThreadLocal, setDatabaseOwner, setDefaultSerializer, setDefaultTransactionMode, setInternal, setPrefetchRecords, setProperty, setSerializer, setStatus, setStatusInternal, setUseLightweightEdges, setUser, setValidationEnabled, swapTx, unregisterHook

Methods inherited from class com.orientechnologies.common.listener.OListenerManger

browseListeners, getListenersCopy, registerListener, resetListeners, unregisterListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabase

createClass, executeWithRetry, getClass, registerListener, unregisterListener

Methods inherited from interface com.orientechnologies.orient.core.db.document.ODatabaseDocument

createClassIfNotExist, createEdgeClass, createVertexClass, newEdge, newVertex, reload

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseDocumentInternal

indexQuery, isRemote, realClose, remoteRollback, reuse

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseInternal

createInterruptTimerTask

Methods inherited from interface com.orientechnologies.orient.core.db.document.OQueryLifecycleListener

queryClosed

Constructor Details

ODatabaseDocumentDistributed

public ODatabaseDocumentDistributed(OStorage storage,
 ODistributedPlugin distributedPlugin)

Method Details

getLocalNodeName

public String getLocalNodeName()

return the name of local node in the cluster

Returns:

the name of local node in the cluster

getActiveDataCenterMap

public Map<String,Set<String>> getActiveDataCenterMap()

returns the data center map for current deploy. The keys are data center names, the values are node names per data center

Returns:

data center map for current deploy

isSharded

public boolean isSharded()

Description copied from interface: ODatabaseInternal

checks the cluster map and tells whether this is a sharded database (ie. a distributed DB where at least two nodes contain distinct subsets of data) or not

Returns:

true if the database is sharded, false otherwise

isDistributed

public boolean isDistributed()

copy

public ODatabaseDocumentInternal copy()

Description copied from class: ODatabaseDocumentEmbedded

Returns a copy of current database if it's open. The returned instance can be used by another thread without affecting current instance. The database copy is not set in thread local.

Specified by:

copy in interface ODatabaseDocumentInternal

Overrides:

copy in class ODatabaseDocumentEmbedded

sync

public boolean sync(boolean forceDeployment,
 boolean tryWithDelta)

Description copied from interface: ODatabaseDocumentInternal

synchronizes current database instance with the rest of the cluster (if in distributed mode).

Returns:

true if the database was synchronized, false otherwise

getHaStatus

public Map<String,Object> getHaStatus(boolean servers,
 boolean db,
 boolean latency,
 boolean messages)

removeHaServer

public boolean removeHaServer(String serverName)

queryOnNode

public OExecutionStream queryOnNode(String nodeName,
 OInternalExecutionPlan executionPlan,
 Map<Object,Object> inputParameters)

Description copied from interface: ODatabaseDocumentInternal

sends an execution plan to a remote node for a remote query execution

Parameters:

nodeName - the node name

executionPlan - the execution plan

inputParameters - the input parameters for execution

Returns:

an OResultSet to fetch the results of the query execution

executeTaskOnNode

public ODistributedResponse executeTaskOnNode(ORemoteTask task,
 String nodeName)

init

public void init(OrientDBConfig config,
 OSharedContext sharedContext)

Overrides:

init in class ODatabaseDocumentEmbedded

createMetadata

protected void createMetadata(OSharedContext ctx)

Overrides:

createMetadata in class ODatabaseDocumentEmbedded

assignAndCheckCluster

public int assignAndCheckCluster(ORecord record,
 String iClusterName)

Specified by:

assignAndCheckCluster in interface ODatabaseDocumentInternal

Overrides:

assignAndCheckCluster in class ODatabaseDocumentAbstract

internalCommit

public void internalCommit(OTransactionInternal iTx)

Description copied from interface: ODatabaseDocumentInternal

Executed the commit on the storage hiding away storage concepts from the transaction

Specified by:

internalCommit in interface ODatabaseDocumentInternal

Overrides:

internalCommit in class ODatabaseDocumentEmbedded

internalCommitPreallocate

public void internalCommitPreallocate(OTransactionOptimistic iTx)

Specified by:

internalCommitPreallocate in interface ODatabaseDocumentInternal

Overrides:

internalCommitPreallocate in class ODatabaseDocumentEmbedded

sendSequenceAction

public <T> T sendSequenceAction(OSequenceAction action)
                         throws ExecutionException,
InterruptedException

Specified by:

sendSequenceAction in interface ODatabaseDocumentInternal

Overrides:

sendSequenceAction in class ODatabaseDocumentEmbedded

Throws:

ExecutionException

InterruptedException

distributedCommitV1

public void distributedCommitV1(OTransactionInternal iTx)

acquireLocksForTx

public void acquireLocksForTx(OTransactionInternal tx,
 ODistributedTxContext txContext,
 boolean isCoordinator,
 boolean force)

Parameters:

tx -

txContext -

isCoordinator - specifies whether this node is the tx coordinator

force - whether to use the force flag for acquiring the promises required for this tx.

beginDistributedTx

public boolean beginDistributedTx(ODistributedRequestId requestId,
 OTransactionIdPromise id,
 OTransactionInternal tx,
 boolean isCoordinator,
 int retryCount)

getDistributedShared

public ODistributedDatabase getDistributedShared()

register

public void register(ODistributedRequestId requestId,
 ODistributedDatabase localDistributedDatabase,
 ODistributedTxContext txContext)

commit2pcLocal

public void commit2pcLocal(ODistributedRequestId transactionId)

The Local commit is different from a remote commit due to local rid pre-allocation

Parameters:

transactionId -

commit2pc

public boolean commit2pc(ODistributedRequestId transactionId,
 boolean isCoordinator,
 ODistributedRequestId requestId)

Parameters:

transactionId -

Returns:

null returned means that commit failed

forceRsync

public void forceRsync()

rollback2pc

public boolean rollback2pc(ODistributedRequestId transactionId)

internalCommit2pc

public void internalCommit2pc(ONewDistributedTxContextImpl txContext)

internalBegin2pc

public void internalBegin2pc(ONewDistributedTxContextImpl txContext,
 boolean isCoordinator)

internalBegin2pc

public void internalBegin2pc(ONewDistributedTxContextImpl txContext,
 boolean isCoordinator,
 boolean force)

Parameters:

txContext -

isCoordinator - specifies whether this node is the tx coordinator

force - whether to use the force flag for acquiring the promises required for this tx.

getViewFromCluster

public OView getViewFromCluster(int cluster)

Specified by:

getViewFromCluster in interface ODatabaseDocumentInternal

Overrides:

getViewFromCluster in class ODatabaseDocumentEmbedded

getEnterpriseEndpoint

public OEnterpriseEndpoint getEnterpriseEndpoint()

Returns:

an endpoint for Enterprise features. Null in Community Edition

getDistributedManager

public ODistributedServerManager getDistributedManager()

getDistributedConfiguration

public ODistributedConfiguration getDistributedConfiguration()

sendDDLCommand

public void sendDDLCommand(String command,
 boolean excludeLocal)

twoPhaseDDL

public void twoPhaseDDL(String command)

addCluster

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

Description copied from interface: ODatabase

Adds a new cluster.

Specified by:

addCluster in interface ODatabase<ORecord>

Overrides:

addCluster in class ODatabaseDocumentEmbedded

Parameters:

iClusterName - Cluster name

iParameters - Additional parameters to pass to the factories

Returns:

Cluster id

addCluster

public int addCluster(String iClusterName,
 int iRequestedId)

Description copied from interface: ODatabase

Adds a new cluster.

Specified by:

addCluster in interface ODatabase<ORecord>

Overrides:

addCluster in class ODatabaseDocumentEmbedded

Parameters:

iClusterName - Cluster name

iRequestedId - requested id of the cluster

Returns:

Cluster id

dropClusterInternal

protected boolean dropClusterInternal(String clusterName)

Overrides:

dropClusterInternal in class ODatabaseDocumentEmbedded

dropClusterInternal

public boolean dropClusterInternal(int clusterId)

Specified by:

dropClusterInternal in interface ODatabaseDocumentInternal

Overrides:

dropClusterInternal in class ODatabaseDocumentEmbedded

isLocalEnv

public boolean isLocalEnv()

freeze

public void freeze(boolean throwException)

Flush all indexes and cached storage content to the disk.

After this call users can perform only select queries. All write-related commands will queued till ODatabaseDocument.release() command will be called or exception will be thrown on attempt to modify DB data. Concrete behaviour depends on throwException parameter.

IMPORTANT: This command is not reentrant.

Specified by:

freeze in interface ODatabase<ORecord>

Specified by:

freeze in interface ODatabaseDocument

Overrides:

freeze in class ODatabaseDocumentEmbedded

Parameters:

throwException - If true OModificationOperationProhibitedException exception will be thrown in case of write command will be performed.

release

public void release()

Description copied from class: ODatabaseDocumentEmbedded

Allows to execute write-related commands on DB. Called after ODatabaseDocument.freeze() command.

Specified by:

release in interface ODatabase<ORecord>

Specified by:

release in interface ODatabaseDocument

Overrides:

release in class ODatabaseDocumentEmbedded

See Also:

• ODatabase.freeze()

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

Overrides:

backup in class ODatabaseDocumentEmbedded

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

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

checkNodeIsMaster

protected void checkNodeIsMaster(String localNodeName,
 ODistributedConfiguration dbCfg,
 String operation)

handleDistributedException

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

getStorageId

public String getStorageId()

getInvolvedClusters

protected Set<String> getInvolvedClusters(Iterable<ORecordOperation> uResult)

syncCommit

public void syncCommit(OTransactionData data)

firstPhaseDDL

public OTransactionResultPayload firstPhaseDDL(String query,
 OTransactionIdPromise preChangeId,
 OTransactionIdPromise afterChangeId,
 ODistributedRequestId requestId)

secondPhaseDDL

public void secondPhaseDDL(ODistributedRequestId confirmSentRequest,
 boolean apply)