Chapter 4: Mirror Replication Agent Command Reference

This chapter describes all of the Mirror Replication Agent commands.

**Table 4-1: Mirror Replication Agent commands**
Command name	Description	Page
log_system_name	Returns the path to the Mirror Replication Agent system log file.	§
pdb_capabilities	Returns a list of Mirror Replication Agent capabilities.	§
pdb_date	Returns the current date and time from the primary data server.	§
pdb_execute_sql	Executes a SQL statement in the current database.	§
pdb_gen_id	Returns the current database generation ID; updates the database generation ID.	§
pdb_get_columns	Returns all the columns in the specified table.	§
pdb_get_databases	Returns all the databases in the primary data server.	§
pdb_get_primary_keys	Returns all the primary key columns in the specified table.	§
pdb_get_procedure_parms	Returns all the input parameters for the specified procedure.	§
pdb_get_procedures	Returns all the procedures in the specified database.	§
pdb_get_sql_database	Returns the name of the database used for SQL statement execution.	§
pdb_get_tables	Returns all the tables in the specified database.	§
pdb_init	Initializes the primary database for Mirror Replication Agent initialization.	§
pdb_quiesce	Quiesces the primary database for Mirror Replication Agent initialization.	§
pdb_set_sql_database	Specifies the database to be used for SQL statement execution.	§
pdb_version	Returns the type and version of the primary data server.	§
quiesce	Stops current Log Reader activity, processes data in internal queues, drops connections, and puts Mirror Replication Agent in Admin state.	§
ra_config	Returns help information for configuration parameter(s); sets the value of a configuration parameter.	§
ra_date	Returns the current date and time from the Mirror Replication Agent server.	§
ra_devicepath	Changes the path to a log device.	§
ra_help	Returns help information for Mirror Replication Agent command(s).	§
ra_helparticle	Returns information about primary database articles from the RASD.	§
ra_helpdb	Returns information about the primary database from the RASD.	§
ra_helpdevice	Returns information about log devices from the RASD.	§
ra_helpfield	Returns information about fields in articles from the RASD.	§
ra_helplocator	Returns LTM Locator field values.	§
ra_helpuser	Returns information about primary database users from the RASD.	§
ra_init	Initializes the Mirror Replication Agent instance.	§
ra_locator	Returns the current LTM Locator stored by the Mirror Replication Agent; retrieves a new LTM Locator from Replication Server.	§
ra_maintid	Returns the Maintenance User for the primary database connection.	§
ra_set_login	Sets the Mirror Replication Agent admin user login and password.	§
ra_statistics	Returns statistics for either a specified Mirror Replication Agent component, or all components; resets statistics for all components.	§
ra_status	Returns the current Mirror Replication Agent state.	§
ra_truncatearticles	Truncates older versions of primary database articles in the RASD.	§
ra_truncateusers	Truncates older versions of primary database users in the RASD.	§
ra_updatedevices	Updates the log device repository in the RASD.	§
ra_version	Returns the Mirror Replication Agent version.	§
ra_version_all	Returns Mirror Replication Agent, primary data server, Replication Server, and communications driver versions.	§
rasd_backup	Backs up the RASD.	§
rasd_restore	Restores the RASD.	§
resume	Starts replication for the current primary log and puts Mirror Replication Agent in Replicating state.	§
shutdown	Shuts down Mirror Replication Agent.	§
suspend	Immediately stops all Log Reader activity, drops connections, and puts Mirror Replication Agent in Admin state.	§
test_connection	Tests Mirror Replication Agent connections.	§
trace	Returns current trace flag settings; changes a specified trace flag.	§

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