HSynchronizeReplica (Function)

AYUDA EN LÍNEA
WINDEV, WEBDEV Y WINDEV MOBILE

Versión:

Inicio | Iniciar sesión | Español

Este contenido se ha traducido automáticamente. Haga clic aquí para ver la versión en inglés.

Ayuda / WLanguage / Administrar bases de datos / HFSQL / Funciones HFSQL

Which data files can be replicated?
Synchronization parameters
Locking records during the log-based replication
Duplicate errors and/or integrity errors
Variables automatically initialized in the WLanguage procedure
Example: Replicating the data even if a conflict occurred (using a WLanguage procedure):
Replication and WithSpace function
Lifespan of movable replica
Replication and filter

WINDEV

WEBDEV

WINDEV Mobile

Otros

Ver también

HSynchronizeReplica (Function)

No disponible con estos tipos de conexión

Synchronizes master and subscriber replicas: operations performed on one replica are transferred to the other.

This function can be used in a log-based replication (between HFSQL data files) or in a universal replication.

Remarks:

For a log-based replication, only the data files in the analysis with the option "Manage the replication for this file" checked will be taken into account.
Only the universal replication operates with the HFSQL Client/Server data files.
Only universal replication is available.

Advertencia
A partir de la versión 17, the replication files created with an application or a site in version 17 (or later) cannot be handled by an application or a site in version 16 (or earlier).
The applications or the sites in version 17 (or later) continue to handle the replication files created with an application or a site in version 16 (or earlier).

Ejemplo

Ver ejemplos adicionales

// "Entering Orders" application for salesmen
// "[Enter the orders in the database]" button
// (the database is found on "X:\CORPDATA")
HSynchronizeReplica("X:\CORPDATA", "C:\SUBSCRIBER", rplToMaster)

// "Catalog" application for salesmen
// "[Retrieve the new references]" button
// (the database is found on "X:\CORPDATA")
HSynchronizeReplica("X:\CORPDATA", "", rplToSubscriber)

// In Montpellier: Preparing to send messages to Paris
HCreateMovableReplica("P:\MSG\MSG.rpm", "Paris", "C:\Temp\MsgMPL.WDZ")
// Send the file (by FTP for example)
FTPSend(ConnectionNum, "c:\temp\MsgMPL.WDZ", "FTP.PCSOFT_PARIS.FR\MSG\MsgMPL.WDZ") 
----------------
// In Paris: Message recovery from Montpellier
HSynchronizeReplica("Z:\MSG", "\\FTPSERVER\MSG\MsgMPL.WDZ", rplToMaster)

Sintaxis

Synchronization with automatic conflict management Ocultar los detalles

<Result> = HSynchronizeReplica(<Master replica> , <Subscriber replica> , <Replication direction> [, <Management of conflicts>])

<Result>: Boolean

True if the operation was successful,
False otherwise.

<Master replica>: Character string

Location of the master replica. Depending on the replication type and direction, this parameter can correspond to:
the path of the replication file (xxxx.rpm file) for the master database.
the name of the movable file created by HCreateMovableReplica.
an empty string (""). The current data files are considered as the master database. The file corresponding to the master replica (".rpm" file) is searched in the replication directory specified in the analysis (by default, RPL subdirectory of the data files), or in the directory specified with HChangeRplDir.
In most cases, this path corresponds either to the full path of a file located in a network directory, or to the path of a movable replica (USB key, email attachment, file retrieved by FTP).
For more details, see remarks.

<Subscriber replica>: Character string

Location of the subscriber replica. Depending on the replication type and direction, this parameter can correspond to:
the path of replication file (xxxx.rpl file) for the subscriber database.
the name of the movable file created by HCreateMovableReplica
an empty string (""). The current data files are considered as being the subscriber database. The file corresponding to the subscriber replica (".rpl" file) is searched in the replication directory specified in the analysis (by default, RPL subdirectory of the data files), or in the directory specified with HChangeRplDir.
In most cases, this path corresponds either to the full path of a file located in a network directory, or to the path of a movable replica (USB key, email attachment, file retrieved by FTP).
For more details, see remarks.

<Replication direction>: Integer constant

Direction in which the replication will be performed:
rplBidirectional Update the master database AND the subscriber database.

