SQL Anywhere database server syntax

{ dbeng12 | dbsrv12 } 
 [ server-options ] [ database-file [ database-options ] ...]

Server option	Description
@data	Reads in options from a configuration file or environment variable. See @data dbeng12/dbsrv12 server option.
-?	Displays usage information. See -? dbeng12/dbsrv12 server option.
-b	Runs in bulk operations mode. See -b dbeng12/dbsrv12 server option.
-c size	Sets initial cache size. See -c dbeng12/dbsrv12 server option.
-ca 0	Disables dynamic cache sizing [Windows, Unix, Mac OS X]. See -ca dbeng12/dbsrv12 server option.
-cc{ + \| - }	Collects information about database pages to be used for cache warming. See -cc dbeng12/dbsrv12 server option.
-ch size	Sets the cache size upper limit [Windows, Unix, Mac OS X]. See -ch dbeng12/dbsrv12 server option.
-chx size	Reserves address space for non-cache use [32-bit Windows, 32-bit Unix]. See -ch dbeng12/dbsrv12 server option.
-cl size	Sets the cache size lower limit [Windows, Unix, Mac OS X]. See -cl dbeng12/dbsrv12 server option.
-cm size	Specifies the amount of address space allocated for an Address Windowing Extensions (AWE) cache [Windows]. See -cm dbeng12/dbsrv12 server option.
-cp location[ ;location ... ]	Specifies set of directories or JAR files in which to search for classes. See -cp dbeng12/dbsrv12 server option.
-cr{ + \| - }	Warms the cache with database pages. See -cr dbeng12/dbsrv12 server option.
-cs	Displays cache usage in the database server messages window. See -cs dbeng12/dbsrv12 server option.
-cv{ + \| - }	Controls the appearance of messages about cache warming in the database server messages window. See -cv dbeng12/dbsrv12 server option.
-cw	Enables use of Address Windowing Extensions for setting the size of the database server cache [Windows]. See -cw dbeng12/dbsrv12 server option (deprecated).
-dt temp-file-dir	Specifies the directory where temporary files are stored. See -dt dbeng12/dbsrv12 server option.
-ec encryption-options	Enables packet encryption [network server]. See -ec dbeng12/dbsrv12 server option.
-ep	Prompts for encryption key. See -ep dbeng12/dbsrv12 server option.
-es	Allows unencrypted connections over shared memory. See -es dbeng12/dbsrv12 server option.
-f	Forces the database to start without a transaction log. See -f dbeng12/dbsrv12 server recovery option.
-fc filename	Specifies the file name of a DLL containing the file system full callback function. See -fc dbeng12/dbsrv12 server option.
-fips	Requires the use of FIPS-certified algorithms for database and communication encryption [Windows, Unix, and Linux]. See -fips dbeng12/dbsrv12 server option.
-ga	Automatically unloads the database after the last non-HTTP client connection is closed. In addition, shut down after the last database is closed. See -ga dbeng12/dbsrv12 server option.
-gb level	Sets database process priority class to level [Windows, Unix, Mac OS X]. See -gb dbeng12/dbsrv12 server option.
-gc num	Sets maximum checkpoint timeout period to num minutes. See -gc dbeng12/dbsrv12 server option.
-gd level	Sets database starting permission. See -gd dbeng12/dbsrv12 server option.
-ge size	Sets the stack size for threads that run external functions. See -ge dbeng12/dbsrv12 server option.
-gf	Disables firing of triggers. See -gf dbeng12/dbsrv12 server option.
-gk level	Sets the permission required to stop the server. See -gk dbeng12/dbsrv12 server option.
-gl level	Sets the permission required to load or unload data. See -gl dbeng12/dbsrv12 server option.
-gm num	Sets the maximum number of connections. See -gm dbeng12/dbsrv12 server option.
-gn num	Sets the multiprogramming level of the database server. See -gn dbsrv12 server option.
-gna	Controls automatic tuning of the database server multiprogramming level. See -gna dbsrv12 server option.
-gnh num	Sets the maximum number of tasks that the database server can execute concurrently. See -gnh dbsrv12 server option.
-gnl num	Sets the minimum number of tasks that the database server can execute concurrently. See -gnl dbsrv12 server option.
-gns	Reports multiprogramming level statistics in the database server message log. See -gns dbsrv12 server option.
-gp size	Sets the maximum page size to size bytes. See -gp dbeng12/dbsrv12 server option.
-gr minutes	Sets the maximum recovery time. See -gr dbeng12/dbsrv12 server option.
-gss size	Sets the thread stack size to size bytes. See -gss dbeng12/dbsrv12 server option.
-gt num	Sets the maximum number of physical processors that can be used (up to the licensed maximum). This option is only useful on multiprocessor systems. See -gt dbeng12/dbsrv12 server option.
-gtc logical-processors-to-use	Controls the maximum processor concurrency that the database server allows. See -gtc dbeng12/dbsrv12 server option.
-gu level	Sets the permission level for utility commands: utility_db, all, none, or DBA. See -gu dbeng12/dbsrv12 server option.
-im submode	Runs the database server in memory, reducing or eliminating writes to disk. See -im dbeng12/dbsrv12 server option.
-k	Controls the collection of Performance Monitor statistics. See -k dbeng12/dbsrv12 server option.
-kl GSS-API-library-file	Specifies the file name of the Kerberos GSS-API library (or shared object on Unix) and enable Kerberos authenticated connections to the database server. See -kl dbeng12/dbsrv12 server option.
-kp server-principal	Specifies the Kerberos server principal and enable Kerberos authenticated connections to the database server. See -kp dbeng12/dbsrv12 server option.
-kr server-realm	Specifies the realm of the Kerberos server principal and enables Kerberos authenticated connections to the database server. See -kr dbeng12/dbsrv12 server option (deprecated).
-krb	Enables Kerberos-authenticated connections to the database server. See -krb dbeng12/dbsrv12 server option.
-ks	Disables the creation of shared memory that the Performance Monitor uses to collect counter values from the database server [Windows]. See -ks dbeng12/dbsrv12 server option.
-ksc	Specifies the maximum number of connections that the Performance Monitor can monitor [Windows]. See -ksc dbeng12/dbsrv12 server option.
-ksd	Specifies the maximum number of databases that the Performance Monitor can monitor [Windows]. See -ksd dbeng12/dbsrv12 server option.
-m	Truncates the transaction log after each checkpoint for all databases. See -m dbeng12/dbsrv12 server option.
-n name	Uses name as the name of the database server. The -n option is positional. See -n dbeng12/dbsrv12 server option.
-o filename	Outputs messages to the specified file. See -o dbeng12/dbsrv12 server option.
-oe filename	Specifies file to log startup errors, fatal errors, and assertions to. See -oe dbeng12/dbsrv12 server option.
-on size	Specifies a maximum size for the database server message log file, after which the file is renamed with the extension .old and a new file is started. See -on dbeng12/dbsrv12 server option.
-os size	Limits the size of the log file for messages. See -os dbeng12/dbsrv12 server option.
-ot filename	Truncates the database server message log file and appends output messages to it. See -ot dbeng12/dbsrv12 server option.
-p packet-size	Sets the maximum communication packet size [network server]. See -p dbeng12/dbsrv12 server option.
-pc	Compresses all communication packets except same-computer connections. See -pc dbsrv12 server option.
-pt size-in-bytes	Sets the minimum network packet size to compress. See -pt dbsrv12 server option.
-qi	Does not display the database server system tray icon or database server messages window [Windows]. See -qi dbeng12/dbsrv12 server option.
-qn	Does not minimize the database server messages window on startup [Windows and Linux]. See -qn dbeng12/dbsrv12 server option.
-qp	Suppresses messages about performance in the database server messages window. See -qp dbeng12/dbsrv12 server option.
-qs	Suppresses startup error windows [Windows]. See -qs dbeng12/dbsrv12 server option.
-qw	Does not display the database server messages window. See -qw dbeng12/dbsrv12 server option.
-r	Opens database in read-only mode. See -r dbeng12/dbsrv12 server option.
-s facility-ID	Sets the Syslog facility ID [Unix, Mac OS X]. See -s dbeng12/dbsrv12 server option.
-sb { 0 \| 1 }	Specifies how the server reacts to broadcasts. See -sb dbeng12/dbsrv12 server option.
-sf feature-list	Secures features for databases running on this database server. See -sf dbeng12/dbsrv12 server option.
-sk key	Specifies a key that can be used to enable features that are disabled for the database server. See -sk dbeng12/dbsrv12 server option.
-su password	Sets the password for the DBA user of the utility database (utility_db), or disable connections to the utility database. See -su dbeng12/dbsrv12 server option.
-ti minutes	Sets the client idle time before shutdown—default 240 minutes. See -ti dbeng12/dbsrv12 server option.
-tl seconds	Sets the default liveness timeout for clients in seconds—default 120 seconds. See -tl dbeng12/dbsrv12 server option.
-tmf	Forces transaction manager recovery for distributed transactions [Windows]. See -tmf dbeng12/dbsrv12 server option.
-tmt milliseconds	Sets the re-enlistment timeout for distributed transactions [Windows]. See -tmt dbeng12/dbsrv12 server option.
-tq time	Sets quitting time [network server]. See -tq dbeng12/dbsrv12 server option.
-u	Uses buffered disk I/O [Windows, Unix, Mac OS X]. See -u dbeng12/dbsrv12 server option.
-ua	Turns off use of asynchronous I/O [Linux]. See -ua dbeng12/dbsrv12 server option.
-uc	Starts the database server in shell mode [Unix and Mac OS X]. See -uc dbeng12/dbsrv12 server option.
-ud	Runs as a daemon [Unix, Mac OS X]. See -ud dbeng12/dbsrv12 server option.
-uf	Specifies the action to take when a fatal error occurs [Unix, Mac OS X]. See -uf dbeng12/dbsrv12 server option.
-ui	Opens the Server Startup Options window and displays the database server messages window, or starts the database server in shell mode if a usable display isn't available [Linux and Mac OS X]. See -ui dbeng12/dbsrv12 server option.
-um	Opens the Server Startup Options window and displays the database server messages window [Mac OS X]. See -um dbeng12/dbsrv12 server option.
-ut minutes	Touches temporary files every min minutes [Unix, Mac OS X]. See -ut dbeng12/dbsrv12 server option.
-ux	Displays the database server messages window and Server Startup Options window [Linux]. See -ux dbeng12/dbsrv12 server option.
-v	Displays database server version and stop. See -v dbeng12/dbsrv12 server option.
-vss{ + \| - }	Enables and disables the Volume Shadow Copy Service (VSS) [Windows]. See -vss dbeng12/dbsrv12 server option.
-wc[ + \| - ]	Enables write checksums for databases running on the database server. See -wc dbeng12/dbsrv12 server option.
-x list	Specifies a comma-separated list of communication protocols to use. See -x dbeng12/dbsrv12 server option.
-xa authentication-info	Specifies a list of database names and authentication strings for an arbiter server. See -xa dbsrv12 server option.
-xd	Prevents the database server from becoming the default database server. See -xd dbeng12/dbsrv12 server option.
-xf state-file	Specifies the location of the file used for maintaining state information about your database mirroring system. See -xf dbsrv12 server option.
-xm seconds	Sets the time to check for new IP addresses in seconds. The minimum value is 10 and the default value is 0. For a portable device, the default value is 120. See -xm dbeng12/dbsrv12 server option.
-xs	Specifies server-side web services communications protocols. See -xs dbeng12/dbsrv12 server option.
-z	Provides diagnostic information on communication links [network server]. See -z dbeng12/dbsrv12 server option.
-ze	Displays database server environment variables in the database server messages window. See -ze dbeng12/dbsrv12 server option.
-zl	Turns on capturing of the most recently-prepared SQL statement for each connection. See -zl dbeng12/dbsrv12 server option.
-zn integer	Specifies the number of request log file copies to retain. See -zn dbeng12/dbsrv12 server option.
-zo filename	Redirects request logging information to a separate file. See -zo dbeng12/dbsrv12 server option.
-zoc	Redirects web service client information to a file. See -zoc dbeng12/dbsrv12 server option.
-zp	Turns on capturing of the plan most recently used by the query optimizer. See -zp dbeng12/dbsrv12 server option.
-zr { all \| SQL \| none }	Turns on logging of SQL operations. The default is NONE. See -zr dbeng12/dbsrv12 server option.
-zs size	Limits the size of the log file used for request logging. See -zs dbeng12/dbsrv12 server option.
-zt	Turns on logging of request timing information. See -zt dbeng12/dbsrv12 server option.

The following options can only be specified after a database file name in the database server command.

Database option	Description
-a filename	Applies the named transaction log file. See -a dbeng12/dbsrv12 database option.
-ad log-directory	Specifies the directory containing transaction log files to be applied to the database. See -ad dbeng12/dbsrv12 database option.
-ar	Applies any log files located in the same directory as the transaction log to the database. See -ar dbeng12/dbsrv12 database option.
-as	Continues running the database after transaction logs have been applied (used in conjunction with -ad or -ar). See -as dbeng12/dbsrv12 database option.
-dh	Does not display the database when dblocate is used against this server. See -dh dbeng12/dbsrv12 database option.
-ds	Specifies the location of the dbspaces for the database. See -ds dbeng12/dbsrv12 database option.
-ek key	Specifies encryption key. See -ek dbeng12/dbsrv12 database option.
-m	Truncates (deletes) the transaction log after each checkpoint for the specified database. See -m dbeng12/dbsrv12 database option.
-n name	Names the database. The -n option is positional. See -n dbeng12/dbsrv12 database option.
-r	Opens the specified database(s) in read-only mode. Database modifications not allowed. See -r dbeng12/dbsrv12 database option.
-sm	Provides a database server name that can be used to access the read-only mirror database. See -sm dbsrv12 database option (deprecated).
-sn alternate-server-name	Provides an alternate server name for a single database running on a database server. See -sn dbsrv12 database option.
-wc[ + \| - ]	Enables write checksums for databases running on the database server. See -wc dbeng12/dbsrv12 database option.
-xp mirroring-options	Provides information to an operational server that allows it to connect to its partner and to the arbiter when database mirroring is being used. See -xp dbsrv12 database option.

