Titanium SDK # Titanium.Database.ResultSet
The ResultSet instance returned by execute.
0.8
0.8
9.2.0# Overview
A result set represents the results returned by a database query.
The Titanium.Database.ResultSet.rowCount property identifies the number of
rows in the result set. The ResultSet object maintains an internal record of the
current row. As shown in the example, you can use the
Titanium.Database.ResultSet.next method to iterate through the rows in the set.
Use the Titanium.Database.ResultSet.field or Titanium.Database.ResultSet.fieldByName methods to query the fields for the current row.
On the iOS platform, closing the database also closes the result set, that is, you can only access the result set if the database is currently open.
# Examples
# Using ResultSet
The following code will create a database and execute SQL statements that will create a
table, insert data into it, query the table and iterate through the returned
ResultSet.
var db = Ti.Database.open('mydb1Installed');
db.execute('CREATE TABLE IF NOT EXISTS people (name TEXT, phone_number TEXT, city TEXT)');
db.execute('DELETE FROM people');
var thisName = 'Arthur';
var thisPhoneNo = '1-617-000-0000';
var thisCity = 'Mountain View';
db.execute('INSERT INTO people (name, phone_number, city) VALUES (?, ?, ?)', thisName, thisPhoneNo, thisCity);
var personArray = ['Paul','020 7000 0000', 'London'];
db.execute('INSERT INTO people (name, phone_number, city) VALUES (?, ?, ?)', personArray);
var rows = db.execute('SELECT rowid,name,phone_number,city FROM people');
Ti.API.info('Row count: ' + rows.rowCount);
var fieldCount = rows.fieldCount;
Ti.API.info('Field count: ' + fieldCount);
while (rows.isValidRow()){
Ti.API.info('Person ---> ROWID: ' + rows.fieldByName('rowid') + ', name:' + rows.field(1) + ', phone_number: ' + rows.fieldByName('phone_number') + ', city: ' + rows.field(3));
rows.next();
}
rows.close();
db.close();
Note that the above SELECT query contains the rowid (opens new window)
field, which contains an SQLite-specific unique identifier for each row.
# Properties
# apiName READONLY
3.2.0 3.2.0 9.2.0The 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
3.0.0 3.0.0 9.2.0Indicates 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
3.6.0The 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
0.8 0.8 9.2.0Adds 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
3.0.0 3.0.0 9.2.0Applies 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
# close
0.8 0.8 9.2.0Closes this result set and release resources. Once closed, the result set must no longer be used.
Returns
- Type
- void
# field
0.8 0.8 9.2.0Retrieves the value for the specified field in the current row, and casts it to the specified type (String, Integer, Float or Double.)
All of the numeric types (Integer, Float or Double) are returned as JavaScript Number objects.
If no type parameter is specified, the returned data type depends on the data in the column.
- If the data in the column is TEXT, the data is returned as a String.
- If the data in the column is any kind of number, the data is returned as a Number.
- If the data in the column is a BLOB, the data is returned as a Titanium.Blob object.
When a type is specified and the data cannot be converted to the specified type, an
exception is thrown.
Returns null if the value in the table is NULL.
Parameters
| Name | Type | Description |
|---|---|---|
index | Number | A zero-based column index. |
type | Number | Type to cast field value. |
Returns
return type varies based on the underlying data and optional type argument. If BLOB, we return a Titanium.Blob. If TEXT, we return String. If any kind of number, we return a Number.
- Type
- String | Number | Titanium.Blob
# fieldByName
0.8 0.8 9.2.0Retrieves the value for the specified field in the current row, and casts it to the specified type (String, Integer, Float or Double.)
All of the numeric types (Integer, Float or Double) are returned as JavaScript Number objects.
If no type parameter is specified, the returned data type depends on the data in the column.
- If the data in the column is TEXT, the data is returned as a String.
- If the data in the column is any kind of number, the data is returned as a Number.
- If the data in the column is a BLOB, the data is returned as a Titanium.Blob object.
When a type is specified and the data cannot be converted to the specified type, an
exception is thrown.
Returns null if the value in the table is NULL.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | A column name or alias used in the SQL query. |
type | Number | Type to cast for the field value. |
Returns
return type varies based on the underlying data and optional type argument. If BLOB, we return a Titanium.Blob. If TEXT, we return String. If any kind of number, we return a Number.
- Type
- String | Number | Titanium.Blob
# fieldName
0.8 0.8 9.2.0Returns the field name for the specified field index.
Parameters
| Name | Type | Description |
|---|---|---|
index | Number | A zero-based column index for the field. |
Returns
- Type
- String
# fireEvent
0.8 0.8 9.2.0Fires 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
# getFieldName
0.8Returns the field name for the specified field index.
Parameters
| Name | Type | Description |
|---|---|---|
index | Number | A zero-based column index for the field. |
Returns
- Type
- String
# isValidRow
0.8 0.8 9.2.0Returns whether the current row is valid.
Returns
- Type
- Boolean
# next
0.8 0.8 9.2.0Advances to the next row in the result set and returns true if one exists,
or false otherwise.
Returns
- Type
- Boolean
# removeEventListener
0.8 0.8 9.2.0Removes 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 |
Returns
- Type
- void