UltraLite Database User's Guide
Connection Parameters
You must supply connection parameters for an application to connect to an UltraLite database. The connection parameters must specify the database to which the connection is to be established, usually by providing a database filename and path.
As an application may be compiled for more than one platform, a separate parameter for each target platform is available to identify the database. If user authentication is enabled, the connection parameters must also specify a user name and password.
For more information, see Database identification parameters, and User authentication parameters.
UltraLite databases are typically created on the first connection attempt, at which time the connection parameters must include a schema file (for UltraLite components) as well as optional parameters to adjust database features. If you are using embedded SQL, the static C++ API, or the static Java API, the database is created from information already stored in the application and no schema file is needed.
For more information, see Database schema parameters, and Additional connection parameters.
All connection parameters are case insensitive.
The following table lists the available connection parameters. Connection parameters used only when creating a database are marked with an asterisk (*).
| Parameter | Description |
|---|---|
| Additional Parms | A placeholder for additional connection parameters. See Additional Parms connection parameter |
| Cache Size | Defines the size of the cache. See Cache Size connection parameter. |
| Connection Name | Specifies a connection name. See Connection Name connection parameter. |
| Database On CE | The path and filename of the UltraLite database file to which you want to connect on Windows CE. See Database On CE connection parameter. |
| Database On Desktop | The path and filename of the UltraLite database file to which you want to connect. See Database On Desktop connection parameter. |
| Database On Palm | An identifier for the UltraLite database on Palm OS. See Database On Palm connection parameter. |
| Encryption Key | An encryption key for the database. See Encryption Key connection parameter. |
| Obfuscate* | Apply a simple encryption scheme to the database. See Obfuscate connection parameter. |
| Page Size | The database page size. See Page Size connection parameter. |
| Palm Allow Backup | Controls HotSync backup behavior on Palm OS devices. See Palm Allow Backup parameter. |
| Password | A password for the user. See Password connection parameter. |
| Reserve Size | Defines the reserve size. See Reserve Size connection parameter. |
| Schema On CE* | The path and filename of the UltraLite schema on Windows CE. See Schema On CE connection parameter. |
| Schema On Desktop* | The path and filename of the UltraLite schema. See Schema On Desktop connection parameter |
| Schema On Palm* | The UltraLite schema for the Palm OS. See Schema On Palm connection parameter. |
| User ID | The user ID with which you connect to the database. See User ID connection parameter. |
| VFS On Palm* | Identifies the Palm card as using the virtual file system. See VFS On Palm parameter. |
Specifying file paths
Specifying connection parameters