|
UltraLite database property values are defined when the database is first created.
Properties can be changed by re-creating the UltraLite database or editing their corresponding database option, if available.
UltraLite supports the following database properties:
| Property | Description |
|---|---|
| cache_allocation | Returns the current cache size as a percentage of the minimum and maximum settings. This property corresponds to the cache_allocation option for the database. |
| CaseSensitive | Returns the status of the case sensitivity feature. Returns On if the database is case sensitive. Otherwise, it returns Off. |
| CharSet |
Returns the CHAR character set of the database. The character set used by the database is determined by the database's collation sequence and whether the data is UTF-8 encoded. |
| ChecksumLevel | Returns the level of checksum validation in the database, one of 0 (do not add checksums), 1 (add checksums only to important pages), or 2 (add checksums to all pages). This property corresponds to the checksum_level creation option for the database. |
| Collation | Returns the name of the database's collation sequence. This property corresponds to the collation creation option for the database. |
| commit_flush_count | Returns the value of the commit_flush_count option that sets a commit count threshold. This property corresponds to the commit_flush_count option [temporary] for the database. |
| commit_flush_timeout | Returns the value of the commit_flush_timeout option that sets a time interval threshold. This property corresponds to the commit_flush_timeout option [temporary] for the database. |
| ConnCount | Returns the number of connections to the database. The value is dynamic: it can vary depending on how many connections currently exist. UltraLite supports up to fourteen concurrent database connections. |
| date_format | Returns the date format the database uses for string conversions. This property corresponds to the date_format creation option for the database. |
| date_order | Returns the date order the database uses for string conversions. This property corresponds to the date_order creation option for the database. |
| Encryption |
Returns the type of database encoding, one of None, Simple, AES, or AES_FIPS. The encoding used by the database is determined by whether you have configured strong encryption (AES or AES_FIPS) and the DBKEY creation parameter, or simple obfuscation. The only time this property can change is when the value is originally None (that is, neither fips nor obfuscation is used) and you then change the encryption key by specifying a new encryption key on the Connection object by calling the correct function or method for your API. In this case, the value would change to AES because the fips creation parameter cannot be set after the database has been created. You can use API methods to change the encryption key. |
| File |
Returns the name of the database root file for the current connection, including the path. This is the value specified in the DBF connection parameter value. |
| global_database_id | Returns the value of the global_database_id option used for global autoincrement columns. This property corresponds to the global_database_id option for the database. |
| isolation_level | Returns the current isolation level of the database. The value can either be read_committed or read_uncommitted.This property corresponds to the isolation_level option for the database. |
| MaxHashSize | Returns the default number of maximum bytes to use for index hashing. This property can be set on a per-index basis. This property corresponds to the max_hash_size creation option for the database. |
| ml_remote_id | Returns the value of the ml_remote_id option that uniquely identifies the database for MobiLink synchronization. This property corresponds to the ml_remote_id option for the database. |
| Name |
Returns the name (or alias) of the database for the current connection. The name returned matches the DBN connection parameter value. If you did not use the DBN connection parameter, the name returned is the database file without the path and extension. |
| nearest_century | Returns the nearest century the database uses for string conversions. This property corresponds to the nearest_century creation option for this database. |
| PageSize | Returns the page size of the database, in bytes. This property corresponds to the page_size creation option for the database. |
| PartialDownload | Returns Yes or No to indicate whether the database contains a partial download. |
| precision | Returns the floating-point precision the database uses for string conversions. This property corresponds to the precision creation option for the database. |
| scale | Returns the minimum number of digits after the decimal point when an arithmetic result is truncated to the maximum precision during string conversions by the database. This property corresponds to the scale creation option for the database. |
| time_format | Returns the time format the database uses for string conversions. This property corresponds to the time_format creation option for the database. |
| timestamp_format | Returns the timestamp format the database uses for string conversions. This property corresponds to the timestamp_format creation option for the database. |
| timestamp_increment | Returns the minimum difference between two unique timestamps, in microseconds. This property corresponds to the timestamp_increment creation option for the database. |
| timestamp_with_time_zone_format | Returns the timestamp format for TIMESTAMP WITH TIME ZONE values. This property corresponds to the timestamp_with_time_zone_format creation option for the database. |
|
UploadUnknown |
Returns true if the last synchronization failed after the upload was sent but before the upload acknowledgement from the synchronization server was received. When this property is true, on the next synchronization UltraLite first asks MobiLink if it received its last upload before continuing with the new synchronization. |