Utility Commands Reference

Reference pages for the Adaptive Server^® utility program commands.

In UNIX, you enter a utility program command at the system prompt in a UNIX shell.

In Windows, if a utility:

Has an icon in the Sybase^® for Windows or Sybase for the Windows program group, double-click the icon to launch the utility program.
Does not have an icon in the program group, enter the utility program command at the Windows command prompt to launch the utility program.

Place characters with special meaning to the shell (the command prompt in Windows), such as the backslash (\), asterisk (*), slash (/), and spaces, in quotes. Precede some special characters with the backslash (\) to “escape” them to prevent the shell (command prompt) from interpreting the special characters.

The utility programs available with Adaptive Server are:

Utility	Description
backupserver	An executable form of the Backup Server^™ program.
bcp	Copies rows in a database table to or from an operating system file in a user-specified format.
buildmaster	See dataserver.
certauth	Converts a server-certificate request into a certificate authority-signed certificate.
certpk12	Exports or imports a PKCS#12 file.
certreq	Creates a server certificate request and corresponding private key in two ways:
charset	Loads the character sets and sort order files.
cobpre	A precompiler for COBOL.
cpre	A precompiler for C.
dataserver	An executable form of the Adaptive Server program.
ddlgen	Generates data definition language for server- and database-level objects in ASE.
defncopy	Copies definitions for specified views, rules, defaults, triggers, procedures, or reports from a database to an operating system file or from an operating system file to a database.
dscp	Allows you to view and edit server entries in the interfaces file in command-line mode.
dsedit	Allows you to view and edit server entries in the interfaces file using a graphical user interface.
extractjava	Copies a retained JAR from an Adaptive Server to a client file.
installjava	Installs a JAR from a client file into an Adaptive Server.
isql	Interactive SQL parser to Adaptive Server.
langinstall	Installs a new language on the Adaptive Server.
optdiag	Displays optimizer statistics or loads updated statistics into system tables.
preupgrade	Performs tests on an installation or database to determine its readiness for upgrade.
pwdcrypt	Creates and prints an encrypted LDAP password in the libtcl.cfg file.
qrmutil	(Cluster Edition only) allows you to back up, restore, and reconfigure the quorum device.
qptune	Enables you to fix missing statistics and identify the best query plan, optimization goal, or other configuration settings, and apply them at the query or server level.
showserver	Shows Adaptive Servers and Backup Servers that are currently running on the local machine.
sqldbgr	Debugs stored procedures and triggers.
sqlloc	Installs and modifies languages, character sets, and sort order defaults for Adaptive Server in GUI mode.
sqllocres	Installs and modifies languages, character sets, and sort order defaults for Adaptive Server in command-line mode.
sqlsrvr	An executable form of the Adaptive Server program.
sqlupgrade	Upgrades your currently installed release of Adaptive Server to the newest release in GUI mode.
sqlupgraderes	Upgrades your currently installed release of Adaptive Server to the newest release in command-line mode.
srvbuild	Creates a new Adaptive Server, Backup Server, or XP Server in GUI mode with default or user-specified values for key configuration attributes.
srvbuildres	Creates a new Adaptive Server, Backup Server, or XP Server in command-line mode with default or user-specified values for key configuration attributes.
startserver	Starts an Adaptive Server or a Backup Server.
sybcluster	Manages a shared-disk cluster.
sybdiag	Collects comprehensive configuration and environment data for Adaptive Server.
sybmigrate	Enables you to migrate database from a server using 2K logical pages to a server using 4, 8, or 16K logical pages.
sybrestore	Enables you restore an Adaptive Server database to the time of failure from the most current full database backup dump files.
sybtsmpasswd	Records or changes the user password and creates the Tivoli Storage Manager (TSM) encrypted password file, TSM.PWD, on the TSM client machine.
updatease	Reinstalls scripts and updates system stored procedures and messages after a minor upgrade.
xpserver	Starts XP Server manually.

Note: These utility programs may allow you to use a -P parameter to enter your password. If security is an issue, do not use -P to specify your password; another user may have an opportunity to see it. Instead, log in as usual without the -P parameter, and let Adaptive Server prompt you for your password.

