Command reference table

This section describes the Replication Agent commands including targets, syntax, options, examples, and command usage.In Table 1-1, the targets column indicates when the command is used for “All” targets or specific targets; Oracle, Microsoft SQL Server (MSSQL), or DB2 UDB (UDB).

**Table 1-1: Replication Agent commands**
Command name	Target	Description	Page
log_system_name	All	Returns the path to the Replication Agent system log file.	§
pdb_asmdiskmap	Oracle	Creates a file with disk mirror paths for all ASM disks that online redo logs and archive logs are stored on.	§
pdb_capabilities	All	Returns a list of the Replication Agent capabilities.	§
pdb_date	All	Returns the current date and time from the primary data server.	§
pdb_execute_sql	All	Executes the specified SQL statement in the current database.	§
pdb_gen_id	All	Returns the current value of the database generation ID; updates the value of the database generation ID.	§
pdb_get_columns	All	Returns a list of all the columns in the specified table.	§
pdb_get_databases	All	Returns a list of all the databases in the primary data server.	§
pdb_get_primary_keys	All	Returns a list of all the columns that make up the primary keys in the specified table.	§
pdb_get_procedure_parms	Oracle MSSQL	Returns a list of the properties for the specified procedure.	§
pdb_get_procedures	Oracle MSSQL	Returns a list of all the procedures in the specified database.	§
pdb_get_sql_database	All	Returns the name of the database specified for SQL statement execution.	§
pdb_get_tables	All	Returns a list of all the tables in the specified database.	§
pdb_ownerfilter	Oracle MSSQL	Returns a list of owners whose objects will be filtered for initialization; adds and removes owners to the list.	§
pdb_set_sql_database	All	Specifies the database to be used for SQL statement execution.	§
pdb_setrepcol	All	Returns replication marking status; enables or disables replication for all marked columns or a specified column.	§
pdb_setrepddl	Oracle MSSQL	Returns DDL replication status; enables or disables replication for DDL statements.	§
pdb_setrepproc	Oracle MSSQL	Changes and reports stored procedure marking status.	§
pdb_setrepseq	Oracle	Changes and reports sequence replication marking status.	§
pdb_setreptable	All	Changes and reports table replication marking status.	§
pdb_skip_op	Oracle MSSQL	Returns, adds, or removes record identifiers from a list of records to skip in processing.	§
pdb_truncate_xlog	All	Truncates the Replication Agent primary database transaction log.	§
pdb_version	All	Returns the type and version of the primary data server.	§
pdb_xlog	All	Returns names of transaction log objects; creates transaction log base objects in the primary database; removes transaction log base objects from the primary database.	§
quiesce	All	Stops current Log Reader activity after all data remaining in the transaction log and Replication Agent internal queues is processed and puts Replication Agent in Admin state.	§
ra_config	All	Returns help information for configuration parameters; sets the value of a configuration parameter.	§
ra_date	All	Returns the current date and time from the Replication Agent server.	§
ra_helpdeviceoffset	Oracle	Changes the raw disk device read offset for a log device recorded in the RASD.	§
ra_devicepath	Oracle MSSQL	Changes the disk device path for a log device recorded in the RASD.	§
ra_dump	All	Records a dump marker in the primary database transaction log.	§
ra_help	All	Returns help information for Replication Agent commands.	§
ra_helparticle	Oracle MSSQL	Returns information about articles from the RASD.	§
ra_helpdb	Oracle MSSQL	Returns information about the primary database from the RASD.	§
ra_helpdevice	Oracle MSSQL	Returns information about primary database log devices from the RASD.	§
ra_helpdeviceoffset	Oracle	Returns device offset information about primary database log devices from the RASD log device repository.	§
ra_helpfield	Oracle MSSQL	Returns information about fields (columns in tables, or input parameters in stored procedures) from the RASD.	§
ra_helplocator	Oracle MSSQL	Returns LTM locator field values.	§
ra_helpuser	Oracle MSSQL	Returns information about primary database users from the RASD.	§
ra_locator	All	Returns and changes the current value of the LTM Locator stored by Replication Agent.	§
ra_maintid	All	Returns the maintenance user for the Replication Agent connection.	§
ra_marker	All	Records a marker in the primary database transaction log.	§
ra_migrate	All	Performs migration tasks (as necessary) between releases of Replication Agent.	§
ra_set_login	All	Sets the Replication Agent admin user login and password.	§
ra_statistics	All	Returns statistics for either a specified Replication Agent component or all components, and resets statistics for all components.	§
ra_status	All	Returns the current Replication Agent state.	§
ra_truncatearticles	Oracle MSSQL	Truncates older versions of primary database articles in the system data repository in the RASD.	§
ra_truncateusers	Oracle MSSQL	Truncates older versions of primary database users in the system data repository in the RASD.	§
ra_updatedevices	Oracle MSSQL	Updates the log device repository in the RASD.	§
ra_version	All	Returns the Replication Agent version.	§
ra_version_all	All	Returns Replication Agent, primary data server, Replication Server, and communications driver versions.	§
rasd_helpbackup	Oracle MSSQL	Backs up the Replication Agent System Database (RASD).	§
rasd_removebackup	Oracle MSSQL	Removes RASD backups.	§
rasd_restore	Oracle MSSQL	Restores the Replication Agent System Database (RASD).	§
rasd_trunc_schedule	Oracle MSSQL	Returns a list of the repository truncation weekly schedule; also adds or removes a specific schedule.	§
resume	All	Starts replication for the current active log and puts Replication Agent in Replicating state.	§
rs_create_repdef	Oracle MSSQL	Creates a replication definition at Replication Server for a marked table and procedure, or for all marked tables and procedures.	§
rs_drop_repdef	Oracle MSSQL	A replication definition for a table is dropped at the Replication Server.	§
rs_ticket	All	Supports Replication Server rs_ticket processing by placing an rs_ticket marker in the Primary database transaction log.	§
shutdown	All	Shuts down Replication Agent.	§
suspend	All	Immediately stops all Log Reader activity, drops connections, and puts Replication Agent in Admin state.	§
test_connection	All	Tests Replication Agent connectivity.	§
trace	All	Returns current trace flag settings; changes a specified trace flag.	§