Skip to main content

Replication plan

Replication plans for the C++ Replication API

Abstract

A replication plan entity links two DBEngines, so multiple subscriptions (FCREPLSubscription) instances can be part of that in different directions, but all of them must be between the same two DBEngine nodes.

Class

FCREPLReplPlan

A replication plan entity links two DBEngines, so multiple subscriptions (FCREPLSubscription) instances can be part of that in different directions, but all of them must be between the same two DBEngine nodes.

Getters

Table 1. Getters

replication plan status

FCREPLReplStatus GetStatus() { return (FCREPLReplStatus)((pRCESReplPlan)this)->GetStatus(); };

Source DBEngine object

pFCREPLDBEngine GetSourceDBEngine() { return (pFCREPLDBEngine)((pRCESReplPlan)this)->GetSourceDBEngine(); };

Target DBEngine object

pFCREPLDBEngine GetTargetDBEngine() { return (pFCREPLDBEngine)((pRCESReplPlan)this)->GetTargetDBEngine(); };

Replication direction

FCREPLReplDirection GetDirection() { return (FCREPLReplDirection)((pRCESReplPlan)this)->GetDirection(); };



Inherited getters

Table 2. Inherited getters

replication plan identification

int GetID();

replication plan name

char *GetName();

replication plan description

char *GetDescription();

Replication status code

RCESReplStatus GetStatus();

Last time replication plan status has changed

RCESDateTime GetStatusTime();

Message related to the replication plan status

char *GetStatusMsg();

Action identification responsible for the replication plan new status

Note

This is linked to the FCREPLAction class.

int GetStatusActionID();

Source DBEngine identification

Note

This is linked to the FCREPLDBEngine class.

int GetSourceDBEngineID();

Source DBEngine ID

virtual pRCESDBEngine GetSourceDBEngine();

Target DBEngine identification

Note

This is linked to the FCREPLDBEngine class.

int GetTargetDBEngineID();

Target DBEngine

virtual pRCESDBEngine GetTargetDBEngine();

IsSynchronous replication

bool GetIsSync();

Warning threshold

int GetWarningThreshold();

Error threshold

int GetErrorThreshold();

Latency

int GetLatency();

Latency time

RCESDateTime GetLatencyTime();

Latency rev

int GetLatencyRev();

Latency rev time

RCESDateTime GetLatencyRevTime();

File mask

char *GetFileMask();

Return if the replication plan has already been deployed

bool GetIsDeployed();

Return if the replication plan is pulling (agent running on target)

bool GetIsPulling();

Return if the replication plan is transforming partitioned source files into non-partitioned target files

bool GetIgnorePartition();

Return if during the deploy we are copying only the data files and index will be rebuilt

bool GetRebuildOnDeploy();

Source transaction log position

char *GetSourceLogPos();

Target transaction log position

char *GetTargetLogPos();

Source transaction ID

char *GetSourceTranID();

Target transaction ID

char *GetTargetTranID();

Source Replication Manager agent identification

Note

This is linked to the FCREPLDBAgent class.

int GetSourceAgentID();

Target Replication Manager agent identification

Note

This is linked to the FCREPLDBAgent class.

int GetTargetAgentID();

Return if the replication monitor feature is active

bool GetIsMonitorActive();

Time that the replication monitor has been enabled or disabled

RCESDateTime GetMonitorTime();

Direction

RCESReplDirection GetDirection();

Refresh rate

int GetRefreshRate();

Return if the replication exception log monitor is active

bool GetIsExcepLogActive();

Time that the replication exception log monitor has been enabled or disabled

RCESDateTime GetExcepLogTime();

Return if the replication function profiling is active

bool GetIsFuncTimeActive();

Time that the replication function profiling has been enabled or disabled

RCESDateTime GetFuncTimeTime();

Return if the replication is paused

bool GetIsPaused();

Time that the replication has been paused or resumed

RCESDateTime GetPauseTime();

Replication has a filter on the source file to be replicated

bool IsFiltered();

File name with the replication file filter

char *GetFileFilter();

Flag indicating if replication plan any non-acknowledged exception

bool HasNAckExcep();

Flag indicating if replication plan is during an exception dump process

bool IsInExceptionDump();

Return if the replication has an agent running on the source node

bool HasAgentOnSource();

Return if the replication has an agent running on the target node

bool HasAgentOnTarget();

Replication batch size (batch_size)

Note

This is a c-tree replication-specific setup.

int GetBatchSize();

Replication debug minimum log position (dbgminlog)

Note

This is a c-tree replication-specific setup.

bool GetDebugMinLog();

Replication exception mode (exception_mode)

Note

This is a c-tree replication-specific setup.

int GetExceptionMode();

Replication lock retry count (lock_retry_count)

Note

This is a c-tree replication-specific setup.

int GetLockRetryCount();

Replication lock retry sleep (lock_retry_sleep)

Note

This is a c-tree replication-specific setup.

int GetLockRetrySleep();

Replication log change details (log_change_details)

Note

This is a c-tree replication-specific setup.

char *GetLogChangeDetails();

Replication read timeout (read_timeout_ms)

Note

This is a c-tree replication-specific setup.

int GetReadTimeout();

Replication remember log position (remember_log_pos)

Note

This is a c-tree replication-specific setup.

bool GetRememberLogPos();

Replication conflict detection (check_update)

Note

This is a c-tree replication-specific setup.

bool GetConflictDetection();



Setters

Table 3. Setters

replication plan status

void SetStatus(FCREPLReplStatus status) { ((pRCESReplPlan)this)->SetStatus((RCESReplStatus)status); };

Source DBEngine object

void SetSourceDBEngine(pFCREPLDBEngine sourceDBEngine) { ((pRCESReplPlan)this)->SetSourceDBEngine((pRCESDBEngine)sourceDBEngine); };

Target DBEngine object

void SetTargetDBEngine(pFCREPLDBEngine targetDBEngine) { ((pRCESReplPlan)this)->SetTargetDBEngine((pRCESDBEngine)targetDBEngine); };

replication plan name

void SetName(const char *name) { ((pRCESReplPlan)this)->SetName(name); };

replication plan description

void SetDescription(const char *description) { ((pRCESReplPlan)this)->SetDescription(description); };

Message related to the replication plan status

void SetStatusMsg(const char *statusMsg) { ((pRCESReplPlan)this)->SetStatusMsg(statusMsg); };

Source transaction log position

void SetSourceLogPos(const char *sourceLogPos) { ((pRCESReplPlan)this)->SetSourceLogPos(sourceLogPos); };

Target transaction log position

void SetTargetLogPos(const char *targetLogPos) { ((pRCESReplPlan)this)->SetTargetLogPos(targetLogPos); };

File name with the replication file filter

void SetFileFilter(const char *fileFilter) { ((pRCESReplPlan)this)->SetFileFilter(fileFilter); };

Replication log change details (log_change_details)

void SetLogChangeDetails(const char *logChangeDetails) { ((pRCESReplPlan)this)->SetLogChangeDetails(logChangeDetails); };



Inherited setters

Table 4. Inherited setters

replication plan identification

void SetID(int id);

replication plan name

void SetName(const char *name);

replication plan description

void SetDescription(const char *description);

replication plan status

void SetStatus(RCESReplStatus status);

Last time replication plan status had changed

void SetStatusTime(RCESDateTime statusTime);

replication plan message

void SetStatusMsg(const char *statusMsg);

Action identification responsible for the replication plan new status

Note

This is linked for FCREPLAction class.

void SetStatusActionID(int statusActionID);

Source DBEngine identification

Note

This is linked to FCREPLDBEngine class.

Source DBEngine

void SetSourceDBEngine(pRCESDBEngine sourceDBEngine);

Target DBEngine identification

Note

This is linked to FCREPLDBEngine class.

void SetTargetDBEngineID(int targetDBEngineID);

Target DB engine

void SetTargetDBEngine(pRCESDBEngine targetDBEngine);

Is sychronous replication

void SetIsSync(bool isSync);

Warning threshold

void SetWarningThreshold(int warningThreshold);

Error threshold

void SetErrorThreshold(int errorThreshold);

Latency

void SetLatency(int latency);

Latency time

void SetLatencyTime(RCESDateTime latencyTime);

Latency rev

void SetLatencyRev(int latencyRev);

Latency rev time

void SetLatencyRevTime(RCESDateTime latencyRevTime);

Log change details

void SetLogChangeDetails(const char *logChangeDetails);

Parallel apply

void SetParallelApply(bool parallelApply);

Check dependencies

void SetCheckDependencies(bool checkDependencies);

Sync log writes

void SetSyncLogWrites(bool syncLogWrites);

Analyzer threads count

void SetAnalyzerThreadsCount(int analyzerThreadsCount);

Apply threads count

void SetApplyThreadsCount(int applyThreadsCount);

File mask

void SetFileMask(const char *fileMask);

Return if the replication plan has already been deployed

void SetIsDeployed(bool isDeployed);