Threaded Versions of Utilities
Sybase includes the _r versions of some of the utilities for use with threaded drivers.
Installation or Configuration Utilities
Adaptive Server includes various utilities for installation and configuration.
Utilities for Languages, Character Sets, and Sort Orders
Adaptive Server includes various utilities to set languages, character sets and sort orders.
Utilities to Start Servers
Adaptive Server includes various utilities to start servers manually.
Database Creation and Manipulation Utilities
Adaptive Server includes various utilities to create and manipulate databases.
Utilities to Gather Information
Adaptive Server includes various utilities to gather information:
Tuning Utility
qptune enables you to fix missing statistics and identify the best query plan, optimization goal, or other configuration settings, and apply them at the query or server level.
Utility to Manage a Cluster
(Cluster Edition only) Use the sybcluster utility to manage an Adaptive Server shared-disk cluster. sybcluster provides a set of interactive, command line options for creating and managing a cluster.
backupserver
The executable form of the Backup Server program.
bcp
Copies a database table to or from an operating system file in a user-specified format.
buildmaster
Adaptive Server does not use the buildmaster binary to build the master device. Instead, Sybase has incorporated the buildmaster functionality in the dataserver binary.
certauth
Converts a server certificate request to a CA- (certificate authority) signed certificate.
certpk12
Export or import a PKCS #12 file into a certificates file and a private key.
certreq
Creates a server certificate request and corresponding private key. Use certreq in interactive mode, or provide all optional parameters on the command line.
charset
(UNIX only) Loads the character sets and sort order files in Adaptive Server.
cobpre
Precompiler for COBOL.
cpre
Precompiler for C.
dataserver
(UNIX only) The executable form of the Adaptive Server program, located in $SYBASE/$SYBASE_ASE/bin.
ddlgen
A Java-based tool that generates definitions for server- and database-level objects in Adaptive Server.
defncopy
Copies definitions for specified views, rules, defaults, triggers, or procedures from a database to an operating-system file or from an operating-system file to a database.
dscp
(UNIX only) A text-based utility that allows you to view and edit server entries in the interfaces file from the command line in UNIX platforms.
dsedit
The dsedit utility allows you to view and edit server entries in the interfaces file using a GUI. In Windows, dsedit creates and modifies network connection information in the interfaces file.
extractjava
Copies a retained JAR and the classes it contains from an Adaptive Server into a client file.
installjava
Installs a JAR from a client file into an Adaptive Server.
isql
Interactive SQL parser to Adaptive Server.
langinstall
Installs a new language in an Adaptive Server.
optdiag
Displays optimizer statistics or loads updated statistics into system tables.
preupgrade
Performs tests on an installation or database to determine its readiness for upgrade, and reports found problems.
pwdcrypt
Creates and prints an encrypted LDAP password in the libtcl.cfg file.
qrmutil
(Cluster Edition only) qrmutil allows you to back up, restore, and reconfigure the quorum device.
qptune
qptune is an Adaptive Server utility written in Java/XML. It enables users to fix missing statistics and identify the best query plan, optimization goals, or other configuration settings, and apply them at the query or server level. This results in optimal performance of subsequent query executions.
showserver
(UNIX only) Shows the Adaptive Servers and Backup Servers that are currently running on the local machine, available only in UNIX platforms.
sqldbgr
sqldbgr is a command line utility that debugs stored procedures and triggers.
sqlloc
(UNIX only) Installs and modifies languages, character sets, and sort order defaults for Adaptive Server using a GUI.
sqllocres
(UNIX only) Installs and modifies languages, character sets, and sort order defaults for Adaptive Server, using a resource file.
sqlsrvr
(Windows only) The executable form of the Adaptive Server program.
sqlupgrade
(UNIX only) Upgrades your currently installed version of Adaptive Server to the newest release using a GUI.
sqlupgraderes
(UNIX only) Upgrades your currently installed release of Adaptive Server to the newest release using resource files.
srvbuild
(UNIX only) Creates a new Adaptive Server, Backup Server, or XP Server with default or user-specified values for key configuration attributes. Use srvbuild in either GUI or non-GUI mode.
srvbuildres
(UNIX only) Creates, using resource files, a new Adaptive Server, Backup Server, or XP Server with default or user-specified values for key configuration attributes.
startserver
(UNIX only) Starts an Adaptive Server or a Backup Server.
sybcluster
Manages a Sybase shared-disk cluster. sybcluster lets you create, start, stop, and manage a cluster or any instance in a cluster.
sybdiag
sybdiag is a Java-based tool that collects comprehensive Adaptive Server configuration and environment data. Technical Support uses this information to diagnose server issues, thus expediting customer cases.
sybmigrate
sybmigrate allows you to convert an Adaptive Server from one page size to another page size, and to migrate between platforms.
sybrestore
sybrestore allows you to restore an Adaptive Server database to the time of failure from the most current full database backup dump files.
sybtsmpasswd
Records or changes the user password and creates the Tivoli Storage Manager (TSM) encrypted password file, TSM.PWD, on the TSM client machine. The location of the file is the directory specified by the PASSWORDDIR configuration parameter in the TSM configuration file.
updatease
The updatease utility reinstalls scripts and updates system stored procedures and messages after a minor upgrade.
xpserver
Starts XP Server manually.