Replication Server Commands

Provides a brief description of the RCL commands.

RCL Commands

Command

Description

abort switch

Aborts the switch active command, unless Replication Server has gone too far in the active switch process to abort it.

activate subscription

For a subscription to a replication definition or a publication, starts the distribution of updates from the primary to the replicate database and sets the subscription status to active.

add partition

Makes a partition available to Replication Server. A partition can be a disk partition or an operating system file. See create partition.

admin config

Retrieves Replication Server parameters such as global, connection, logical connection, and route parameters.

admin disk_space

Displays use of each disk partition accessed by the Replication Server.

admin echo

Returns the string entered by the user.

Retrieves the generation number for a primary database.

admin health

Displays the status of the Replication Server.

admin log_name

Displays the path to the current log file.

admin logical_status

Displays status information for logical connections.

admin pid

Displays the process ID of the Replication Server.

admin quiesce_check

Determines if the queues in the Replication Server have been quiesced.

admin quiesce_force_rsi

Determines whether a Replication Server is quiescent and forces it to deliver and obtain acknowledgments for messages in RSI queues.

admin rssd_name

Displays the names of the data server and database for the RSSD.

admin schedule

Displays information on a schedule.

admin security_property

Displays information about supported network-based security mechanisms and security services.

admin security_setting

Displays network-based security parameters and values for the Replication Server.

admin set_log_name

Closes the existing Replication Server log file and opens a new log file.

admin show_connection_profiles

Lists the profile name, version, and comments for each profile defined in Replication Server.

admin show_connections

Displays information about all connections from the Replication Server to data servers and to other Replication Servers.

admin show_function_classes

Displays the names of existing function-string classes and their parent classes, and indicates the number of levels of inheritance.

admin show_route_versions

Displays the version number of routes that originate at the Replication Server and routes that terminate at the Replication Server.

admin show_site_version

Displays the site version of the Replication Server.

admin sqm_readers

Displays the read and delete points of the threads that are reading a stable queue.

admin stats

Displays information and statistics about Replication Server counters.

admin stats, backlog

Reports the current transaction backlog in the stable queues.

admin stats, cancel

Cancels the currently running asynchronous command.

admin stats, {md | mem |mem_in_use}

Reports information about memory usage.

admin stats, reset

Resets all counters that can be reset.

admin stats, status

Displays the flushing status for all counters.

admin stats, {tps | cps | bps}

Reports the number of transactions, commands, or bytes of throughput per second.

admin time

Displays the current time of Replication Server.

admin translate

Performs a datatype translation on a value, displaying the results in delimited literal format.

admin verify_repserver_cmd

Verifies that Replication Server can successfully execute a replication definition request.

admin version

Displays the version number of the Replication Server software.

admin who

Displays information about threads running in the Replication Server.

admin who_is_down

Displays information about Replication Server threads that are not running.

admin who_is_up

Displays information about Replication Server threads that are running.

allow connections

Places Replication Server in recovery mode for specified databases.

alter applied function replication definition

Changes an existing applied function replication definition.

alter connection

Changes the attributes of a database connection.

alter connector

Changes the attributes of a database connector.

alter database replication definition

Changes an existing database replication definition.

alter error class

Changes an existing error class by copying error actions from another error class.

alter function

Adds parameters to a user-defined function.

alter function replication definition

Changes an existing function replication definition.

alter function string

Replaces an existing function string.

alter function string class

Alters a function-string class, specifying whether it should be a base class or a derived class.

alter logical connection

Disables or enables the Distributor thread for a logical connection, changes attributes of a logical connection, and enables or disables replication of truncate table to the standby database.

alter partition

Alters the size of a partition.

alter queue

Specifies the behavior of the stable queue that encounters a large message greater than 16K bytes.

alter replication definition

Changes an existing replication definition.

alter request function replication definition

Changes an existing request function replication definition.

alter route

Changes the attributes of a route from the current Replication Server to a remote Replication Server.

alter schedule

Enables or disables a schedule that executes commands.

alter subscription

Moves a subscription between replicate connections of the same replicate database that use the same Replication Server, without the need to rematerialize.

alter user

Changes a user’s password.

assign action

Assigns Replication Server error-handling actions to data server errors received by the DSI thread.

check publication