Return if the replication plan is pulling (agent running on target)

void SetIsPulling(bool isPulling);

replication plan is pulling (agent running on target)

void SetIsPulling(bool isPulling);

replication plan is transforming partitioned source files into non-partitioned target files

void SetIgnorePartition(bool ignorePartition);

replication plan is transforming partitioned source files into non-partitioned target files

void SetIgnorePartition(bool ignorePartition);

Return if during the deployment only the data files are copied and the index will be rebuilt

void SetRebuildOnDeploy(bool rebuildOnDeploy);

Source log position

void SetSourceLogPos(const char *sourceLogPos);

Target log position

void SetTargetLogPos(const char *targetLogPos);

Source transaction ID

void SetSourceTranID(const char *sourceTranID);

Target transaction ID

void SetTargetTranID(const char *targetTranID);

Source Replication Manager agent identification

Note

This is linked to FCREPLDBAgent class.

void SetSourceAgentID(int sourceAgentID);

Target Replication Manager agent identification

Note

This is linked to FCREPLDBAgent class.

void SetTargetAgentID(int targetAgentID);

Replication direction

void SetDirection(ppRCESSubscription subsList, int subsCount);

Return if the replication monitor feature is active

void SetIsMonitorActive(bool isMonitorActive);

Time that the replication monitor has been enabled or disabled

void SetMonitorTime(RCESDateTime monitorTime);

Replication refresh rate

void SetRefreshRate(int refreshRate);

Return if the replication exception log monitor is active

void SetIsExcepLogActive(bool isExcepLogActive);

Time that the replication exception log monitor has been enabled or disabled

void SetExcepLogTime(RCESDateTime excepLogTime);

Return if the replication function profiling is active

void SetIsFuncTimeActive(bool isFuncTimeActive);

Time that the replication function profiling has been enabled or disabled

void SetFuncTimeTime(RCESDateTime funcTimeTime);

Return if the replication is paused

void SetIsPaused(bool isPaused);

Time that the replication has been paused or resumed

void SetPauseTime(RCESDateTime pausedTime);

Replication has a filter on the source file to be replicated

void SetIsFiltered(bool isFiltered);

Replication file filter

void SetFileFilter(const char *fileFilter);

Flag indicating if the replication plan contains any non-acknowledged exceptions

void SetHasNAckExcep(bool hasNAckExcep);

Flag indicating if the replication plan is amid an exception dump process

void SetIsInExceptionDump(bool isInExceptionDump);

Replication batch size (batch_size)

Note

This c-tree replication-specific setup.

void SetBatchSize(int batchSize);

Replication debug minimum log position (dbgminlog)

Note

This c-tree replication-specific setup.

void SetDebugMinLog(bool debugMinLog);

Replication exception mode (exception_mode)

Note

This c-tree replication-specific setup.

void SetExceptionMode(int exceptionMode);

Replication lock retry count (lock_retry_count)

Note

This c-tree replication-specific setup.

void SetLockRetryCount(int lockRetryCount);

Replication lock retry sleep (lock_retry_sleep)

Note

This c-tree replication-specific setup.

void SetLockRetrySleep(int lockRetrySleep);

Replication read timeout (read_timeout_ms)

Note

This c-tree replication-specific setup.

void SetReadTimeout(int readTimeout);

Replication remember log position (remember_log_pos)

Note

This c-tree replication-specific setup.

void SetRememberLogPos(bool rememberLogPos);

Replication conflict detection (check_update)

Note

This c-tree replication-specific setup.

void SetConflictDetection(bool conflictDetection);



Class

FCREPLReplStat

A replication plan statistic entity has a set of monitoring information specific for a given replication plan.

Getters

Table 5. Getters

replication plan direction (original or reverse)

FCREPLReplicationDirection GetDirection() { return (FCREPLReplicationDirection)((pRCESReplStat)this)->GetDirection(); };

replication plan state

FCREPLReplicationState GetState() { return (FCREPLReplicationState)((pRCESReplStat)this)->GetState(); };



Inherited getters

Table 6. Inherited getters

replication plan identification

Note

This is linked to FCREPLReplPlan class.

int GetReplPlanID();

Direction

RCESReplicationDirection GetDirection();

Statistic time

RCESDateTime GetTime();

Return if source DBEngine is connected

bool GetIsSourceDBConnected();

Return if target DBEngine is connected

bool GetIsTargetDBConnected();

Transaction log file number

int GetLogNumber();

Transaction log position

int GetLogPosition();

State

RCESReplicationState GetState();

Statistic sequence number

