There are several options you can control when creating your UltraLite database. These are designed to help with the wide variety of UltraLite uses. Most options specified at creation time cannot be changed later.
You can specify creation options when creating a database using the ulinit or ulload utility, and from the supported client interfaces.
Boolean creation options are turned on with YES, Y, ON, TRUE, or 1, and are turned off with any of NO, N, OFF, FALSE, and 0. The options are case insensitive.
UltraLite creation options are specified as a semicolon separated list when creating a database from a programming interface.
You can use a prefix with an option to specify that the option applies only when an application is running on a particular type of platform.
Use the prefix desktop: with an option to indicate that the option only applies when the application is running on the desktop.
Use the prefix device: with an option to indicate that the option only applies when the application is running on the mobile device.
device:DBF=\Documents\sample.udb;desktop:DBF=c:\Databases\sample.udb;UID=DBA;device:DBKEY=secret
Name | Description | Syntax |
---|---|---|
case | Sets the case-sensitivity of string comparisons in the UltraLite database. |
case=value |
checksum_level | Sets the level of checksum validation in the database. |
checksum_level=value |
collation | Sets the collation sequence used by the UltraLite database. Setting this property with or without the UTF-8 property determines the character set of the database. |
collation=value |
date_format | Sets the default string format in which dates are retrieved from the database. |
date_format=value |
date_order | Controls the interpretation of date ordering of months, days, and years. |
date_order=value |
dbf |
Specifies the path and file name for an UltraLite database. |
dbf=database-file |
dbkey |
Provides an encryption key for the database. |
dbkey=string |
fips | Controls the use of FIPS-certified AES encryption. |
fips=value |
kdf_iterations | Makes it more difficult to access an encrypted database by prolonging each attack attempt. |
kdf_iterations=value |
max_hash_size | Sets the default index hash size in bytes. |
max_hash_size=value |
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). |
mirror_file=mirror-file |
nearest_century | Controls the interpretation of two-digit years in string-to-date conversions. |
nearest_century=value |
obfuscate | Controls whether data in the database is obfuscated. Obfuscation is not secure against skilled and determined attempts to gain access to the data. |
obfuscate=value |
page_size | Defines the database page size. |
page_size=sizek |
precision | Specifies the maximum number of digits in decimal point arithmetic results. |
precision=value |
pwd |
Sets the password for the user. |
pwd=password |
reserve_size |
Pre-allocates the file system space required for your UltraLite database, without actually inserting any data. |
reserve_size=number{ k | m | g } |
scale | Specifies the minimum number of digits after the decimal point when an arithmetic result is truncated to the maximum precision. |
scale=value |
time_format | Sets the format for times retrieved from the database. |
time_format=value |
timestamp_format | Sets the format for timestamps retrieved from the database. |
timestamp_format=value |
timestamp_increment | Determines how the timestamp is truncated in UltraLite. |
timestamp_increment=value |
timestamp_with_time_zone_format | This option sets the format for TIMESTAMP WITH TIME ZONE values retrieved from the database. |
timestamp_with_time_zone_format=value |
uid |
Sets the default user ID for the database. |
uid=user |
utf8_encoding | Encodes data using the UTF-8 format, 8-bit multibyte encoding for Unicode. |
utf8_encoding=value |