HCreateSubscriberReplica (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

Log-based replication: Directory for creating the files required by the replication and by the log process

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HCreateSubscriberReplica (Function)

In french: HCréeRéplicaAbonné

Available only with these kinds of connection

Creates the description file of a subscriber replica. The subscriber replica file extension is "rpl".

This function can be used with the logged replication and/or with the universal replication

Caution: When creating a subscriber replica, you must:

have created the master replica (HCreateMasterReplica).
have access to the master replica.

Only universal replication is available.

Example

// Create the master replica file in the C:\RPL\France directory
// while specifying a file name
HCreateMasterReplica("C:\RPL\France\ReplicaFrance.rpm")
// Create the subscriber replica
HCreateSubscriberReplica("C:\RPL\France\", "C:\RPL\USA", 1)

Syntax

Universal replication Hide the details

<Result> = HCreateSubscriberReplica(<Master replica directory> , <Subscriber replica directory> , <Identifier> , <Identifier size range> , <List of tables to replicate> [, <Automatic modification>])

<Result>: Integer

Identifier of the subscriber replica that was created,
0 if no subscriber replica was created.

<Master replica directory>: Character string

Directory where the master replica description file ("rpm" file) was created (HCreateMasterReplica). This directory can be a network directory or a UNC path.
If this parameter corresponds to an empty string (""), the description file will be searched for in the current directory of HFSQL data files (defined in the data model editor or through programming).
Caution: This directory must be accessible when HCreateSubscriberReplica is executed.

<Subscriber replica directory>: Character string

Directory where the subscriber replica description file must be created. This file is named Replica_<Identifier>.rpl.
If this parameter corresponds to an empty string (""), the description file will be created in the current directory of HFSQL data files (defined in the data model editor or by programming).

<Identifier>: Integer or character string

Subscriber replica identifier. This identifier will be used by HCreateMovableReplica.
A WLanguage error occurs if the specified identifier already exists.

<Identifier size range>: Integer

This parameter is ignored.

<List of tables to replicate>: Character string

This list has the following format:
<TableName>[+TAB+<NameDateItem>]
[+<CR>+<TableName>[+TAB+<NameDateItem>]]...
Caution: The order of the tables is important. The order of the tables is the order of the dependencies for the tables.
If the records of file 1 are linked to the records of file 2 and if the record must be found in file 2 in order for the addition in file 1 to comply with the integrity rules, then file 1 must be positioned first in the list.
For example, for the "Customer", "Orders" and "Order line" files (that are linked by links whose cardinalities are (0,n) - (1,1)), the "Customer" file must be positioned first (a customer must exist to add an order), then the "Orders" file (an order must exist to add an order line) and finally the "Order line" file.
The name of Date item is mandatory for the databases not in HFSQL format. This item must correspond to an item of the data file updated during an addition or during a modification. This operation must be performed by the application.

<Automatic modification>: Boolean

True to take into account the automatic data modification. In this case:
Changes in the structure of the master database will be carried over to the subscriber database.
The new items will be taken into account by the replication.
False (default value). The automatic data modification performed on the master database is not carried over to the subscriber database.
Caution:
For existing replications, it is necessary to recreate a replication (as well as the subscribers) to implement this mechanism.
This mechanism does not work if a unique key is added or deleted.
This parameter is only available for replication between HFSQL databases (Classic or Client/Server).

Logged replication (between HFSQL databases) Hide the details

<Result> = HCreateSubscriberReplica(<Master replica directory> , <Subscriber replica directory> [, <Identifier> [, <Identifier size range>]])

<Result>: Integer

Identifier of the subscriber replica that was created,
0 if no subscriber replica was created.

<Master replica directory>: Character string

Directory where the master replica description file ("rpm" file) was created (HCreateMasterReplica). This directory can be a network directory or a UNC path.
If this parameter corresponds to an empty string (""), the description file will be searched for in the current directory of HFSQL data files (defined in the data model editor or through programming).
Caution: this directory must be accessible when HCreateSubscriberReplica is executed.

<Subscriber replica directory>: Character string

Directory where the subscriber replica description file must be created. This file is named Replica_<Identifier>.rpl.
If this parameter corresponds to an empty string (""), the description file will be created in the current directory of HFSQL data files (defined in the data model editor or by programming).

<Identifier>: Optional integer or character string

Subscriber replica identifier. This identifier will be used by HCreateMovableReplica.
If this parameter corresponds to an empty string (""), an identifier is automatically returned by the function. A WLanguage error occurs if the specified identifier already exists.

<Identifier size range>: Optional integer

Size of the range of numbers reserved for the automatic identifiers for this replica. These identifiers will be used for all the new records created by this replica.
If this parameter is not specified, the size of the range of reserved identifiers is set to 1 billion.
If this parameter is set to 0, no range is reserved for the automatic identifiers.

Remarks

Log-based replication: Directory for creating the files required by the replication and by the log process

Log-based replication is closely linked to the log process. The log process is automatically enabled when the replication is implemented in an application.

For all the files used (data files, log files or replication files), the paths of the corresponding physical files can be defined in the data model editor or by programming.

By default, the tree structure of data files is as follows (example for the SalesMgt application):

The following table presents the default value for these different directories and their configuration mode in the data model editor or by programming.

	Default value	Where to configure it in the data model editor?	How to change the default value through programming?

Data file directory	Executable directory.	For all the data files of the application: "Details" tab of the analysis description For each data file: "Info" tab of the description of the data file.	To modify the default directory for the data files of the application, use HSubstDir. When creating the files for the log process and for the replication, the created directories will be relative to this new directory. Remark: To modify the directory for one of the data files only, use HChangeDir.
Replication file directory	RPL sub-directory of the default directory of the data files.	"Log\Replica" tab of the analysis description.	Specify the desired directory in HCreateMasterReplica and HCreateSubscriberReplica.
Log file directory	JNL subdirectory of the default directory of data files.	For all the data files of the application: "Log\Replica" tab of the analysis description. For each data file: "Various" tab of the description of the data file.	To modify the directory of log files, use HChangeLogDir. This function is used to: change the directory of Log file (JNL file) change the directory of the JNL file and the directory of the files for the log process (JournalIdentification and JournalOperation files).

Caution: To manage the logged replication in an application, the table of the log operations (JournalOperation.fic file) must be identical for all the data files in replication in the same analysis.

Business / UI classification: Business Logic

Component: wd300rpl.dll