Universal replication: bidirectional replication is not available.
rplToMaster Update the master database according to the subscriber database.

<Master replica> corresponds to the master replica, <Subscriber replica> corresponds to the movable replica created from the subscriber database.
rplToSubscriber Update the subscriber database according to the master database.

<Master replica> corresponds to the movable replica created from the master database, <Subscriber replica> corresponds to the subscriber replica

<Management of conflicts>: Optional Integer constant

Constant indicating the management mode of conflicts:
rplMasterFirst
(Default value) The data found in the master database has priority during the replication.
rplMostRecentFirst The most recent data has priority. Caution, the most recent data is evaluated according to the time on the subscriber replica.
rplSubscriberFirst The data found in the subscriber database has priority during the replication.

Warning: by default, the master has priority: in the case of subscriber-to-master replication, the master's data will not be updated. We recommend that you use another constant (rplMostRecentFirst for example).

Synchronization with custom conflict management (WLanguage procedure) Ocultar los detalles

<Result> = HSynchronizeReplica(<Master replica> , <Subscriber replica> , <Replication direction> [, <Filter procedure>])

<Result>: Boolean

True if the operation was successful,
False otherwise.

<Master replica>: Character string

Location of the master replica. Depending on the replication type and direction, this parameter can correspond to:
the path of the replication file (xxxx.rpm file) for the master database.
the name of movable file created by HCreateMovableReplica.
an empty string (""). The current data files are considered as the master database. The file corresponding to the master replica (".rpm" file) is searched in the replication directory specified in the analysis (by default, RPL subdirectory of the data files), or in the directory specified with HChangeRplDir.
In most cases, this path corresponds to the full path of a file located in a network directory or to the path of a movable replica (USB key, email attachment, file retrieved by FTP).
For more details, see remarks.

<Subscriber replica>: Character string

Location of the subscriber replica. Depending on the replication type and direction, this parameter can correspond to:
the path of replication file (xxxx.rpl file) for the subscriber database.
the name of the movable file created by HCreateMovableReplica
an empty string (""). The current data files are considered as being the subscriber database. The file corresponding to the subscriber replica (".rpl" file) is searched in the replication directory specified in the analysis (by default, RPL subdirectory of the data files), or in the directory specified with HChangeRplDir.
In most cases, this path corresponds to the full path of a file located in a network directory or to the path of a movable replica (USB key, email attachment, file retrieved by FTP).
For more details, see remarks.

<Replication direction>: Integer constant

Direction in which the replication will be performed:
rplBidirectional Update the master database AND the subscriber database.

Universal replication: bidirectional replication is not available.
rplToMaster Update the master database according to the subscriber database.

<Master replica> corresponds to the movable replica created from the master database, <Subscriber replica> corresponds to the subscriber replica
rplToSubscriber Update the subscriber database according to the master database.

<Master replica> corresponds to the master replica, <Subscriber replica> corresponds to the movable replica created from the subscriber database.

<Filter procedure>: Optional procedure name

Name of a WLanguage procedure found in the WINDEV or WEBDEV project (this name must be enclosed in quotes). This procedure must be created in your application. This procedure expects no parameter.
This procedure is called before each operation performed on the destination file. Several variables can be used in this procedure.
If this procedure returns False, the operation is not performed. This procedure is used to:
filter the records that must not be replicated.
manage the conflicts, by adjusting the values before a duplicate error occurs.
For more details, see the example of HSynchronizeReplica.

Observaciones

Which data files can be replicated?

The synchronization can be performed:

between two databases linked by network.
between a database and a movable replica (created by HCreateMovableReplica).

No replication can be performed toward a movable replica. You must create a movable replica with the database and replicate from the remote database.

Caution: If you are updating yourdata files automatically, you must synchronize all replicas before doing so.. Otherwise, all the modifications performed since the last synchronization and the automatic modification will be lost.

Synchronization parameters

The table below presents the different combinations of parameters that must be used according to the replication type and direction:

Replication direction	<Master replica>	<Subscriber replica>	<Replication direction>

