User's Guide

Part VI. SQL Anywhere Reference

Chapter 43. Watcom-SQL Statements

Function

To invoke one of the database tools.

Syntax

     DBTOOL
          alter-database
          | alter-writefile
          | backup-to
          | compress-database
          | create-database
          | create-writefile
          | dbinfo-database
          | drop-database
          | translate
          | uncompress-database
          | unload-collation
          | unload-tables
          | validate-tables

Parameters

     alter-database:
          ALTER DATABASE name
          ...    { NO [ TRANSACTION ] LOG
               | SET [ TRANSACTION ] LOG TO filename }

     alter-writefile:
          ALTER WRITEFILE name [ REFER TO dbname ]

     backup-to:
          BACKUP TO directory
          ...    { [ DBFILE ] [ WRITE FILE ] [ [ TRANSACTION ] LOG ]
              | [ ALL FILES ] }
          ...    { [ RENAME [ TRANSACTION ] LOG ]
              | [ TRUNCATE [ TRANSACTION ] LOG ] }
          ...    [ NOCONFIRM ] USING connection-string

     compress-database:
          COMPRESS DATABASE filename [ TO filename ]

     create-database:
          CREATE DATABASE filename
          ...    { [ NO [ TRANSACTION ] LOG ]
              | [ [ TRANSACTION ] LOG TO filename ] }
          ...     [ { IGNORE | RESPECT } CASE ]
          ...    [ PAGE SIZE n ] [ COLLATION name ]
          ...    [ ENCRYPT ] [ TRAILING SPACES ]

     create-writefile:
          CREATE WRITEFILE name FOR DATABASE name
          ...    [ [ TRANSACTION ] LOG TO logname ] [ NOCONFIRM ]

     dbinfo-database:
          DBINFO DATABASE filename
          TO filename [ [ WITH ] PAGE USAGE ]

     drop-database:
          DROP DATABASE name [ NOCONFIRM ]

     translate:
          TRANSLATE [ TRANSACTION ] LOG FROM logname
          ...    [ TO sqlfile ] [ WITH ROLLBACKS ]
          ...    | [ USERS u1, u2, ... , un ]
              | [ EXCLUDE USERS u1, u2, ... , un ]
          ...    [ LAST CHECKPOINT ] [ ANSI ] [ NOCONFIRM ]

     uncompress-database:
          UNCOMPRESS DATABASE filename [ TO filename ] [ NOCONFIRM ]

     unload-collation:
          UNLOAD COLLATION [ name ] TO filename
          ...    USING connection-string
          ...    [ EMPTY MAPPINGS ] [ HEX | HEXADECIMAL ] [ NOCONFIRM ]

     unload-tables:
          UNLOAD TABLES TO directory [ RELOAD FILE TO filename ]
          ...     [ DATA | SCHEMA ]
          ...    [ UNORDERED ] [ VERBOSE ] USING connection-string

     validate-tables:
          VALIDATE TABLES [ t1, t2, ..., tn ] USING connection-string

     connection-string:
          string of connection parameters

Usage

ISQL.

Permissions

None.

Side effects

None.

See also

• The chapter "SQL Anywhere Components"

Description

The DBTOOL statement invokes one of the database utilities. All of the database utilities are available without leaving ISQL.

The following table lists the database utility invoked by each DBTOOL statement.

  For more information on the database utility programs, see the chapter "SQL Anywhere Components".

Statement	Database tool
DBTOOL ALTER DATABASE	DBLOG
DBTOOL ALTER WRITEFILE	DBWRITE
DBTOOL BACKUP TO	DBBACKUP
DBTOOL COMPRESS DATABASE	DBSHRINK
DBTOOL CREATE DATABASE	DBINIT
DBTOOL CREATE WRITEFILE	DBWRITE
DBTOOL DBINFO DATABASE	DBINFO
DBTOOL DROP DATABASE	DBERASE
DBTOOL TRANSLATE	DBTRAN
DBTOOL UNCOMPRESS DATABASE	DBEXPAND
DBTOOL UNLOAD COLLATION	DBCOLLAT
DBTOOL UNLOAD TABLES	DBUNLOAD
DBTOOL VALIDATE TABLES	DBVALID