Titanium.Database.DB
The Database instance returned by Titanium.Database.open or Titanium.Database.install.
Extends: Titanium.Proxy · Since: 0.1 · Platforms: android, iphone, ipad, macos
Properties #
apiName#
Type: 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, Button
returns Ti.UI.Button.
bubbleParent#
Type: 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.
file#
Type: Titanium.Filesystem.File
A File object representing the file where this database is stored. Must only be used for
setting file properties.
lifecycleContainer#
Type: Titanium.UI.Window, Titanium.UI.TabGroup
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 #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
applyProperties #
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.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
close #
Closes the database and releases resources from memory. Once closed, this instance is no
longer valid and should not be used. On iOS, also closes all Titanium.Database.ResultSet
instances that exist.
execute #
Executes an SQL statement against the database and returns a ResultSet.
| Name | Type | Summary | Optional |
|---|---|---|---|
sql | String | SQL to execute. May include placeholders for parameter substitution. | No |
vararg | String, Array<String>, Object, Array<Object> | Either a variable ordered list of zero or more values, or an array of values, to be substituted with the respective ? placeholder of the query. | Yes |
Returns: Titanium.Database.ResultSet
executeAll #
Synchronously executes an array of SQL statements against the database and returns an array of ResultSet.
On failure, this will throw an Error that reports the failed index and partial results
| Name | Type | Summary | Optional |
|---|---|---|---|
queries | Array<String> | Array of SQL queries to execute. | No |
Returns: Array<Titanium.Database.ResultSet>
executeAllAsync #
Asynchronously executes an array of SQL statements against the database and fires a callback with a possible Error, and an array of ResultSet.
On failure, this will call the callback with an Error that reports the failed index, and a second argument with the partial results.
| Name | Type | Summary | Optional |
|---|---|---|---|
queries | Array<String> | Array of SQL queries to execute. | No |
callback | Callback<PossibleBatchQueryError, Array<Titanium.Database.ResultSet>> | Callback when query execution has completed. | Yes |
Returns: Promise<Array<Titanium.Database.ResultSet>> — On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument.
If the `Promise` is rejected, the `Error` will have custom properties indicating the `index` of the failed query, and the partial `results` up to that failure. See <PossibleBatchQueryError>.
executeAsync #
Asynchronously executes an SQL statement against the database and fires a callback with a possible Error argument, and a second argument holding a possible ResultSet.
| Name | Type | Summary | Optional |
|---|---|---|---|
query | String | SQL query to execute. May include placeholders for parameter substitution. | No |
vararg | String, Array<String>, Object, Array<Object> | Either a variable ordered list of zero or more values, or an array of values, to be substituted with the respective ? placeholder of the query. | Yes |
callback | Callback<Object, Titanium.Database.ResultSet> | Callback when query execution has completed. | Yes |
Returns: Promise<Titanium.Database.ResultSet> — On SDK 10+, this method will return a `Promise` whose resolved value is equivalent to that passed to the optional callback argument.
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
remove #
Removes the database files for this instance from disk. WARNING: this is a destructive
operation and cannot be reversed. All data in the database will be lost; use with caution.
removeEventListener #
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);
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |