Replication Server® maintains replicated data at multiple sites on a network. Organizations with geographically distant sites can use Replication Server to create distributed database applications with better performance and data availability than a centralized database system can provide.
This book, Replication Server Reference Manual, describes these Replication Server features:
The Replication Command Language (RCL) used by Replication Server
System functions for Replication Server
Adaptive Server® commands and system procedures that you use with Replication Server
Adaptive Server stored procedures that you use to manage the Replication Server system tables
Replication Server executable programs, which you invoke directly from the operating system
Replication Server system tables
The Replication Server Reference Manual is intended for anyone who uses Replication Server. It assumes that you have basic knowledge of how to use Replication Server.
This book is also for replication system Administrators who manage the routine operation of Replication Servers. Any user who has sa permission can be a replication system Administrator, although each Replication Server usually has just one.
The information in this book is organized as follows:
Chapter 1, “Introduction to the Replication Command Language” categorizes the commands and what they do.
Chapter 2, “Topics” discusses datatypes, identifiers, reserved words, and support for Adaptive Server.
Chapter 3, “Replication Server Commands” consists of reference pages for all Replication Server commands.
Chapter 4, “Replication Server System Functions” provides reference pages for each system function Replication Server propagates from primary to replicate databases.
Chapter 5, “Adaptive Server Commands and System Procedures” contains reference pages for the Adaptive Server commands and system procedures used with Replication Server.
Chapter 6, “Adaptive Server Stored Procedures” contains reference pages for the Adaptive Server stored procedures used to manage the Replication Server system tables.
Chapter 7, “Executable Programs” contains reference pages for the Replication Server executable programs and the rs_subcmp subscription comparison program.
Chapter 8, “Replication Server System Tables” describes each Replication Server system table.
Chapter 9, “Replication Monitoring Services API” contains reference pages for the Replication Monitor Service (RMS) API.
Appendix A, “Acronyms and Abbreviations” lists the acronyms and abbreviations used in the Replication Server documentation and system messages.
Appendix B, “Replication Server Design Limits” lists the maximum and minimum parameters and values for various replication system objects.
Appendix C, “RMS Server and Component States” lists the RMS server and component states.
Appendix D, “Event Trigger Arguments” lists the information RMS passes concerning the execution of a certain event.
The Replication Server documentation set consists of the following:
The release bulletin for your platform – contains last-minute information that was too late to be included in the books.
A more recent version of the release bulletin may be available on the World Wide Web. To check for critical product or document information that was added after the release of the product CD, use the Sybase Product Manuals.
Installation Guide for your platform – describes installation and upgrade procedures for all Replication Server and related products.
New Features Guide – describes the new features in Replication Server version 15.2 and the system changes added to support those features.
Administration Guide – contains an introduction to replication systems. This manual includes information and guidelines for creating and managing a replication system, setting up security, recovering from system failures, and improving performance.
Configuration Guide for your platform – describes configuration procedures for all Replication Server and related products, and explains how to use the rs_init configuration utility.
Design Guide – contains information about designing a replication system and integrating heterogeneous data servers into a replication system.
Getting Started with Replication Server – provides step-by-step instructions for installing and setting up a simple replication system.
Heterogeneous Replication Guide and the Replication Server Options documentation set – describes how to use Replication Server to replicate data between databases supplied by different vendors.
Reference Manual (this book) – contains the syntax and detailed descriptions of Replication Server commands in the Replication Command Language (RCL); Replication Server system functions; Adaptive Server commands, system procedures, and stored procedures used with Replication Server; Replication Server executable programs; and Replication Server system tables.
System Tables Diagram – illustrates system tables and their entity relationships in a poster format. Available only in print version.
Troubleshooting Guide – contains information to aid in diagnosing and correcting problems in the replication system.
Replication Manager plug-in help, which contains information about using Sybase Central™ to manage Replication Server.
Use the Sybase Getting Started CD, the SyBooks™ CD, and the Sybase Product Manuals Web site to learn more about your product:
The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the SyBooks CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader, which you can download at no charge from the Adobe Web site using a link provided on the CD.
The SyBooks CD contains product manuals and is included with your software. The Eclipse-based SyBooks browser allows you to access the manuals in an easy-to-use, HTML-based format.
Some documentation may be provided in PDF format, which you can access through the PDF directory on the SyBooks CD. To read or print the PDF files, you need Adobe Acrobat Reader.
Refer to the SyBooks Installation Guide on the Getting Started CD, or the README.txt file on the SyBooks CD for instructions on installing and starting SyBooks.
The Sybase Product Manuals Web site is an online version of the SyBooks CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.
To access the Sybase Product Manuals Web site, go to Product Manuals.
Technical documentation at the Sybase Web site is updated frequently.
Finding the latest information on product certifications
Point your Web browser to Technical Documents.
Click Certification Report.
In the Certification Report filter select a product, platform, and timeframe and then click Go.
Click a Certification Report title to display the report.
Finding the latest information on component certifications
Point your Web browser to Availability and Certification Reports.
Either select the product family and product under Search by Base Product; or select the platform and product under Search by Platform.
Select Search to display the availability and certification report for the selection.
Creating a personalized view of the Sybase Web site (including support pages)
Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.
Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.
Finding the latest information on EBFs and software maintenance
Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. If prompted, enter your MySybase user name and password.
Select a product.
Specify a time frame and click Go. A list of EBF/Maintenance releases is displayed.
Padlock icons indicate that you do not have download authorization for certain EBF/Maintenance releases because you are not registered as a Technical Support Contact. If you have not registered, but have valid information provided by your Sybase representative or through your support contract, click Edit Roles to add the “Technical Support Contact” role to your MySybase profile.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.
This section describes style and syntax conventions, RCL command formatting conventions, and graphic icons used in this book.
Style conventions Syntax statements (displaying the syntax and options for a command) are printed as follows:
alter user user set password new_passwd [verify password old_passwd]
See “Syntax conventions” for more information.
Examples that show the use of Replication Server commands are printed as follows:
alter user louise set password somNIfic verify password EnnuI
Command names, command option names, program names, program flags, keywords, configuration parameters, functions, and stored procedures are printed as follows:
Use alter user to change the password for a login name.
Variables, parameters to functions and stored procedures, and user-supplied words are in italics in syntax and in paragraph text, as follows:
The set password new_passwd clause specifies a new password.
Names of database objects, such as databases, tables, columns, and datatypes, are in italics in paragraph text, as follows:
The base_price column in the Items table is a money datatype.
Names of replication objects, such as function-string classes, error classes, replication definitions, and subscriptions, are in italics, as follows:
rs_default_function_class is a default function-string class.
Syntax conventions Syntax formatting conventions are summarized in the following table. Examples combining these elements follow.
Key |
Definition |
---|---|
variable |
Variables (words standing for values that you fill in) are in italics. |
{ } |
Curly braces mean you must choose at least one of the enclosed options. Do not include braces in the command. |
[ ] |
Brackets mean you may choose or omit enclosed options. Do not include brackets in the command. |
| |
Vertical bars mean you may choose no more than one option (enclosed in braces or brackets). |
, |
Commas mean you may choose as many options as you need (enclosed in braces or brackets). Separate your choices with commas, to be typed as part of the command. Commas may also be required in other syntax contexts. |
( ) |
Parentheses are to be typed as part of the command. |
... |
An ellipsis (three dots) means you may repeat the last unit as many times as you need. Do not include ellipses in the command. |
Curly braces and vertical bars – choose only one option.
{red | yellow | blue}
Curly braces and commas – choose one or more options. If you choose more than one, separate your choices with commas.
{cash, check, credit}
One item in square brackets – choose it or omit it.
[anchovies]
Square brackets and vertical bars – choose none or only one.
[beans | rice | sweet_potatoes]
Square brackets and commas – choose none, one, or more options. If you choose more than one, separate your choices with commas.
[extra_cheese, avocados, sour_cream]
An ellipsis (...) means that you may repeat the last unit as many times as you need. For the alter function replication definition command, for example, you can list one or more parameters and their datatypes for either the add clause or the add searchable parameters clause:
alter function replication definition function_rep_def {deliver as 'proc_name' | add @parameter datatype [, @parameter datatype]... | add searchable parameters @parameter [, @parameter]... | send standby {all | replication definition} parameters}
RCL commands are similar to Transact-SQL® commands. The following sections present the formatting rules.
You can break a line anywhere except in the middle of a keyword or identifier. You can continue a character string on the next line by typing a backslash (\) at the end of the line.
Extra space characters on a line are ignored, except after a backslash. Do not enter any spaces after a backslash.
You can enter more than one command in a batch, unless otherwise noted.
RCL commands are not transactional. Replication Server executes each command in a batch without regard for the completion status of other commands in the batch. Syntax errors in a command prevent Replication Server from parsing subsequent commands in a batch.
Keywords in RCL commands are not case-sensitive. You can enter them with any combination of uppercase or lowercase letters.
Identifiers and character data may be case-sensitive, depending on the sort order that is in effect.
If you are using a case-sensitive sort order, such as “binary,” you must enter identifiers and character data with the correct combination of uppercase and lowercase letters.
If you are using a sort order that is not case-sensitive, such as “nocase,” you can enter identifiers and character data with any combination of uppercase or lowercase letters.
Identifiers are names you give to servers, databases, variables, parameters, database objects, and replication objects. Database object names include names for tables, columns, and views. Replication object names include names for replication definitions, subscriptions, functions, and publications.
Identifiers can be 1 – 255 bytes long (equivalent to 1 – 255 single-byte characters) and must begin with a letter, the @ sign, or the _ character. See “Identifiers,” in Chapter 2, “Topics” for a list of identifiers that have been extended to 255 bytes.
Replication Server function parameters are the only identifiers that can begin with the @ character. Function parameter names can include 255 characters after the @ character.
After the first character, identifiers can include letters, digits, and the #, $, or _ characters. Spaces are not allowed.
Parameters in function strings have the same rules as identifiers, except:
They are enclosed in question marks (?), allowing Replication Server to locate them in the function string. Use two consecutive question marks (??) to represent a literal question mark in a function string.
The exclamation point (!) introduces a parameter modifier that indicates the source of the data that will be substituted for a parameter at runtime. For a complete list of modifiers, see create function string.
Data support Replication Server supports all Adaptive Server datatypes.
User-defined datatypes are not supported. The double precision, nchar, and nvarchar datatypes are indirectly supported by mapping them to other datatypes.
For more information about the supported datatypes, including how to format them, see “Datatypes”.
Replication Server supports a set of datatype definitions for non-Sybase data servers that lets you replicate column values of one datatype to a column of a different datatype in the replicate database. See the Replication Server Administration Guide Volume 1 for more information about heterogeneous datatype support (HDS).
Illustrations in this book use icons to represent the components of a replication system.
Description |
|
---|---|
This icon represents Replication Server, the Sybase server program maintains replicated data on a local-area network (LAN) and processes data transactions received from other Replication Servers on wide-area network (WAN). |
|
This icon represents Adaptive Server, the Sybase data server. Data servers manage databases containing primary or replicated data. Replication Server also works with heterogeneous data servers, so, unless otherwise noted, this icon can represent any data server in a replication system. |
|
This icon represents Replication Agent™, a replication system process or module that transfers transaction log information for primary database to a Replication Server. The Replication Agent for Adaptive Server is RepAgent. Sybase provides Replication Agent products for Adaptive Server® Anywhere, DB2, Microsoft SQL Server, and Oracle data servers. Except for RepAgent, which is an Adaptive Server thread, all Replication Agents are separate processes. In general, this icon only appears when representing a Replication Agent that is a separate process. |
|
This icon represents client application. A client application is a user process or application connected to a data server. It may be a front-end application program executed by a user or a program that executes as an extension of the system. |
|
This icon represents the Sybase Central Replication Manager plug-in (RM), a management utility that lets a replication system administrator develop, manage, and monitor a Sybase Replication Server environment. |
This document is available in an HTML version that is specialized for accessibility. You can navigate the HTML with an adaptive technology such as a screen reader, or view it with a screen enlarger.
Replication Server HTML documentation has been tested for compliance with U.S. government Section 508 Accessibility requirements. Documents that comply with Section 508 generally also meet non-U.S. accessibility guidelines, such as the World Wide Web Consortium (W3C) guidelines for Web sites.
You might need to configure your accessibility tool for optimal use. Some screen readers pronounce text based on its case; for example, they pronounce ALL UPPERCASE TEXT as initials, and MixedCase Text as words. You might find it helpful to configure your tool to announce syntax conventions. Consult the documentation for your tool.
For information about how Sybase supports accessibility, see Sybase Accessibility. The Sybase Accessibility site includes links to information on Section 508 and W3C standards.
Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.