RCESBigInt GetSequenceNumber();

Statistic function name

char *GetFunctionName();

Number of CommitPass

RCESBigInt GetCommitPass();

Number of AddPass

RCESBigInt GetAddPass();

Number of DeletePass

RCESBigInt GetDeletePass();

Number of UpdatePass

RCESBigInt GetUpdatePass();

Number of CommitFail

RCESBigInt GetCommitFail();

Number of AddFail

RCESBigInt GetAddFail();

Number of DeleteFail

RCESBigInt GetDeleteFail();

Number of UpdateFail

RCESBigInt GetUpdateFail();

Replication latency

int GetLatency();



Setters

Table 7. Setters

replication plan direction (original or reverse)

void SetDirection(FCREPLReplicationDirection direction) { ((pRCESReplStat)this)->SetDirection((RCESReplicationDirection)direction); };

replication plan state

void SetState(FCREPLReplicationState state) { ((pRCESReplStat)this)->SetDirection((RCESReplicationDirection)state); };

Statistic function name

void SetFunctionName(const char *functionName) { ((pRCESReplStat)this)->SetFunctionName(functionName); };



Inherited setters

Table 8. Inherited setters

replication plan identification

Note

This is linked to the FCREPLReplPlan class.

void SetReplPlanID(int replPlanID);

Direction

void SetDirection(RCESReplicationDirection direction);

Statistic time

void SetTime(RCESDateTime time);

Return if source DBEngine is connected

void SetIsSourceDBConnected(bool isSourceDBConnected);

Return if target DBEngine is connected

void SetIsTargetDBConnected(bool isTargetDBConnected);

Transaction log file number

void SetLogNumber(int logNumber);

Transaction log position

void SetLogPosition(int logPosition);

State

void SetState(RCESReplicationState state);

Statistic sequence number

void SetSequenceNumber(RCESBigInt sequenceNumber);

Function name

void SetFunctionName(const char *functionName);

Number of commitPass

void SetCommitPass(RCESBigInt commitPass);

Number of addPass

void SetAddPass(RCESBigInt addPass);

Number of deletePass

void SetDeletePass(RCESBigInt deletePass);

Number of updatePass

void SetUpdatePass(RCESBigInt updatePass);

Number of commitFail

void SetCommitFail(RCESBigInt commitFail);

Number of addFail

void SetAddFail(RCESBigInt addFail);

Number of deleteFail

void SetDeleteFail(RCESBigInt deleteFail);

Number of updateFail

void SetUpdateFail(RCESBigInt updateFail);

Replication latency

void SetLatency(int latency);



Class

FCREPLReplParallelStat

A replication plan statistic entity has a set of monitoring information specific for a given replication plan.

Getters

Table 9. Getters

replication plan direction (original or reverse)

FCREPLReplicationDirection GetDirection() { return (FCREPLReplicationDirection)((pRCESReplParallelStat)this)->GetDirection(); };

Replication LogShip state

FCREPLReplicationState GetLogShipState() { return (FCREPLReplicationState)((pRCESReplParallelStat)this)->GetLogShipState(); };

Replication LogRead state

FCREPLReplicationState GetLogReadState() { return (FCREPLReplicationState)((pRCESReplParallelStat)this)->GetLogReadState(); };

Replication dependency state

FCREPLReplicationState GetDependencyState() { return (FCREPLReplicationState)((pRCESReplParallelStat)this)->GetDependencyState(); };

Replication analyzer list

ppFCREPLReplParallelAnalyzer GetAnalyzerList() { return (ppFCREPLReplParallelAnalyzer)((pRCESReplParallelStat)this)->GetAnalyzerList(); };

Replication apply list

ppFCREPLReplParallelApply GetApplyList() { return (ppFCREPLReplParallelApply)((pRCESReplParallelStat)this)->GetApplyList(); };



Setters

Table 10. Setters

replication plan direction (original or reverse)

void SetDirection(FCREPLReplicationDirection direction) { ((pRCESReplParallelStat)this)->SetDirection((RCESReplicationDirection)direction); };

Replication LogShip state

void SetLogShipState(FCREPLReplicationState state) { ((pRCESReplParallelStat)this)->SetLogShipState((RCESReplicationState)state); };

Replication LogRead state

void SetLogReadState(FCREPLReplicationState state) { ((pRCESReplParallelStat)this)->SetLogReadState((RCESReplicationState)state); };

Replication dependency state

void SetDependencyState(FCREPLReplicationState state) { ((pRCESReplParallelStat)this)->SetDependencyState((RCESReplicationState)state); };

Replication analyzer list

void SetAnalyzerList(ppFCREPLReplParallelAnalyzer analyzerList) { ((pRCESReplParallelStat)this)->SetAnalyzerList((ppRCESReplParallelAnalyzer)analyzerList); };

Replication apply list

void SetApplyList(ppFCREPLReplParallelApply applyList) { ((pRCESReplParallelStat)this)->SetApplyList((ppRCESReplParallelApply)applyList); };



Class

FCREPLReplParallelAnalyzer

A replication plan analyzer statistic entity has a set of monitoring information specific to a given replication plan.

Getters

Table 11. Getters

Replication state

FCREPLReplicationState GetState() { return (FCREPLReplicationState)((pRCESReplParallelAnalyzer)this)->GetState(); };



Setters

Table 12. Setters

Replication state

void SetState(FCREPLReplicationState state) { ((pRCESReplParallelAnalyzer)this)->SetState((RCESReplicationState)state); };



Class

FCREPLReplParallelApply

A replication plan apply statistic entity has a set of monitoring information specific to a given replication plan.

Getters

Table 13. Getters

Replication state

FCREPLReplicationState GetState() { return (FCREPLReplicationState)((pRCESReplParallelApply)this)->GetState(); };



Setters

Table 14. Setters

Replication state

void SetState(FCREPLReplicationState state) { ((pRCESReplParallelApply)this)->SetState((RCESReplicationState)state); };



Class

FCREPLReplExcep

A replication plan exception entity has an exception event detail information for a replication plan.

Getters

Table 15. Getters

replication plan direction (original or reverse)

FCREPLReplicationDirection GetDirection() { return (FCREPLReplicationDirection)((pRCESReplExcep)this)->GetDirection(); };



Inherited getters

Table 16. Inherited getters

replication plan identification

Note

This is linked to FCREPLReplPlan class.

int GetReplPlanID();

Replication direction

RCESReplicationDirection GetDirection();

Replication exception sequence number

RCESBigInt GetSequenceNumber();

Replication exception time

RCESDateTime GetTime();

Transaction number

RCESBigInt GetTransactionNumber();

Transaction log entry time

RCESDateTime GetLogEntryTime();

Transaction log file number

int GetLogNumber();

Transaction log position

int GetLogPosition();

File identification

int GetFileID();

Replication operation name

const char *GetOperation();

Exception error code

int GetErrorCode();

File name

const char *GetFileName();



Setters

Table 17. Setters

replication plan direction (original or reverse)

void SetDirection(FCREPLReplicationDirection direction) { ((pRCESReplExcep)this)->SetDirection((RCESReplicationDirection)direction); };

Replication operation name

void SetOperation(const char *operation) { ((pRCESReplExcep)this)->SetOperation(operation); };

File name

void SetFileName(const char *fileName) { ((pRCESReplExcep)this)->SetFileName(fileName); };



Inherited setters

Table 18. Inherited setters

replication plan identification

Note

This is linked to FCREPLReplPlan class.

void SetReplPlanID(int replPlanID);

Replication direction

void SetDirection(RCESReplicationDirection direction);

Replication exception sequence number

void SetSequenceNumber(RCESBigInt sequenceNumber);

Replication exception time

void SetTime(RCESDateTime time);

Transaction number

void SetTransactionNumber(RCESBigInt transactionNumber);

Transaction log entry time

void SetLogEntryTime(RCESDateTime logEntryTime);

Transaction log file number

void SetLogNumber(int logNumber);

Transaction log position

void SetLogPosition(int logPostion);

File identification

void SetFileID(int fileID);

Operation

void SetOperation(const char *operation);

Exception error code

void SetErrorCode(int errorCode);

File name

void SetFileName(const char *fileName);



Class

FCREPLReplFunc

A replication plan function timing entity has the profiling information by function call for a specific replication plan.

Getters

Getters are not applicable.

Inherited getters

Table 19. Inherited getters

Replication function name

const char *GetName();

Total percentage of time spent on this function

int GetTotalPercent();

Total time spent on this function

RCESBigInt GetTotalTime();

Number of calls for this function

RCESBigInt GetCalls();

Average time spent on this function call

RCESBigInt GetAverageTime();



Setters

Table 20. Setters

Replication function name

void SetName(const char *name) { ((pRCESReplFunc)this)->SetName(name); };



Inherited setters

Table 21. Inherited setters

Name

void SetName(const char *name);

Total percentage of time spent on this function

void SetTotalPercent(int totalPercent);

Total time spent on this function

void SetTotalTime(RCESBigInt totalTime);

