# Titanium.Database.DB

The Database instance returned by open or install.

Availability
0.8
0.8
9.2.0
4.1.0

# Properties

# file READONLY

Availability
5.4.0
2.0.0
9.2.0
4.1.0

A File object representing the file where this database is stored. Must only be used for setting file properties.


# lastInsertRowId READONLY

Availability
0.8
0.8
9.2.0
4.1.0
lastInsertRowId :Number

The identifier of the last populated row.


# name READONLY

Availability
0.8
0.8
9.2.0
4.1.0
name :String

The name of the database.


# rowsAffected READONLY

Availability
0.8
0.8
9.2.0
4.1.0
rowsAffected :Number

The number of rows affected by the last query.

# Methods

# close

Availability
0.8
0.8
9.2.0
4.1.0
close() void

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.

Returns

Type
void

# execute

Availability
0.8
0.8
9.2.0
4.1.0
execute(sql[, ...vararg]) Titanium.Database.ResultSet

Executes an SQL statement against the database and returns a ResultSet.

Parameters

Name Type Description
sql String

SQL to execute. May include placeholders for parameter substitution.

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.

Returns


# executeAll

Availability
8.1.0
8.1.0
9.2.0
executeAll(queries) Array<Titanium.Database.ResultSet>

Synchronously executes an array of SQL statements against the database and returns an array of ResultSet. On failure, this will throw an BatchQueryError that reports the failed index and partial results

Parameters

Name Type Description
queries Array<String>

Array of SQL queries to execute.

Returns


# executeAllAsync

Availability
8.1.0
8.1.0
9.2.0
executeAllAsync(queries[, callback]) Promise<Array<Titanium.Database.ResultSet>>

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 PossibleBatchQueryError that reports the failed index, and a second argument with the partial results.

Parameters

Name Type Description
queries Array<String>

Array of SQL queries to execute.

callback Callback<PossibleBatchQueryError, Array<Titanium.Database.ResultSet>>

Callback when query execution has completed.

Returns

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.

Type
Promise<Array<Titanium.Database.ResultSet>>

# executeAsync

Availability
8.1.0
8.1.0
9.2.0
executeAsync(query[, vararg[, callback]]) Promise<Titanium.Database.ResultSet>

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.

Parameters

Name Type Description
query String

SQL query to execute. May include placeholders for parameter substitution.

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.

callback Callback<Object, Titanium.Database.ResultSet>

Callback when query execution has completed.

Returns

On SDK 10+, this method will return a Promise whose resolved value is equivalent to that passed to the optional callback argument.

Type
Promise<Titanium.Database.ResultSet>

# remove

Availability
0.8
0.8
9.2.0
4.1.0
remove() void

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.

Returns

Type
void