MobiLink SQL Anywhere client extended options

Extended options can be specified on the dbmlsync command line using the -e or -eu options, or they can be stored in the database. You store extended options in the database by using Sybase Central, by using the sp_hook_dbmlsync_set_extended_options event hook, or by using the OPTION clause in any of the following statements:

CREATE SYNCHRONIZATION SUBSCRIPTION
ALTER SYNCHRONIZATION SUBSCRIPTION
CREATE SYNCHRONIZATION USER
ALTER SYNCHRONIZATION USER
CREATE SYNCHRONIZATION SUBSCRIPTION without specifying a synchronization user (which associates extended options with a publication)

Priority order

Dbmlsync combines options stored in the database with those specified on the command line. If conflicting options are specified, dbmlsync resolves them as follows. In the following list, options specified by methods occurring earlier in the list take precedence over those occurring later in the list.

Options specified in the sp_hook_dbmlsync_set_extended_options event hook.
Options specified in the command line that aren't extended options. (For example, -ds overrides -e "ds=off".
Options specified in the command line with the -eu option.
Options specified in the command line with the -e option.
Options specified for the subscription, whether by a SQL statement or in Sybase Central. When you use the Deploy Synchronization Model Wizard to deploy a MobiLink model, extended options are set for you and are specified in the subscription.
Options specified for the MobiLink user, whether by a SQL statement or in Sybase Central.
Options specified for the publication, whether by a SQL statement or in Sybase Central.

Note

This priority order also affects connection parameters, such as those specified with the TYPE and ADDRESS options in the SQL statements mentioned above.

You can review extended options in the log and the SYSSYNC system view.

For information about how extended options can be used to tune synchronization, see Using dbmlsync extended options.

Summary of dbmlsync extended options

Following is a list of the dbmlsync extended options.

Option	Description
BufferDownload={ON \| OFF}; ...	Specifies whether the entire download from the MobiLink server should be read into the cache before applying it to the remote database. See BufferDownload (bd) extended option.
CommunicationAddress=protocol-option; ...	Specifies network protocol options for connecting to the MobiLink server. See CommunicationAddress (adr) extended option.
CommunicationType=network-protocol; ...	Specifies the type of network protocol to use for connecting to the MobiLink server. See CommunicationType (ctp) extended option
ConflictRetries=number; ...	Specifies the number of retries if the download fails because of conflicts. See ConflictRetries (cr) extended option.
ContinueDownload={ ON \| OFF }; ...	Restarts a previously failed download. See ContinueDownload (cd) extended option.
DisablePolling={ON \| OFF}; ...	Disables automatic logscan polling. See DisablePolling (p) extended option.
DownloadOnly={ ON \| OFF }; ...	Specifies that synchronization should be download-only. See DownloadOnly (ds) extended option.
DownloadReadSize=number[ K ]; ...	For restartable downloads, specifies the maximum amount of data that may need to be re-sent after a communications failure. See DownloadReadSize (drs) extended option.
ErrorLogSendLimit=number[ K \| M ]; ...	Specifies how much of the remote message log file dbmlsync should send to the server when synchronization error occurs. See ErrorLogSendLimit (el) extended option.
FireTriggers={ ON \| OFF }; ...	Specifies that triggers should be fired on the remote database when the download is applied. See FireTriggers (ft) extended option.
HoverRescanThreshold=number[ K \| M ]; ...	When you are using scheduling, this limits the amount of discarded memory that is allowed to accumulate before a rescan is performed. See HoverRescanThreshold (hrt) extended option.
IgnoreHookErrors={ ON \| OFF }; ...	Specifies that errors that occur in hook functions should be ignored. See IgnoreHookErrors (eh) extended option.
IgnoreScheduling={ ON \| OFF }; ...	Specifies that the Schedule extended option should be ignored. See IgnoreScheduling (isc) extended option.
Increment=number[ K \| M ]; ...	Enables incremental uploads and controls the size of upload increments. See Increment (inc) extended option.
LockTables={ ON \| OFF \| SHARE \| EXCLUSIVE }; ...	Specifies that tables in the publications being synchronized should be locked before synchronizing. See LockTables (lt) extended option.
MirrorLogDirectory=dir; ...	Specifies the location of old transaction log mirror files so that they can be deleted. See MirrorLogDirectory (mld) extended option.
MobiLinkPwd=password; ...	Specifies the MobiLink password. See MobiLinkPwd (mp) extended option.
NewMobiLinkPwd=new-password; ...	Specifies a new MobiLink password. See NewMobiLinkPwd (mn) extended option.
NoSyncOnStartup={ on \| off }; ...	Prevents dbmlsync from synchronizing on startup when a scheduling option would otherwise cause that to happen. See NoSyncOnStartup (nss) extended option.
OfflineDirectory=path; ...	Specifies the path containing offline transaction logs. See OfflineDirectory (dir) extended option.
PollingPeriod=number[S \| M \| H \| D ]; ...	Specifies the logscan polling period. See PollingPeriod (pp) extended option.
Schedule=schedule; ...	Specifies a schedule for synchronization. See Schedule (sch) extended option.
ScriptVersion=version-name; ...	Specifies a script version. See ScriptVersion (sv) extended option.
SendColumnNames={ ON \| OFF }; ...	Specifies that column names should be sent in the upload for use by direct row handling and by mlreplay. See SendColumnNames (scn) extended option.
SendDownloadAck={ ON \| OFF }; ...	Specifies that a download acknowledgement should be sent from the client to the server. See SendDownloadAck (sa) extended option.
SendTriggers={ ON \| OFF }; ...	Specifies that trigger actions should be sent on upload. See SendTriggers (st) extended option.
TableOrder=tables; ...	Specifies the order of tables in the upload. See TableOrder (tor) extended option.
TableOrderChecking={ OFF \| ON }; ...	Lets you disable referential integrity checking on the table order specified by the TableOrder extended option. See TableOrderChecking (toc) extended option.
UploadOnly={ ON \| OFF }; ...	Specifies that synchronization should only include an upload. See UploadOnly (uo) extended option.
Verbose={ ON \| OFF }; ...	Specifies full verbosity. See Verbose (v) extended option.
VerboseHooks={ ON \| OFF }; ...	Specifies that messages related to hook scripts should be logged. See VerboseHooks (vs) extended option.
VerboseMin={ ON \| OFF }; ...	Specifies that a small amount of information should be logged. See VerboseMin (vm) extended option.
VerboseOptions={ ON \| OFF }; ...	Specifies that information should be logged about the command line options (including extended options) that you have specified. See VerboseOptions (vo) extended option.
VerboseRowCounts={ ON \| OFF }; ...	Specifies that the number of rows that are uploaded and downloaded should be logged. See VerboseRowCounts (vn) extended option.
VerboseRowValues={ ON \| OFF }; ...	Specifies that the values of rows that are uploaded and downloaded should be logged. See VerboseRowValues (vr) extended option.
VerboseUpload={ ON \| OFF }; ...	Specifies that information about the upload steam should be logged. See VerboseUpload (vu) extended option.