Number of calls for this function

void SetCalls(RCESBigInt calls);

Average time spent on this function call

void SetAverageTime(RCESBigInt averageTime);



Class

FCREPLReplAgent

A Replication Agent entity refers to an existing Replication Agent physically set based on the previous technology (ctreplagent).

Getters

Getters are not applicable.

Inherited getters

Table 22. Inherited getters

Action identification for the Replication Agent

Note

This is linked to the

FCREPLAction class.

int GetActionID();

Replication Agent opSystem identification

Note

This is linked to the FCREPLOpSystem class.

int GetOSID();

Replication Agent path

const char *GetPath();

Replication Agent name

const char *GetName();

Source server connection string

const char *GetSourceServer();

Target server connection string

const char *GetTargetServer();

Source server node identification

const char *GetSourceNodeID();

Source server node identification

const char *GetTargetNodeID();

Error code

RCESRET GetErrorCode();

Error message

const char *GetErrorMsg();

replication plan name

const char *GetReplPlanName();

replication plan description

const char *GetReplPlanDesc();

Publication identification

Note

This is linked to the FCREPLPublication class.

int GetPubID();

Publication name

const char *GetPubName();

Publication description

const char *GetPubDesc();

Publication database identification

Note

This is linked to the FCREPLPublication class.

int GetPubDatabaseID();

Subscription name

const char *GetSubsName();

Subscription description

const char *GetSubsDesc();

Subscription database identification

Note

This is linked to the FCREPLDatabase class.

int GetSubsDatabaseID();



Setters

Table 23. Setters

Replication Agent path

void SetPath(const char *path) { ((pRCESReplAgent)this)->SetPath(path); };

Replication Agent name

void SetName(const char *name) { ((pRCESReplAgent)this)->SetName(name); };

Source server connection string

void SetSourceServer(const char *sourceServer) { ((pRCESReplAgent)this)->SetSourceServer(sourceServer); };

Target server node identification

void SetTargetServer(const char *targetServer) { ((pRCESReplAgent)this)->SetTargetServer(targetServer); };

Source server node identification

void SetSourceNodeID(const char *sourceNodeID) { ((pRCESReplAgent)this)->SetSourceNodeID(sourceNodeID); };

Target server node identification

void SetTargetNodeID(const char *targetNodeID) { ((pRCESReplAgent)this)->SetTargetNodeID(targetNodeID); };

Error message

void SetErrorMsg(const char *errorMsg) { ((pRCESReplAgent)this)->SetErrorMsg(errorMsg); };



Inherited setters

Table 24. Inherited setters

Action identification for the Replication Agent

Note

This is linked to the FCREPLAction class.

void SetActionID(int actionID);

Replication Agent opSystem identification

Note

This is linked to the FCREPLOpSystem class.

void SetOSID(int osID);

Path

void SetPath(const char *path);

Name

void SetName(const char *name);

Source server

void SetSourceServer(const char *sourceServer);

Target server

void SetTargetServer(const char *targetServer);

Source node ID

void SetSourceNodeID(const char *sourceNodeID);

Target node ID

void SetTargetNodeID(const char *targetNodeID);

Error code

void SetErrorCode(RCESRET errorCode);

Error message

void SetErrorMsg(const char *errorMsg);



Retrieve all the replication plan entity objects.

Prototype

FCREPL_API int fcReplGetReplPlans(pFCREPLConn replConn, ppFCREPLReplPlan *replPlanList, int *replPlanCount);

Parameters

Table 25. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanList [OUT]

Replication plan entity list

replPlanCount [OUT]

Number of replication plan entities in the list



Return

Error code

Add a replication plan entity into the database. If there already is a replication plan with the given name, update the existing record.

Prototype

FCREPL_API int fcReplPersistReplPlan(pFCREPLConn replConn, pFCREPLReplPlan replPlan);

Parameters

Table 26. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlan [IN]

replication plan entity to be persisted



Return

Error code

Delete the replication plan by its identification.

Prototype

FCREPL_API int fcReplRemoveReplPlan(pFCREPLConn replConn, int replPlanID, bool recursive);

Parameters

Table 27. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

replication plan identification

recursive [IN]

Recursive flag



Return

Error code

Deploy an existing replication plan. Make sure that the target file is up-to-dated and then start the replication.

Prototype

FCREPL_API int fcReplDeploy(pFCREPLConn replConn, int replPlanID, bool forceReplace, int *actionID);

Parameters

Table 28. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification

forceReplace [IN]

Flag indicating that we should replace existing target files

