Configuring and tuning the Replication Agent

The performance of Sybase Replication Agent can be tuned or optimized by adjusting some of the Replication Agent configuration parameters.

You can set or change a Replication Agent configuration parameter with the ra_config command.

Because the Replication Agent overwrites its entire configuration file whenever ra_config or ra_set_login is invoked, Sybase recommends that you do not edit the configuration file. Also, each Replication Agent instance reads its configuration file only at start-up. You must use the ra_config command if you want a new configuration parameter value to take effect before the instance is shut down and restarted.

Some configuration parameter changes are recorded in the configuration file when you invoke ra_config, but they do not take effect until the Replication Agent instance is shut down and restarted.

All Replication Agent configuration parameters can be changed when the Replication Agent instance is in Admin state. Some configuration parameters cannot be changed when the instance is in Replicating state.

Table 3-1 lists all Replication Agent configuration parameters.

**Table 3-1: Replication Agent configuration parameters**
Parameter name	Description	Default
admin_port	Port number on which Replication Agent listens for incoming user connections.	10000
column_compression	Use minimal column information.	true
compress_ltl_syntax	Use abbreviated LTL syntax.	true
connect_to_rs	Enable/disable connection from LTI to Replication Server.	true
ddl_password	Password for user ID passed in LTL with replicated DDL invocations.	<not_configured>
ddl_username	User ID passed in LTL with replicated DDL invocations.	<not_configured>
dump_batch_timeout	Time to send incomplete buffer to Replication Server.	5
filter_maint_userid	Log Reader filters operations with maintenance user ID.	true
function_password	Password for user ID passed in LTL with replicated stored procedure invocations.	““ (empty string)
function_username	User ID passed in LTL with replicated stored procedure invocations.	sa
log_backup_files	Determines the number of log backup files kept in the log directory.	3
log_directory	Directory where Replication Agent system log file is located.	Current directory on the Replication Agent host machine from which the Replication Agent instance was started.
log_trace_verbose	Switch on/off verbose mode in trace log file.	false
log_wrap	Number of 1KB byte blocks written to log file before wrapping.	1000
lr_ntext_byte_order	Specifies which byte order to use when replicating NTEXT data: "big (BigEndian), little (LittleEndian)." For Microsoft SQL Server only.	big
lti_batch_mode	Specifies whether to batch the LTL commands sent to Replication Server.	true
lti_max_buffer_size	Maximum number of change sets stored in the LTI input buffer.	5000
lti_update_trunc_point	Number of LTL commands sent before LTI requests new LTM Locator.	1000
ltl_batch_size	Size of the LTL batch buffer.	40000
ltl_character_case	Case of database object names sent to Replication Server.	asis
ltl_origin_time_required	Specifies whether to send origin_time command tag in LTL.	false
ltm_admin_pw	Password for Replication Agent administrative port.	““ (empty string)
ltm_admin_user	User ID for Replication Agent administrative port.	sa
max_ops_per_scan	Maximum number of operations Log Reader will read in a single log scan.	1000
pdb_archive_path	Identifies the directory path where the Replication Agent expects to find archived Oracle redo log files.	None
pdb_archive_remove	Enables or disables the removal of archived Oracle redo log files from the path specified by pdb_archive_path.	false
pdb_auto_create_repdefs	Automatic creation of Replication Definitions when tables or procs are marked.	false
pdb_auto_mark_tables	Automatic marking of user tables when the Replication Agent is initialized.	false
pdb_auto_run_scripts	Automatic execution of SQL scripts used to create/remove transaction log objects and mark/unmark primary database objects.	true
pdb_convert_datetime	Converts native date/time formats to Sybase datetime format.	false
pdb_dflt_column_repl	Enables replication for LOB columns by default when table is marked.	false
pdb_include_archives	Enables or disables the reading of Oracle archive log files.	false
pdb_support_large_ identifier	Enables or disables the replication of large identifiers up to 255 characters in length with Replication Server 15.0.	false
pdb_dflt_object_repl	Enables replication by default when object is marked.	true
pdb_timezone_file	Specifies the file to read at initialization to obtain Oracle time zone information. The time zone file must be the same version as the Oracle database being replicated and it must be for the same platform.
pdb_xlog_device	Name of the primary database device.	NULL
pdb_xlog_prefix	Character string prefix used to identify transaction log objects.	ra_
pdb_xlog_prefix_chars	Non-alphabetic characters allowed in pdb_xlog_prefix.	For DB2 Universal Database: _#@ For Microsoft SQL Server: _$#@ For Oracle: _#$
pds_connection_type	Type of connection to primary data server.	For DB2 Universal Database: UDBODBC For Microsoft SQL Server: MSSQLJDBC For Oracle: ORAJDBC
pds_database_name	Name of database replicated from primary data server.	<not_configured>
pds_datasource_name	Data source name of database replicated from primary data server.	<not_configured>
pds_host_name	Name of primary data server host machine.	<not_configured>
pds_integrated_security	Enables or disables the use of Windows authentication when connecting to the primary SQL Server.	false
pds_password	Password for user ID Replication Agent uses to access primary data server.	““ (empty string)
pds_port_number	Port number for primary data server.	1111
pds_retry_count	Number of times to retry connection to primary data server.	5
pds_retry_timeout	Number of seconds to wait between connection retry attempts.	10
pds_server_name	Server name of primary data server.	<not_configured>
pds_username	User ID that Replication Agent uses to access primary data server.	<not_configured>
ra_retry_count	Number of times LTM attempts to get back to Replicating state after a failure.	2
ra_retry_timeout	Number of seconds to wait between LTM attempts to get back to Replicating state.	10
rasd_backup_dir	The directory path for Replication Agent System Database (RASD) backup files.	<not_configured>
rasd_database	The directory path for the Replication Agent System Database (RASD) database file.	<not_configured>
rasd_trace_log_dir	The directory path for the Replication Agent System Database (RASD) trace log file.	<not_configured>
rs_charset	Character set used to communicate with Replication Server.	““ (empty string)
rs_host_name	Name of primary Replication Server host machine.	<not_configured>
rs_packet_size	Network I/O packet size sent to Replication Server.	2048
rs_password	Password for user ID Replication Agent uses to access Replication Server.	““ (empty string)
rs_port_number	Port number for primary Replication Server.	1111
rs_retry_count	Number of times to retry connection to primary Replication Server.	5
rs_retry_timeout	Number of seconds to wait between connection retry attempts.	10
rs_source_db	Name of primary database identified to Replication Server.	<not_configured>
rs_source_ds	Name of primary data server identified to Replication Server.	<not_configured>
rs_username	User ID that Replication Agent uses to access primary Replication Server.	<not_configured>
rssd_charset	Character set used to communicate with RSSD.	““ (empty string)
rssd_database_name	Name of RSSD database.	<not_configured>
rssd_host_name	Name of RSSD host machine.	<not_configured>
rssd_password	Password for user ID Replication Agent uses to access RSSD.	““ (empty string)
rssd_port_number	Port number for RSSD.	1111
rssd_username	User ID that Replication Agent uses to access RSSD.	<not_configured>
scan_sleep_increment	Number of seconds to increase Log Reader wait before next scan after finding no operations to replicate.	5
scan_sleep_max	Maximum number of seconds for Log Reader to wait before next scan after finding no operations to replicate.	60
skip_ltl_errors	LTI ignores error messages returned by Replication Server.	false
structured_tokens	LTI uses structured tokens when generating LTL output.	true
truncation_interval	Number of minutes to wait between automatic log truncations.	0
truncation_type	Method(s) of log truncation allowed.	For Oracle: locator_update
use_rssd	Switches on/off access to RSSD for replication definitions.	true

