Processes statements related to a specific table at the time an application connects to the MobiLink server in preparation for the synchronization process.

Parameters

In the following table, the description provides the SQL data type. If you are writing your script in Java or .NET, you should use the appropriate corresponding data type. See SQL-Java data types and SQL-.NET data types.

In SQL scripts, you can specify event parameters by name or with a question mark, but you cannot mix names and question marks within a script. If you use question marks, the parameters must be in the order shown below and are optional only if no subsequent parameters are specified (for example, you must use parameter 1 if you want to use parameter 2). If you use named parameters, you can specify any subset of the parameters in any order.

Default action

None.

Remarks

The MobiLink server executes this event after an application that is preparing to synchronize has formed a connection with the MobiLink server, and after the begin_synchronization connection-level event.

You can have one begin_synchronization script for each table in the remote database. The event is only invoked when the table is synchronized.

See also

• Script parameters
• Adding and deleting scripts
• end_synchronization table event
• begin_synchronization connection event
• Using remote IDs and MobiLink user names in scripts

SQL example

The begin_synchronization table event is used to set up the synchronization of a particular table. The following SQL script registers a script that creates a temporary table for storing rows during synchronization. This syntax is for a SQL Anywhere consolidated database.

CALL ml_add_table_script(
 'ver1',
 'sales_order',
 'begin_synchronization',
 'CREATE TABLE #sales_order (
    id          integer NOT NULL default autoincrement,
    cust_id     integer NOT NULL,
    order_date      date NOT NULL,
    fin_code_id char(2) NULL,
    region      char(7) NULL,
    sales_rep       integer NOT NULL,
    PRIMARY KEY (id),
)' )

Java example

The following call to a MobiLink system procedure registers a Java method called beginSynchronizationTable as the script for the begin_synchronization table event when synchronizing the script version ver1.

CALL ml_add_java_table_script(
 'ver1',
 'table1',
 'begin_synchronization',
 'ExamplePackage.ExampleClass.beginSynchronizationTable' )

The following is the sample Java method beginSynchronizationTable. It adds the current table name to a list of table names contained in this instance.

public String beginSynchronizationTable(
  String user,
  String table ) {  
  _tableList.add( table );
  return ( null );
}

.NET example

The following call to a MobiLink system procedure registers a .NET method called BeginTableSync as the script for the begin_synchronization table event when synchronizing the script version ver1 and the table table1.

CALL ml_add_dnet_table_script (
  'ver1', 
  'table1',
  'begin_synchronization',
  'TestScripts.Test.BeginTableSync' )

The following is the sample .NET method BeginTableSync. It adds the current table name to a list of table names contained in this instance.

public string BeginTableSync( 
  string user, 
  string table ) {  
  _tableList.Add( table );
  return ( null );
}