actionID [OUT]

Action identification for the FS load action



Return

Error code

Start an existing replication plan already deployed.

Prototype

FCREPL_API int fcReplStart(pFCREPLConn replConn, int replPlanID, const char *sourceLogPos, const char *targetLogPos, bool ignoreDeploy, int *actionID);

Parameters

Table 29. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification

sourceLogPos [IN]

Source log position to start at

targetLogPos [IN]

Target log position to start at

ignoreDeploy [IN]

Flag indicating if we should check that the Replication has been deployed before starting it

actionID [OUT]

Action identification for the FS load action



Return

Error code

Stop an existing replication plan already deployed/started.

Prototype

FCREPL_API int fcReplStop(pFCREPLConn replConn, int replPlanID, int *actionID);

Parameters

Table 30. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification

actionID [OUT]

Action identification for the FS load action



Return

Error code

Check if the replication deployed is ok or has any errors.

Prototype

FCREPL_API int fcReplCheck(pFCREPLConn replConn, int replPlanID, bool checkConn, ppFCREPLReplPlan *replPlanList, int *replPlanCount, int *actionID);

Parameters

Table 31. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification

checkConn [IN]

Check connection flag

replPlanList [OUT]

replication plan list entity object

replPlanCount [OUT]

Number of replication plan objects in the list

actionID [OUT]

Action identification returned in case of checkConnection for all the replication plans



Return

Error code

Cancel the current replication plan action for deployment or start or stop.

Prototype

FCREPL_API int fcReplCancel(pFCREPLConn replConn, int replPlanID, int actionID);

Parameters

Table 32. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification

actionID [IN]

Replication action identification



Return

Error code

Start monitoring a replication plan. It starts loading some statistics snapshots by a frequency defined by refreshRate and also all the exception logs that happened to start at the current time into the Replication Manager. If the replication plan is bi-directional, it will start monitoring both directions.

Prototype

FCREPL_API int fcReplStartMonitor(pFCREPLConn replConn, int replPlanID, int refreshRate);

Parameters

Table 33. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification

refreshRate [IN]

Refresh rate in seconds use for determining the frequency of the logged statistics snapshots



Return

Error code

Stop monitoring a replication plan. The history of what has already been monitored will be kept in Replication Manager, but from this point, it will stop logging snapshots, If the replication plan is bi-directional, it will stop monitoring both directions.

Prototype

FCREPL_API int fcReplStopMonitor(pFCREPLConn replConn, int replPlanID);

Parameters

Table 34. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Retrieve the statistics for the replication plan for a given period of time. The snapshot is retrieved for direct, reverse, or both directions.

Prototype

FCREPL_API int fcReplGetStats(pFCREPLConn replConn, int replPlanID, FCREPLDateTime begin, FCREPLDateTime end, int statListSize, int statStart, ppFCREPLReplStat *statList, int *statCount, int *totalReplStats);

Parameters

Table 35. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

replication plan identification

begin [IN]

Begin time for the statistics retrieval

end [IN]

End time for the statistics retrieval

statListSize [IN]

Statistics list count to be retrieved

statStart [IN]

Statistics list start record

statList [OUT]

Statistics entity list

statCount [OUT]

Number of statistics entities in the list

totalReplStats [OUT]

Total statistics



Return

Error code

Start logging replication plan's exceptions. It starts loading all the exceptions from the given replication plan into Replication Manager. This status is stored in the replication plan's table. It is started by default when the replication plan is started.

Prototype

FCREPL_API int fcReplStartExcepLog(pFCREPLConn replConn, int replPlanID);

Parameters

Table 36. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Stop logging a replication plan's exceptions. The history of what has already been logged will be kept in the Replication Manager, but from this point, it will stop logging exceptions.

Prototype

FCREPL_API int fcReplStopExcepLog(pFCREPLConn replConn, int replPlanID);

Parameters

Table 37. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Retrieve the exceptions for the replication plan for a given period of time. The snapshot is retrieved for direct, reverse, or both directions.

Prototype

FCREPL_API int fcReplGetExceptions(pFCREPLConn replConn, int replPlanID, FCREPLDateTime begin, FCREPLDateTime end, int excepListSize, int excepStart, ppFCREPLReplExcep *excepList, int *excepCount, int *totalReplExceps);

Parameters

Table 38. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

replication plan identification

begin [IN]

Begin time for the statistics retrieval

end [IN]

End time for the statistics retrieval

excepListSize [IN]

Exception list count to be retrieved

excepStart [IN]

Exception list start record

excepList [OUT]