Table 3-1: Replication Agent configuration parameters

Parameter name

Description

Default

admin_port

Port number on which Replication Agent listens for incoming user connections.

10000

column_compression

Use minimal column information.

true

compress_ltl_syntax

Use abbreviated LTL syntax.

true

connect_to_rs

Enable/disable connection from LTI to Replication Server.

true

ddl_password

Password for user ID passed in LTL with replicated DDL invocations.

<not_configured>

ddl_username

User ID passed in LTL with replicated DDL invocations.

<not_configured>

dump_batch_timeout

Time to send incomplete buffer to Replication Server.

filter_maint_userid

Log Reader filters operations with maintenance user ID.

true

function_password

Password for user ID passed in LTL with replicated stored procedure invocations.

““ (empty string)

function_username

User ID passed in LTL with replicated stored procedure invocations.

log_backup_files

Determines the number of log backup files kept in the log directory.

log_directory

Directory where Replication Agent system log file is located.

Current directory on the Replication Agent host machine from which the Replication Agent instance was started.

log_trace_verbose

Switch on/off verbose mode in trace log file.

false

log_wrap

Number of 1KB byte blocks written to log file before wrapping.

1000

lr_ntext_byte_order

Specifies which byte order to use when replicating NTEXT data: "big (BigEndian), little (LittleEndian)." For Microsoft SQL Server only.

big

lti_batch_mode

Specifies whether to batch the LTL commands sent to Replication Server.

true

lti_max_buffer_size

Maximum number of change sets stored in the LTI input buffer.

5000

lti_update_trunc_point

Number of LTL commands sent before LTI requests new LTM Locator.

1000

ltl_batch_size

Size of the LTL batch buffer.

40000

ltl_character_case

Case of database object names sent to Replication Server.

asis

ltl_origin_time_required

Specifies whether to send origin_time command tag in LTL.

false

ltm_admin_pw

Password for Replication Agent administrative port.

““ (empty string)

ltm_admin_user

User ID for Replication Agent administrative port.

max_ops_per_scan

