# Titanium.Database
The top-level Database
module, used for creating and accessing the
in-application SQLite database.
# Methods
# install
Installs an SQLite database to device's internal storage.
Copies an SQLite database file to the device's internal storage (only) and creates a persistent name that is available for the lifetime of the app. On Android, if the source file does not exist, an empty database is created.
Returns a reference to the opened database. If the destination file already exists, behaves as open.
This method is primarily used for iOS.
With Android, as there is often minimal internal storage available, install
may only be appropriate for small databases or for prototyping. When database
files are to be stored on external storage (for example, SD Card), a combination of
Titanium.Filesystem and open is required.
With Titanium 1.8.0.1 on iOS, the default database location changed in accordance
with Apple's guidelines. If a database file already exists in the old
location, install
will automatically move it to the new location
rather than copying the file from the path provided in the first
argument.
Files stored in the Private Documents
directory on iOS5 will be
automatically backed up to iCloud and removed from the device in low
storage situations. See
How do I prevent files from being backed up to iCloud and iTunes?
for details. To prevent this for database files, use the file
object with the remoteBackup property.
Always close the database after use.
Parameters
Name | Type | Description |
---|---|---|
path | String | Path and filename of the database file to copy to internal storage. File location is relative to the script's context unless an absolute path, such as one constructed with a Titanium.Filesystem constant, is used. |
dbName | String | Destination filename or absolute path, which will subsequently be passed to open. |
Returns
- Type
- Titanium.Database.DB
# open
Opens an SQLite database.
Opens an SQLite database and returns a reference to it. If the database does not exist, creates an empty database file and returns a reference to this opened database.
With Titanium 1.8.0.1 on iOS, the default database location changed in accordance
with Apple's guidelines. If a database file already exists in the old
location, open
will automatically move it to the new location.
Always close the database after use.
Parameters
Name | Type | Description |
---|---|---|
dbName | String | The dbname previously passed to install. An absolute path to the file, including one that is constructed with a Titanium.Filesystem constant or directoryForSuite method, may be used. |
Returns
- Type
- Titanium.Database.DB
# Constants
# FIELD_TYPE_DOUBLE
Constant for requesting a column's value returned in double form.
# FIELD_TYPE_FLOAT
Constant for requesting a column's value returned in float form.
# FIELD_TYPE_INT
Constant for requesting a column's value returned in integer form.
# FIELD_TYPE_STRING
Constant for requesting a column's value returned in string form.