Finds the status of a publication and the number of articles the publication contains.

check subscription

Finds the materialization status of a subscription to a replication definition or a publication.

configure connection

Changes the attributes of a database connection.

configure logical connection

Changes attributes of a logical connection.

configure replication server

Sets characteristics of the Replication Server, including network-based security.

configure route

Changes the attributes of a route from the current Replication Server to a remote Replication Server.

connect

Turns Replication Server into a gateway to its RSSD, ID server, a remote Replication Server, or to a remote data server.

create alternate connection

Adds an alternate primary or replicate connection, or an alternate active or standby connection, and sets configuration parameters for the connection.

create alternate logical connection

Adds an alternate logical connection to the default logical connection. Replication Server uses logical connections to manage warm standby applications.

create applied function replication definition

Creates an applied function replication definition and user-defined function for a stored procedure that is to be replicated.

create article

Creates an article for a table or function replication definition and specifies the publication that is to contain the article.

create connection

Adds a database to the replication system and sets configuration parameters for the connection. To create a connection for an Adaptive Server database, use Sybase Central™ or rs_init.

create connection using profile

Uses predefined information to configure the connection between Replication Server and a non-Adaptive Server database, and, if needed, to modify the RSSD and the named data_server.database.

create database replication definition

Creates a replication definition for replicating a database or a database object.

create error class

Creates an error class.

create function

Creates a user-defined function.

create function replication definition

Creates a function replication definition and user-defined function for a stored procedure that is to be replicated.

create function string

Adds a function string to a function-string class. Replication Server uses function strings to generate instructions for data servers.

create function string class

Creates a function-string class.

create logical connection

Creates a logical connection. Replication Server uses logical connections to manage warm standby applications.

create partition

Makes a partition available to Replication Server. A partition can be a disk partition or an operating system file.

Creates a publication for tables or stored procedures that are to be replicated as a group to one or more subscribing replicate databases.

create request function replication definition

Creates a request function replication definition and user-defined function for a stored procedure that is to be replicated.

create replication definition

Creates a replication definition for a table that is to be replicated.

create route

Designates the route to use for a connection from the current Replication Server to a remote Replication Server.

create schedule

Creates a schedule to execute shell commands at a time you specify.

create subscription

Creates and initializes a subscription and materializes subscription data. The subscription may be for a database replication definition, a table replication definition, a function replication definition, or a publication.

create user

Adds a new user login name to a Replication Server.

define subscription

Adds a subscription to the Replication Server system tables, but does not materialize or activate the subscription. The subscription may be for a database replication definition, a table replication definition, a function replication definition, or for a publication. This command begins the process of bulk subscription materialization, or the process of refreshing a publication subscription.

disc

Terminates connection to a server. See disconnect.

disconnect

Terminates connection to a server.

drop article

Drops an article and optionally drops its replication definition.

drop connection

Removes a database from the replication system.

drop database replication definition

Drops an existing database replication definition.

drop error class

Drops an error class and any actions associated with it.

drop function

Drops a user-defined function and its function strings.

drop function replication definition

Drops a function replication definition and its user-defined function.

drop function string

Drops a function string for a function-string class.

drop function string class

Drops a function-string class.

drop logical connection

Drops a logical connection. Logical connections are used to manage warm standby applications.

drop partition

Removes a disk partition from the Replication Server.

drop publication

Drops a publication and all of its articles, and optionally drops the replication definitions for the articles.

drop replication definition

Drops a replication definition and its functions.

drop route

Closes the route to another Replication Server.

drop schedule

Drops a schedule that executes commands.

drop subscription

Drops a subscription to a database replication definition, table replication definition, function replication definition, article, or publication.

drop user

Drops a Replication Server user login name.

grant

Assigns permissions to users.

ignore loss

Allows Replication Server to accept messages after it detects a loss.

move primary

Changes the primary Replication Server for an error class or a function-string class.

rebuild queues

Rebuilds Replication Server stable queues.

resume connection

Resumes a suspended connection.

resume distributor

Resumes a suspended Distributor thread for a connection to a database.

resume log transfer

Allows the RepAgent to connect to the Replication Server.

resume queue

Restarts a stable queue stopped after being passed a message larger than 16K bytes.

resume route

Resumes a suspended route.

revoke

