Sybase® Adaptive Server™ Enterprise Monitor™ Client Library Programmer’s Guide describes how to write Sybase Adaptive Server Enterprise Monitor Client Library (Monitor Client Library) applications that access Sybase Adaptive Server Enterprise performance data.
This guide is for programmers who use Adaptive Server Enterprise Monitor Server or Adaptive Server Enterprise Monitor Historical Server.
When writing a Monitor Client Library application, use this book as a source of general information on how to construct Monitor Client Library programs.
Chapter 1, “Getting started with Monitor Client Library” explains how to structure a basic Monitor Client Library program and includes a simple, complete Monitor Client Library application.
Chapter 2, “Data Items and Statistical Types” describes data items, statistical types, and valid data item combinations of data items used in Monitor Client Library applications to gather performance data.
Chapter 3, “Monitor Client Library Functions” describes each function including syntax, parameter values, examples, permissions, and related functions.
Chapter 4, “Building a Monitor Client Library Application” describes how to compile and link a Monitor Client Library program.
Chapter 5, “Monitor Client Library Configuration Instructions” explains how to configure Monitor Client Library on UNIX or Windows NT.
Appendix A, “Examples of Views” provides examples of valid views.
Appendix B, “Datatypes and Structures” summarizes datatypes used by Monitor Client Library and describes the datatypes that have no equivalent in C or Open-Client Client Library.
Appendix C, “Backward Compatibility” lists obsolete functions and their replacement functions.
Appendix D, “Troubleshooting Information and Error Messages” explains how to respond to problems that you might have with Monitor Client Library and lists error messages that may be reported.
The following documents comprise the Sybase Adaptive Server Enterprise documentation:
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 Technical Library.
The Installation Guide for your platform – describes installation, upgrade, and configuration procedures for all Adaptive Server and related Sybase products.
Configuring Adaptive Server Enterprise for your platform – provides instructions for performing specific configuration tasks for Adaptive Server.
What’s New in Adaptive Server Enterprise? – describes the new features in Adaptive Server version 12.5, the system changes added to support those features, and the changes that may affect your existing applications.
Transact-SQL User’s Guide – documents Transact-SQL, Sybase’s enhanced version of the relational database language. This manual serves as a textbook for beginning users of the database management system. This manual also contains descriptions of the pubs2 and pubs3 sample databases.
System Administration Guide – provides in-depth information about administering servers and databases. This manual includes instructions and guidelines for managing physical resources, security, user and system databases, and specifying character conversion, international language, and sort order settings.
Reference Manual – contains detailed information about all Transact-SQL commands, functions, procedures, and datatypes. This manual also contains a list of the Transact-SQL reserved words and definitions of system tables.
Performance and Tuning Guide – explains how to tune Adaptive Server for maximum performance. This manual includes information about database design issues that affect performance, query optimization, how to tune Adaptive Server for very large databases, disk and cache issues, and the effects of locking and cursors on performance.
The Utility Guide – documents the Adaptive Server utility programs, such as isql and bcp, which are executed at the operating system level.
The Quick Reference Guide – provides a comprehensive listing of the names and syntax for commands, functions, system procedures, extended system procedures, datatypes, and utilities in a pocket-sized book. Available only in print version.
The System Tables Diagram – illustrates system tables and their entity relationships in a poster format. Available only in print version.
Error Messages and Troubleshooting Guide – explains how to resolve frequently occurring error messages and describes solutions to system problems frequently encountered by users.
Component Integration Services User’s Guide – explains how to use the Adaptive Server Component Integration Services feature to connect remote Sybase and non-Sybase databases.
Java in Adaptive Server Enterprise – describes how to install and use Java classes as datatypes, functions, and stored procedures in the Adaptive Server database.
Using Sybase Failover in a High Availability System – provides instructions for using Sybase’s Failover to configure an Adaptive Server as a companion server in a high availability system.
Using Adaptive Server Distributed Transaction Management Features – explains how to configure, use, and troubleshoot Adaptive Server DTM features in distributed transaction processing environments.
EJB Server User’s Guide – explains how to use EJB Server to deploy and execute Enterprise JavaBeans in Adaptive Server.
XA Interface Integration Guide for CICS, Encina, and TUXEDO – provides instructions for using Sybase’s DTM XA interface with X/Open XA transaction managers.
Glossary – defines technical terms used in the Adaptive Server documentation.
Sybase jConnect for JDBC Programmer’s Reference – describes the jConnect for JDBC product and explains how to use it to access data stored in relational database management systems.
Full-Text Search Specialty Data Store User’s Guide – describes how to use the Full-Text Search feature with Verity to search Adaptive Server Enterprise data.
Historical Server User’s Guide –describes how to use Historical Server to obtain performance information for SQL Server and Adaptive Server.
Monitor Server User’s Guide – describes how to use Monitor Server to obtain performance statistics from SQL Server and Adaptive Server.
Monitor Client Library Programmer’s Guide – describes how to write Monitor Client Library applications that access Adaptive Server performance data.
Use the following books for more information about Adaptive Server Enterprise configuration and tuning:
Managing and Monitoring Sybase Adaptive Server Enterprise describes how to manage Adaptive Server Enterprise and monitor its activities using Sybase Central™.
Adaptive Server Enterprise Performance and Tuning Guide describes how to analyze Adaptive Server Enterprise performance and tune it to improve performance.
Adaptive Server Enterprise Reference Manual describes SQL commands, functions, and stored procedures used with Sybase Adaptive Server Enterprise.
Adaptive Server Enterprise System Administration Guide contains information about administering Adaptive Server Enterprise.
Use the Sybase Technical Library CD and the Technical Library Product Manuals Web site to learn more about your product:
Technical Library CD contains product manuals and is included with your software. The DynaText browser (downloadable from Product Manuals) allows you to access technical information about your product in an easy-to-use format.
Refer to the Technical Library Installation Guide in your documentation package for instructions on installing and starting the Technical Library.
Technical Library Product Manuals Web site is an HTML version of the Technical Library CD that you can access using a standard Web browser. In addition to product manuals, you will find links to the Technical Documents Web site (formerly known as Tech Info Library), the Solved Cases page, and Sybase/Powersoft newsgroups.
To access the Technical Library Product Manuals Web site, go to Product Manuals.
Technical documentation at the Sybase Web site is updated frequently.
For the latest information on product certifications
Point your Web browser to Technical Documents.
Select Products from the navigation bar on the left.
Select a product name from the product list.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.
For the latest information on EBFs and Updates
Point your Web browser to Technical Documents.
Select EBFs/Updates. Enter user name and password information, if prompted (for existing Web accounts) or create a new account (a free service).
Specify a time frame and click Go.
Select a product.
Click an EBF/Update title to display the report.
To create 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.
Italics indicates emphasis or indicates that a definition accompanies the highlighted term.
Variable names, document titles, file names, directory names, and Adaptive Server Enterprise table names are in italic typeface:
-Umyname Adaptive Server Enterprise Monitor Server User’s Guide SQLMon.mrg file $SYBASE directory systables
Command syntax statements use the following notational conventions:
Command keywords appear in lowercase.
Variables (words that stand for values that you supply in the command) appear in italic.
Brackets mean that including the enclosed items in the command is optional. Do not include the brackets in your command.
Ellipses indicate that you may repeat the preceding item as many times as you like in the command. Do not include ellipses in your command.
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.