Example

The following dbmlsync command line illustrates how you can set extended options when you start dbmlsync:

dbmlsync -e "adr=host=localhost;dir=c:\db\logs"...

The following SQL statement illustrates how you can store extended options in the database:

CREATE SYNCHRONIZATION SUBSCRIPTION TO mypub
   FOR mluser
   ADDRESS 'host=localhost'
   OPTION schedule='weekday@11:30am-12:30pm', dir='c:\db\logs'

The following dbmlsync command line opens the usage screen that lists options and their syntax:

dbmlsync -l

BufferDownload (bd) extended option
CommunicationAddress (adr) extended option
CommunicationType (ctp) extended option
ConflictRetries (cr) extended option
ContinueDownload (cd) extended option
DisablePolling (p) extended option
DownloadOnly (ds) extended option
DownloadReadSize (drs) extended option
ErrorLogSendLimit (el) extended option
FireTriggers (ft) extended option
HoverRescanThreshold (hrt) extended option
IgnoreHookErrors (eh) extended option
IgnoreScheduling (isc) extended option
Increment (inc) extended option
LockTables (lt) extended option
MirrorLogDirectory (mld) extended option
MobiLinkPwd (mp) extended option
NewMobiLinkPwd (mn) extended option
NoSyncOnStartup (nss) extended option
OfflineDirectory (dir) extended option
PollingPeriod (pp) extended option
Schedule (sch) extended option
ScriptVersion (sv) extended option
SendColumnNames (scn) extended option
SendDownloadAck (sa) extended option
SendTriggers (st) extended option
TableOrder (tor) extended option
TableOrderChecking (toc) extended option
UploadOnly (uo) extended option
Verbose (v) extended option
VerboseHooks (vs) extended option
VerboseMin (vm) extended option
VerboseOptions (vo) extended option
VerboseRowCounts (vn) extended option
VerboseRowValues (vr) extended option
VerboseUpload (vu) extended option

Discuss this page in DocCommentXchange.