Maximum number of operations Log Reader will read in a single log scan.

1000

pdb_archive_path

Identifies the directory path where the Replication Agent expects to find archived Oracle redo log files.

None

pdb_archive_remove

Enables or disables the removal of archived Oracle redo log files from the path specified by pdb_archive_path.

false

pdb_auto_create_repdefs

Automatic creation of Replication Definitions when tables or procs are marked.

false

pdb_auto_mark_tables

Automatic marking of user tables when the Replication Agent is initialized.

false

pdb_auto_run_scripts

Automatic execution of SQL scripts used to create/remove transaction log objects and mark/unmark primary database objects.

true

pdb_convert_datetime

Converts native date/time formats to Sybase datetime format.

false

pdb_dflt_column_repl

Enables replication for LOB columns by default when table is marked.

false

pdb_include_archives

Enables or disables the reading of Oracle archive log files.

false

pdb_support_large_ identifier

Enables or disables the replication of large identifiers up to 255 characters in length with Replication Server 15.0.

false

pdb_dflt_object_repl

Enables replication by default when object is marked.

true

pdb_timezone_file

Specifies the file to read at initialization to obtain Oracle time zone information.

The time zone file must be the same version as the Oracle database being replicated and it must be for the same platform.

pdb_xlog_device

Name of the primary database device.

NULL

pdb_xlog_prefix

Character string prefix used to identify transaction log objects.

ra_

pdb_xlog_prefix_chars

Non-alphabetic characters allowed in pdb_xlog_prefix.

For DB2 Universal Database: _#@

For Microsoft SQL Server: _$#@

For Oracle: _#$

pds_connection_type

Type of connection to primary data server.

For DB2 Universal Database: UDBODBC

For Microsoft SQL Server: MSSQLJDBC

For Oracle: ORAJDBC

pds_database_name

Name of database replicated from primary data server.

<not_configured>

pds_datasource_name

Data source name of database replicated from primary data server.

<not_configured>

pds_host_name

Name of primary data server host machine.

<not_configured>

pds_integrated_security

Enables or disables the use of Windows authentication when connecting to the primary SQL Server.

false

pds_password

Password for user ID Replication Agent uses to access primary data server.

““ (empty string)

pds_port_number

Port number for primary data server.

1111

pds_retry_count

Number of times to retry connection to primary data server.

pds_retry_timeout

Number of seconds to wait between connection retry attempts.

pds_server_name

Server name of primary data server.

<not_configured>

pds_username

User ID that Replication Agent uses to access primary data server.

<not_configured>

ra_retry_count

Number of times LTM attempts to get back to Replicating state after a failure.

ra_retry_timeout

Number of seconds to wait between LTM attempts to get back to Replicating state.

rasd_backup_dir

The directory path for Replication Agent System Database (RASD) backup files.

<not_configured>

rasd_database

The directory path for the Replication Agent System Database (RASD) database file.

<not_configured>

rasd_trace_log_dir

The directory path for the Replication Agent System Database (RASD) trace log file.

<not_configured>

rs_charset

Character set used to communicate with Replication Server.

““ (empty string)

rs_host_name

Name of primary Replication Server host machine.

<not_configured>

rs_packet_size

Network I/O packet size sent to Replication Server.

2048

rs_password

Password for user ID Replication Agent uses to access Replication Server.

““ (empty string)

rs_port_number

Port number for primary Replication Server.

1111

rs_retry_count

Number of times to retry connection to primary Replication Server.

rs_retry_timeout

Number of seconds to wait between connection retry attempts.

rs_source_db

Name of primary database identified to Replication Server.

<not_configured>

rs_source_ds

Name of primary data server identified to Replication Server.

<not_configured>

rs_username

User ID that Replication Agent uses to access primary Replication Server.

<not_configured>

rssd_charset

Character set used to communicate with RSSD.

““ (empty string)

rssd_database_name

Name of RSSD database.

<not_configured>

rssd_host_name

Name of RSSD host machine.

<not_configured>

rssd_password

Password for user ID Replication Agent uses to access RSSD.

““ (empty string)

rssd_port_number

Port number for RSSD.

1111

rssd_username

User ID that Replication Agent uses to access RSSD.

<not_configured>

scan_sleep_increment

Number of seconds to increase Log Reader wait before next scan after finding no operations to replicate.

scan_sleep_max

Maximum number of seconds for Log Reader to wait before next scan after finding no operations to replicate.

skip_ltl_errors

LTI ignores error messages returned by Replication Server.

false

structured_tokens

LTI uses structured tokens when generating LTL output.

true

truncation_interval

Number of minutes to wait between automatic log truncations.

truncation_type

Method(s) of log truncation allowed.

For Oracle: locator_update

use_rssd

Switches on/off access to RSSD for replication definitions.

true

For more information about the ra_config command and Replication Agent configuration parameters, see the Sybase Replication Agent Reference Manual.