UltraLite connection parameters

UltraLite supports these connection parameters when connecting to an UltraLite database.

You can use a prefix with a connection parameter to specify that the parameter applies only when an application is running on a particular type of platform.

Use the prefix desktop: with a connection parameter to indicate that the parameter only applies when the application is running on the desktop.

Use the prefix device: with a connection parameter to indicate that the parameter only applies when the application is running on the mobile device.

Note If the parameter is appropriate for both desktop and mobile device, then do not use the prefix.

device:DBF=\Documents\sample.udb;desktop:DBF=c:\Databases\sample.udb;UID=DBA;device:DBKEY=secret

Parameter name	Description
CACHE_MAX_SIZE	Specifies the maximum amount of memory to allocate for the file cache.
CACHE_MIN_SIZE	Specifies the minimum amount of memory to allocate for the file cache.
CACHE_SIZE	Specifies the initial amount of memory to allocate for the file cache.
COMMIT_FLUSH	Defines which transactions are recovered following a hardware failure or crash.
CON	Names a connection so that switching to it is easier in multi-connection applications.
DBF	At creation time, this parameter sets the location of the database. For subsequent connections, this parameter tells UltraLite where to find the database file. You can use DBF if you are creating a single-platform application or are connecting to a database from an UltraLite administration tool. Use the desktop: or device: prefixes if you are programming an UltraLite client that connects to different platform-specific databases.
DBKEY	At creation-time, this parameter sets the encryption key used to encrypt the database. For subsequent connections, it specifies the encryption key used to encrypt the database.
DBN	Differentiates databases by name when applications connect to more than one database.
MIRROR_FILE	Specifies the name of the database mirror file to which all database writes will be issued (at the same time as they are to the main database file).
PWD	When creating a new UltraLite database, this connection parameter sets the password for the default user. When connecting to an existing database, it defines the password for a user ID that is used for authentication.
RESERVE_SIZE	Pre-allocates the file system space required for the UltraLite database without actually inserting any data.
START	Starts the UltraLite engine executable.
TEMP_DIR	Specifies the name of the directory (which must already exist) into which UltraLite will place a temporary file (with a name derived from the database name).
UID	When creating a new UltraLite database, this connection parameter sets the default user ID for the database. When connecting to an existing database, it specifies the user ID with which you connect to the database.