# Titanium.Database

The top-level Database module, used for creating and accessing the in-application SQLite database.

Availability
0.8
0.8
9.2.0

# Properties

# apiName READONLY

Availability
3.2.0
3.2.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.


# bubbleParent

Availability
3.0.0
3.0.0
9.2.0
bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true


# lifecycleContainer

Availability
3.6.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# Methods

# addEventListener

Availability
0.8
0.8
9.2.0
addEventListener(name, callback) void

Adds the specified callback as an event listener for the named event.

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
3.0.0
3.0.0
9.2.0
applyProperties(props) void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
0.8
0.8
9.2.0
fireEvent(name[, event]) void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type
void

# install

Availability
0.8
0.8
9.2.0
install(path, dbName) Titanium.Database.DB

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


# open

Availability
0.8
0.8
9.2.0
open(dbName) Titanium.Database.DB

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


# removeEventListener

Availability
0.8
0.8
9.2.0
removeEventListener(name, callback) void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

# Constants

# FIELD_TYPE_DOUBLE

Availability
0.8
0.8
9.2.0
FIELD_TYPE_DOUBLE :Number

Constant for requesting a column's value returned in double form.


# FIELD_TYPE_FLOAT

Availability
0.8
0.8
9.2.0
FIELD_TYPE_FLOAT :Number

Constant for requesting a column's value returned in float form.


# FIELD_TYPE_INT

Availability
0.8
0.8
9.2.0
FIELD_TYPE_INT :Number

Constant for requesting a column's value returned in integer form.


# FIELD_TYPE_STRING

Availability
0.8
0.8
9.2.0
FIELD_TYPE_STRING :Number

Constant for requesting a column's value returned in string form.