download_statistics table event

Tracks synchronization statistics for download operations by table.

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.

Parameter name for SQL scripts

Description

Order

s.remote_id VARCHAR(128). The MobiLink remote ID. You can only reference the remote ID if you are using named parameters. Not applicable

s.username

VARCHAR(128). The MobiLink user name as specified in your SYNCHRONIZATION USER definition.

1

s.table

VARCHAR(128). The table name.

2

s.warnings

INTEGER. The number of warnings issued.

3

s.errors

INTEGER. The number of errors, including handled errors, that occurred.

4

s.fetched_rows

INTEGER. The number of rows fetched by the download_cursor script.

5

s.deleted_rows

INTEGER. The number of rows fetched by the download_delete_cursor script.

6

s.filtered_rows

INTEGER. The number of rows from (6) actually sent to the remote. This reflects download filtering of uploaded values.

7

s.bytes

INTEGER. The number of bytes sent to the remote as the download.

8

Default action

None.

Remarks

The download_statistics event allows you to gather, for any user and table, statistics on downloads as they apply to that table. The download_statistics table script is called just prior to the commit at the end of the download transaction.

See also
SQL example

The following example inserts synchronization statistics into a table called download_audit. Once vital statistics are inserted into the audit table, you may use these statistics to monitor your synchronizations and make optimizations where applicable.

CALL ml_add_table_script(
 'ver1',
 'table1',
 'download_statistics',
 'INSERT INTO download_audit (
   user_name, 
   table, warnings, 
   errors,
   deleted_rows, 
   fetched_rows, 
   download_rows, 
   bytes)
  VALUES (
   {ml s.username}, 
   {ml s.table}, 
   {ml s.warnings}, 
   {ml s.errors}, 
   {ml s.fetched_rows}, 
   {ml s.deleted_rows}, 
   {ml s.filtered_rows}, 
   {ml s.bytes})')
Java example

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

CALL ml_add_java_table_script(
  'ver1',
  'table1',
  'download_statistics',
  'ExamplePackage.ExampleClass.downloadStatisticsTable' )

Following is the sample Java method downloadStatisticsTable. It prints some statistics for this table to the MobiLink output log. (Note that printing statistics for a table to the MobiLink output log might be useful at development time but would slow down a production server.)

public String downloadStatisticsTable(
  String user,
  String table,
  int warnings,
  int errors,
  int fetchedRows,
  int deletedRows,
  int bytes ) {
  java.lang.System.out.println( "download table stats "
   + "table: " + table + "bytes: " + bytes );
  return ( null );
}
.NET example

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

CALL ml_add_dnet_table_script(
 'ver1',
 'table1',
 'download_statistics',
 'TestScripts.Test.DownloadTableStats'
)

Following is the sample .NET method DownloadTableStats. It prints some statistics for this table to the MobiLink output log. (Note that printing statistics for a table to the MobiLink output log might be useful at development time but would slow down a production server.)

public string DownloadTableStats(
  string user,
  string table,
  int warnings,
  int errors,
  int deletedRows,
  int fetchedRows,
  int downloadRows,
  int bytes ) {
  System.Console.WriteLine( "download table stats "
   + "table: " + table + "bytes: " + bytes );
  return ( null );
}