MobiLink synchronization profiles

Synchronization profiles allow you to place some dbmlsync options in the database. The synchronization profile you create can contain a variety of synchronizations options.

Synchronization profiles can be created, altered and dropped using the following statements:

Synchronization profiles can be accessed using the dbmlsync -sp option, the Sync method in the Dbmlsync API, the SQL SYNCHRONIZE statement and the remote tasks created from central administration of remote databases. In all cases there is the ability to specify additional options that are merged with the options in the synchronization profiles. If any of the extra option specified conflicts with an option specified in the synchronization profile, the value specified by the extra options is used.

When using the dbmlsync -sp options, all the other option on the command line are treated as extra options. The other interfaces provide a specific parameter or clause for specifying extra options.

For information about using synchronization profiles in UltraLite, see Synchronization profile options.

The following options can be specified in a synchronization profile:

Long option name	Short name	Allowed values	Description
AuthParms	ap	String	Supplies parameters to the authenticate_parameters script and to authentication parameters. See AuthParms synchronization profile option.
ApplyDnldFile	ba	String	Applies a download file. See ApplyDnldFile synchronization profile option.
Background	bk	String	Enables background synchronization when set to TRUE. See Background synchronization profile option.
BackgroundRetry	bkr	Integer	Controls how dbmlsync behaves after a background synchronization is interrupted. See BackgroundRetry synchronization profile option.
CacheInit	ci	Integer	Sets the initial size of the dbmlsync cache. See CacheInit synchronization profile option.
CacheMax	cm	Integer	Sets the maximum size threshold for the dbmlsync cache. See CacheMax synchronization profile option.
CacheMin	cl	Integer	Sets the minimum size to which the dbmlsync cache can be reduced. See CacheMin synchronization profile option.
ContinueDownload	dc	Boolean	Restarts a previously failed download. See ContinueDownload synchronization profile option.
CreateDnldFile	bc	String	Creates a download file. See CreateDnldFile synchronization profile option.
DnldFileExtra	be	String	When creating a download file, this option specifies an extra string to be included in the file. See DnldFileExtra synchronization profile option.
DownloadOnly	ds	Boolean	Performs a download-only synchronization. See DownloadOnly synchronization profile option.
DownloadReadSize	drs	Integer	For restartable downloads, specifies the maximum amount of data that may need to be resent after a communications failure. See DownloadReadSize synchronization profile option.
ExtOpt	e	String	Specifies extended options. See ExtOpt synchronization profile option.
IgnoreHookErrors	eh	Boolean	Ignores errors that occur in hook functions. See IgnoreHookErrors synchronization profile option.
IgnoreScheduling	is	Boolean	Ignores scheduling instructions so that synchronization is immediate. See IgnoreScheduling synchronization profile option.
KillConnections	d	Boolean	Drops conflicting locks to the remote database. See KillConnections synchronization profile option.
LogRenameSize	x	An integer optionally followed by K or M.	Renames and restarts the transaction log after it has been scanned for upload data. See LogRenameSize synchronization profile option.
MobiLinkPwd	mp	String	Supplies the password of the MobiLink user. See MobiLinkPwd synchronization profile option.
MLUser	u	String	Specifies the MobiLink user name. See MLUser synchronization profile option (deprecated).
NewMobiLinkPwd	mn	String	Supplies a new password for the MobiLink user. Use this option when you want to change an existing password. See NewMobiLinkPwd synchronization profile option.
Ping	pi	Boolean	Pings a MobiLink server to confirm communications between the client and MobiLink. See Ping synchronization profile option.
Publication	n	String	This option is deprecated. Specifies the publications(s) to synchronize. Note that publication can only be specified once in a synchronization profile but the command line option can be specified multiple times. See Publication synchronization profile option.
RemoteProgressGreater	ra	Boolean	Specifies that the remote offset should be used if it is greater than the consolidated offset. This is equivalent to the -ra option. See RemoteProgressGreater synchronization profile option.
RemoteProgressLess	rb	Boolean	Specifies that the remote offset should be used if it is less than the consolidated offset (such as when the remote database has been restored from backup). This is equivalent to the -rb option. See RemoteProgressLess synchronization profile option.
Subscription	s	String	Specifies the subscription(s) to synchronize. Note that subscription can only be specified once in a synchronization profile. See Subscription synchronization profile option.
TransactionalUpload	tu	Boolean	Specifies that each transaction on the remote database should be uploaded as a separate transaction within one synchronization. See TransactionalUpload synchronization profile option.
UpdateGenNum	bg	Boolean	When creating a download file, this option creates a file that can be used with remote databases that have not yet synchronized. See UpdateGenNum synchronization profile option.
UploadOnly	uo	Boolean	Specifies that synchronization only includes an upload, and that no downloads occur. See UploadOnly synchronization profile option.
UploadRowCnt	urc	Integer	Specifies an estimate of the number of rows to be uploaded in a synchronization. See UploadRowCnt synchronization profile option.
Verbosity		String (a comma separated list of options)	Controls dbmlsync verbosity. Similar to the Verbosity synchronization profile option. The value must be a comma separated list of one or more of the following options, each of which corresponds to an existing -v option as described below: BASIC - equivalent to -v HIGH - equivalent to -v+ CONNECT_STR - equivalent to -vc ROW_CNT - equivalent to -vn OPTIONS - equivalent to -vo ML_PASSWORD - equivalent to -vp ROW_DATA - equivalent to -vr

Discuss this page in DocCommentXchange.