Processes statements related to a specific table just before preparing the download inserts, updates, and deletions.

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 as the first step in preparing download information for a specific table. The download information is prepared in its own transaction. The execution of this event is the first table-specific action in the transaction.

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

See also

• Script parameters
• Adding and deleting scripts
• end_download table event
• Using remote IDs and MobiLink user names in scripts
• Using last download times in scripts

SQL example

The following call to the MobiLink system procedure ml_add_table_script calls the BeginTableDownload procedure. This syntax is for a SQL Anywhere 11 consolidated database.

CALL ml_add_table_script( 
   'version1', 
   'Leads', 
   'begin_download',
   'CALL BeginTableDownLoad( 
     {ml s.last_table_download},
     {ml s.username},
     {ml s.table} )' );

The following SQL statements create the BeginTableDownload procedure.

CREATE PROCEDURE BeginTableDownload( 
   LastDownload timestamp, 
   MLUser varchar(128), 
   TableName varchar(128) )
BEGIN
  EXECUTE IMMEDIATE 'update ' || TableName ||
' set last_download_check = CURRENT TIMESTAMP
  WHERE Owner = ' ||MLUser;
END

Java example

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

CALL ml_add_java_table_script( 
   'ver1', 
   'table1',
   'begin_download',
   'ExamplePackage.ExampleClass.beginDownloadTable' )

The following is the sample Java method beginDownloadTable. It saves the name of the current table for use in a later method call.

public String beginDownloadTable( 
  Timestamp ts,
  String user, 
  String table ) {  
  _curTable = table;
  return ( null );
}

.NET example

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

CALL ml_add_dnet_table_script(
  'ver1', 'table1', 'begin_download',
  'TestScripts.Test.BeginTableDownload'
)

The following is the sample .NET method BeginTableDownload. It saves the name of the current table for use in a later method call.

public string BeginTableDownload(
  DateTime timestamp,
  string user,
  string table ) {  
  _curTable = table;
  return ( null );
}