Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SQL Anywhere 10.0.1 » SQL Anywhere Server - Programming » Database Tools Interface

Database Tools Interface Next Page

Introduction to the database tools interface


SQL Anywhere includes Sybase Central and a set of utilities for managing databases. These database management utilities perform tasks such as backing up databases, creating databases, translating transaction logs to SQL, and so on.

Supported platforms

All the database management utilities use a shared library called the database tools library. It is supplied for Windows operating systems and for Unix. The name of this library is dbtool10.dll for Windows, and libdbtool10.so (non-threaded) or libdbtool10_r.so (threaded) for Unix.

You can develop your own database management utilities or incorporate database management features into your applications by calling the database tools library. This chapter describes the interface to the database tools library. This chapter assumes you are familiar with how to call DLLs from the development environment you are using.

The database tools library has functions, or entry points, for each of the database management utilities. In addition, functions must be called before use of other database tools functions and when you have finished using other database tools functions.

Windows CE

The dbtool10.dll library is supplied for Windows CE, but includes only entry points for DBToolsInit, DBToolsFini, DBRemoteSQL, and DBSynchronizeLog. Other tools are not provided for Windows CE.

The dbtools.h header file

The dbtools header file included with SQL Anywhere lists the entry points to the DBTools library and also the structures used to pass information to and from the library. The dbtools.h file is installed into the h subdirectory under your SQL Anywhere installation directory. You should consult the dbtools.h file for the latest information about the entry points and structure members.

The dbtools.h header file includes three other files:

The sqldef.h header file also includes error return values.

The dbrmt.h header file

The dbrmt.h header file included with SQL Anywhere describes the DBRemoteSQL entry point in the DBTools library and also the structure used to pass information to and from the DBRemoteSQL entry point. The dbrmt.h file is installed into the h subdirectory under your SQL Anywhere installation directory. You should consult the dbrmt.h file for the latest information about the DBRemoteSQL entry point and structure members.