ml_add_column system procedure

Registers information about columns on remote databases for use by named column parameters.

Syntax

ml_add_column ( 
'version', 
'table', 
'column', 
'type'  
)

Parameters

Syntax	Description
version	VARCHAR(128). The version name.
table	VARCHAR(128). The table name.
column	VARCHAR(128). The column name.
type	VARCHAR(128). Reserved for future use. Set to null.

Remarks

This procedure populates the ml_column MobiLink system table with information about the columns on the remote database. The information is used by named row parameters.

Caution

ml_add_column calls must be executed in the same order that the columns exist in the remote database table. Failing to do so may result in incorrect data.

You need to run this system procedure if your synchronization clients do not send up column names. By default, version 12 synchronizations do send up column names, so ml_add_column is not required in most deployments. The ml_add_column names always override names from the client. Set the SendColumnNames (scn) extended option for dbmlsync to OFF if you do not want columns names to be sent from the client.

To delete all entries for the table name in the given script version, set the column name to null.

Examples

The following stored procedure call populates the ml_column MobiLink system table for col1 in MyTable for the script version Version1. This call allows you to use the named row parameters r.col1 and o.col1 in table scripts for MyTable1 in the Version1 script version when the synchronization client is not sending up column names (as clients prior to version 12 do by default).

CALL ml_add_column( 'Version1', 'MyTable1', 'col1', NULL )

The following stored procedure call deletes all entries in the ml_column MobiLink system table for MyTable1 in script version Version1:

CALL ml_add_column( 'Version1', 'MyTable1', NULL, NULL )

Discuss this page in DocCommentXchange.