The elements of the database server command include the following:

Executable The dbeng12 command starts a personal database server. The dbsrv12 command starts a network database server.
Both personal and network database servers are supplied for each supported operating system, with one exception. On Windows Mobile, only the network database server is supplied. The support for TCP/IP in the network server enables you to perform tasks from your desktop computer, including database management with Sybase Central.

On Windows operating systems, except Windows Mobile, the name of the personal database server executable is dbeng12.exe. On Unix operating systems its name is dbeng12.

On Windows operating systems, including Windows Mobile, the name of the network database server executable is dbsrv12.exe. On Linux and Unix operating systems, the name is dbsrv12.
Server options These options control the behavior of the database server for all running databases.
Database file You can specify zero, one, or more database file names. Each of these databases starts and remains available for applications.

Caution

The database file and the transaction log file must be located on the same physical computer as the database server or accessed via a SAN or iSCSI configuration. Database files and transaction log files located on a remote network directory can lead to poor performance, data corruption, and database server instability.

For more information, see http://www.sybase.com/detail?id=1034790.

For best results, the transaction log should be kept on a different disk from the database files. See The transaction log.
Database options For each database file you start, you can provide database options that control certain aspects of its behavior.

Database and server options are generally case-sensitive. You should enter all options in lowercase.

The database-file specifies the database file name. If database-file is specified without a file extension, database server looks for database-file with extension .db. If you use a relative path, it is read relative to the current working directory. You can supply a full path.

