Chapter 4: Sybase Replication Agent Command Reference

This chapter describes all the Replication Agent commands.

Table 4-1: Replication Agent commands

Command Name

Description

log_system_name

Returns the full path to the Replication Agent system log file.

log_trace_name

Returns the full path to the Replication Agent trace log file.

pdb_capabilities

Returns a list of the Replication Agent capabilities.

pdb_date

Returns the current date and time from the primary data server.

pdb_execute_sql

Executes the specified SQL statement in the current database.

pdb_gen_id

Returns the current value of the database generation ID or updates the value of the database generation ID.

pdb_get_columns

Returns a list of all the columns in the specified table.

pdb_get_databases

Returns a list of all the databases in the primary data server.

pdb_get_primary_keys

Returns a list of all the columns that make up the primary keys in the specified table.

pdb_get_procedure_parms

Returns a list of the parameters for the specified procedure.

pdb_get_procedures

Returns a list of all the procedures in the specified database.

pdb_get_sql_database

Returns the name of the database specified for SQL statement execution.

pdb_get_tables

Returns a list of all the tables in the specified database.

pdb_set_sql_database

Specifies the database to be used for SQL statement execution.

pdb_setrepcol

Returns replication marking status; enables or disables replication for all marked columns or a specified column.

pdb_setrepproc

Returns replication marking status; unmarks all marked procedures or a specified procedure; enables or disables replication for all marked procedures or a specified procedure; marks a specified procedure for replication.

pdb_setreptable

Returns replication marking status; unmarks all marked tables or a specified table; enables or disables replication for all marked tables or a specified table; marks a specified table for replication.

pdb_truncate_xlog

Truncates the Replication Agent transaction log.

pdb_version

Returns the type and version of the primary database server.

pdb_xlog

Returns names of transaction log objects, creates transaction log base objects in the primary database, or removes transaction log base objects from the primary database.

quiesce

Stops current Log Reader activity, processes data in internal queues, drops connections, and puts Replication Agent in the Admin state.

ra_config

Returns help information for configuration parameter(s) or sets the value of a configuration parameter.

ra_date

Returns the current date and time from the Replication Agent server.

ra_dump

Places a dump marker in the Replication Agent transaction log.

ra_help

Returns help information for Replication Agent command(s).

ra_locator

Returns the current value of the LTM Locator stored by Replication Agent, zeroes the current LTM Locator, or retrieves a new LTM Locator from Replication Server.

ra_maintid

Returns the Replication Server maintenance ID for the Replication Agent connection.

ra_marker

Places a marker in the Replication Agent transaction log.

ra_set_login

Sets the Replication Agent admin user login and password.

ra_statistics

Returns statistics for either a specified Replication Agent component or all components, or resets statistics for all components.

ra_status

Returns the current Replication Agent state.

ra_version

Returns the Replication Agent version.

ra_version_all

Returns Replication Agent, primary data server, and Replication Server versions.

resume

Starts replication for the currently active log, puts Replication Agent in the Replicating state.

shutdown

Shuts down Replication Agent.

suspend

Immediately stops all Log Reader activity, drops connections, and puts Replication Agent in the Admin state.

test_connection

Tests Replication Agent connections.

trace

Returns current trace flag settings or changes a specified trace flag.

The remaining sections in this chapter describe each Replication Agent command in detail.