Exception entity list

excepCount [OUT]

Number of exception entities in the list

totalReplExceps [OUT]

Total exceptions



Return

Error code

Start collecting function timing for a given replication plan execution.

Prototype

FCREPL_API int fcReplPlanFuncTimeStart(pFCREPLConn replConn, int replPlanID);

Parameters

Table 39. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Stop collecting Function Timing for a given replication plan execution.

Prototype

FCREPL_API int fcReplPlanFuncTimeStop(pFCREPLConn replConn, int replPlanID);

Parameters

Table 40. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Reset the function timing information collected for a given replication plan execution.

Prototype

FCREPL_API int fcReplPlanFuncTimeReset(pFCREPLConn replConn, int replPlanID);

Parameters

Table 41. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Retrieve the function timing information for a given replication plan execution.

Prototype

FCREPL_API int fcReplPlanGetFuncTimes(pFCREPLConn replConn, int replPlanID, ppFCREPLReplFunc *sourceFuncList, int *sourceFuncCount, ppFCREPLReplFunc *targetFuncList, int *targetFuncCount);

Parameters

Table 42. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

replication plan identification

sourceFuncList [OUT]

Source function timing list

sourceFuncCount [OUT]

Source function timing count

targetFuncList [OUT]

Target function timing list

targetFuncCount [OUT]

Target function timing count



Return

Error code

Pause a given replication plan execution.

Prototype

FCREPL_API int fcReplPlanPause(pFCREPLConn replConn, int replPlanID);

Parameters

Table 43. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Resume a given replication plan execution.

Prototype

FCREPL_API int fcReplPlanResume(pFCREPLConn replConn, int replPlanID);

Parameters

Table 44. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Retrieve the next available default name for a replication plan.

Prototype

FCREPL_API int fcReplGetTempName(pFCREPLConn replConn, char *tempReplPlanName);

Parameters

Table 45. Parameters

Parameter

Description

replConn [IN] -

Replication connection handle

tempReplPlanName [OUT]

JSON with the temporary replication plan name



Return

Error code

Retrieve all the current Replication Agents by the given criteria.

Prototype

FCREPL_API int fcReplScanAgent(pFCREPLConn replConn, int osID, const char *basePath, ppFCREPLReplAgent *replAgentList, int *replAgentCount);

Parameters

Table 46. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

osID [IN]

OpSystem identification

basePath [IN]

Base path to start the scan

replAgentList [OUT]

Replication agent list

replAgentCount [OUT]

Number of Replication Agents in the list



Return

Error code

Import a list of Replication Agent setups into Replication Manager.

Prototype

FCREPL_API int fcReplImportAgent(pFCREPLConn replConn, bool simpleMode, ppFCREPLReplAgent replAgentList, int replAgentCount);

Parameters

Table 47. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

simpleMode [IN]

Flag indicating if the import is supposed to be executed for simple mode (some default values are assumed)

replAgentList [INOUT]

Replication Agent list

replAgentCount [INOUT]

Number of Replication Agents in the list



Return

Error code

Acknowledge all the Replication exceptions up to the current moment of a given replication plan execution.

Prototype

FCREPL_API int fcReplAckExceptions(pFCREPLConn replConn, int replPlanID);

Parameters

Table 48. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Existing replication plan identification



Return

Error code

Resync of published files.

Prototype

FCREPL_API int fcReplResyncFiles(pFCREPLConn replConn, int replPlanID, int *fileIDList, int fileCount, int *actionID);

Parameters

Table 49. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

replication plan identification

fileIDList [IN]

Existing published file identification list

fileCount [IN]

Number of published files to be added

actionID [OUT]

Action identification for the resync action



Return

Error code

Retrieve all the archived replication plan entity objects.

Prototype

FCREPL_API int fcReplGetArchivedReplPlans(pFCREPLConn replConn, ppFCREPLReplPlan *replPlanList, int *replPlanCount);

Parameters

Table 50. Parameters

Parameter

Description

replPlanList [OUT]

replication plan entity list

replPlanList [OUT]

replication plan entity list

replPlanCount [OUT]

Number of replication plan entities in the list



Return

Error code

Archive replication plan.

Prototype

FCREPL_API int fcReplPlanArchive(pRCESConn replConn, int replPlanID);

Parameters

Table 51. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

Replication plan identification



Return

Error code

Restore replication plan.

Prototype

FCREPL_API int fcReplPlanRestore(pRCESConn replConn, int replPlanID);

Parameters

Table 52. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

replPlanID [IN]

replication plan identification



Return

Error code