Revokes permissions from users.

set

Controls replication definition properties for a replicate connection.

set log recovery

Specifies databases whose logs are to be recovered from offline dumps.

set proxy

Switches to another user.

show connection

Lists the contents of the connection stack.

show server

Displays the current working server.

shutdown

Shuts down a Replication Server.

suspend connection

Suspends a connection to a database.

suspend distributor

Suspends the Distributor thread for a connection to a primary database.

suspend log transfer

Disconnects a RepAgent from a Replication Server and prevents a RepAgent from connecting.

suspend route

Suspends a route to another Replication Server.

switch active

Changes the active database in a warm standby application.

sysadmin apply_truncate_table

Turns on or off the “subscribe to truncate table” option for all existing subscriptions to a particular table, enabling or disabling replication of truncate table.

sysadmin cdb

Administers the net-change database in real-time loading (RTL) replication to Sybase IQ and high volume adaptive replication (HVAR) into Adaptive Server.

sysadmin dropdb

Drops a database from the ID Server.

sysadmin dropldb

Drops a logical database from the ID Server.

sysadmin drop_queue

Deletes a stable queue. Use this command to drop a failed materialization queue.

sysadmin droprs

Drops a Replication Server from the ID Server.

sysadmin dump_file

Specifies an alternative log file name for use when dumping a Replication Server stable queue.

sysadmin dump_queue

Dumps the contents of a Replication Server stable queue.

sysadmin dump_thread_stacks

Dumps Replication Server stacks.

sysadmin dump_tran

Dumps the commands of a stable queue transaction into a log file.

sysadmin erssd

Displays ERSSD name, schedule, backup directory, and ERSSD file locations. Used with options, this command performs unscheduled backups and moves ERSSD files.

sysadmin fast_route_upgrade

Updates the route version to the site version of the lower of the primary or replicate Replication Server.

sysadmin hibernate_off

Turns off hibernation mode for the Replication Server and returns it to an active state.

sysadmin hibernate_on

Turns on hibernation mode for (or suspends) the Replication Server.

sysadmin issue_ticket

Injects an rs_ticket marker in to the inbound queue.

sysadmin lmconfig

Configures and shows license management-related information in Replication Server.

sysadmin log_first_tran

Writes the first transaction in a DSI queue into the exceptions log.

sysadmin purge_all_open

Purges all open transactions from an inbound queue of a Replication Server.

sysadmin purge_first_open

Purges the first open transaction from the inbound queue of a Replication Server.

sysadmin purge_route_at_replicate

Removes all references to a primary Replication Server from a replicate Replication Server.

sysadmin restore_dsi_saved_segments

Restores backlogged transactions.

sysadmin set_dsi_generation

Changes a database generation number in the Replication Server to prevent the application of transactions in the DSI stable queue after a replicate database is restored.

sysadmin site_version

Sets the site version number for the Replication Server. This lets you use the software features in the corresponding version, and prevents you from downgrading to an earlier version.

sysadmin skip_bad_repserver_cmd

Instructs Replication Server to skip a failed replication definition request the next time Replication Agent starts.

sysadmin sqm_purge_queue

Purges all messages from a stable queue.

sysadmin sqm_unzap_command

Restores a message into a stable queue.

sysadmin sqm_unzap_tran

Restores a transaction into the stable queue.

sysadmin sqm_zap_command

Deletes a single message in a stable queue.

sysadmin sqm_zap_tran

Deletes a transaction from the stable queue.

sysadmin sqt_dump_queue

Dumps the transaction cache for an inbound queue or a DSI queue.

sysadmin system_version

Displays or sets the system-wide version number for the replication system, allowing you to use the software features in the corresponding release level.

validate publication

Sets the status of a publication to VALID, allowing new subscriptions to be created for the publication.

validate subscription

For a subscription to a replication definition or a publication, sets the subscription status to VALID. This command is part of the bulk materialization process, or part of the process of refreshing a publication subscription.

wait for create standby

A blocking command that allows a client session in the Replication Server to wait for the standby database creation process to complete.

wait for delay

Specifies a time interval at which this command is blocked.

wait for switch

A blocking command that allows a client session in the Replication Server to wait for the switch to the new active database to complete.

wait for time

Specifies a time of day at which to unblock this command.