Replication from master to subscriber This replication is performed on the subscriber computer	Name of movable replica (*.rpa) created from the master, with its eventual path	Name of subscriber replica (*.rpl), with its eventual path.	rplToSubscriber
Replication from subscriber to master This replication is performed on the master computer	Name of master replica (*.rpm), with its eventual path.	Name of movable replica (*.rpa) created from the subscriber, with its eventual path.	rplToMaster

Locking records during the log-based replication

During replication, the "JournalOperation.fic" file is blocked: it is impossible to write, modify or save records in the destination database's log files.

Duplicate errors and/or integrity errors

If a duplicate error or an integrity error occurs, the standard mechanism for automatic management of errors is triggered. If the HFSQL engine returns an error, replication is interrupted: only part of the data is replicated.

Universal replication: If an integrity error occurs during replication, replication will continue but the function will return Faux.

To get the details of errors, you must read the HFSQL sub-errors with HError (with the hSubErrFirst and hSubErrNext constants) then call HErrorInfo.

Variables automatically initialized in the WLanguage procedure

Variable	Type	Description and value

RPL.File	Character string	Name of the file whose data will be replicated
RPL.Operation	Integer constant	HFSQL operation that will be replicated: rplHAjoute: replication of an addition rplHModifies replication of a modification rplHSupprime replication of a deletion
RPL.Conflict	Integer constant	Indicates whether a conflict was detected during the replication. The possible values are as follows: rplNoConflict: no conflict detected rplConflitModification: Registration has been modified on both source and destination replicas. rplConflitSuppression: Record deleted on destination replica and modified or deleted on source replica. To force the replication if a conflict occurred, RPL.Conflict must be initialized with the rplNoConflict variable. Otherwise, the replication will be performed only if the conflict is a modification conflict and if the data to replicate comes from the master database.
RPL.Direction	Integer constant	Indicates the direction of replication (useful for a bidirectional replication): rplVersAbonné: replication from master to subscriber rplVersMaître: replication from subscriber to master
RPL.OperationNum	Integer	Number of the current operation. This value is included between 1 and RPL.OperationMax. This variable allows you to easily manage a progress bar.
RPL.OperationMax	Integer	Total number of operations to replicate. This variable allows you to easily manage a progress bar.
RPL.SourceAlias	Character string	Name of the source alias for the replicated file (RPL.File). This file contains the values of the items that will be copied (HModify) or added (HAdd) to the file being replicated.
RPL.TargetAlias	Character string	Name of target alias of replicated file (RPL.File). This file contains the values of the items before performing the copy or the deletion in the file currently replicated.

Example: Replicating the data even if a conflict occurred (using a WLanguage procedure):

This example is used to force the replication of data even if a modification conflict occurs. To do so, force the value of the RPL.Conflict variable with the rplNoConflict constant.

IF RPL.Conflict = rplModifyConflict THEN
	RPL.Conflict = rplNoConflict
	RETURN True
END

Replication and WithSpace function

The replication is not compatible with WithSpace in the code of the client application. This function changes the nehavior of HFSQL. Using this function in the client application can affect the efficiency of replication. From version 21 update 3 (version 210065), the synchronization functions (programmed or assisted universal replication) return an error to the client application if WithSpace was applied to at least one of the replicated files.

Lifespan of movable replica

The replica is destroyed at the end of the replication in case of success. Replaying the replica will cause errors (for example, an addition causes a duplicate error). The replica uses the ".syn" file, which is also destroyed (another ".syn" file will replace it, without the unnecessary data).

A "movable" replica is moved (copied) between the master and the subscriber or between the subscriber and the master. To store an archive, all you have to do is store the source file (the one created by HCreateMovableReplica).

Replication and filter

When browsing the data to replicate, the replication takes into account the filters positioned by HFilter.

Therefore, for a programmed universal replication without replication server, HFilter can be used to limit the data to synchronize.

On the contrary, for a replication performed via a replication server, all the filters must be disabled before performing the replication with HSynchronizeReplica.

Note: The HClose function deletes all filters defined by the HFilter function on a data file.

Componente: wd300rpl.dll

Ver también

Versión mínima requerida

Versión 9

Esta página también está disponible para…

Comentarios

Haga clic en [Agregar] para publicar un comentario

Última modificación: 23/11/2024

Señalar un error o enviar una sugerencia | Ayuda local