If you supply no options and no database file, then on Windows operating systems a window appears, allowing you to browse to your database file.

If you want to start a database server from a batch file, you must use the dbspawn utility. See Start Server in Background utility (dbspawn).

The personal database server has a maximum of ten concurrent connections, uses at most one CPU for request processing, and doesn't support network client/server connections. By default, the personal database server only uses the shared memory protocol. You must use the -x option if you want to use TCP/IP with the personal database server. See -x dbeng12/dbsrv12 server option.

In addition, there are other minor differences, such as the default permission level that is required to start new databases, or the permissions required to execute the CHECKPOINT statement. For more information about the differences between the personal database server and the network database server, see Using SQL Anywhere database servers.

By default, the database server page size is the same as the largest page size of the databases on the command line. Once the database server starts, you cannot start a database with a larger page size than the database server. See Maximum page size considerations.

Examples of starting a database server

The following command starts the SQL Anywhere sample database running on a personal database server:

dbeng12 "%SQLANYSAMP12%\demo.db"

The following command starts the SQL Anywhere sample database running on a network database server:

dbsrv12 "%SQLANYSAMP12%\demo.db"

The following example, entered all on one line, starts a database server named myserver that starts with a cache size of 3 MB and loads the sample database:

dbeng12 -c 3m -n myserver "%SQLANYSAMP12%\demo.db"

SQL Anywhere database server syntax

Syntax

Server options

Database options

Remarks

Caution

See also

Example