Skip to content
Titanium SDK
Version13.1.1

You are reading 13.1.1. See this page in 13.4.1.

Titanium.Database.ResultSet

proxyAndroidiPhoneiPadmacOSsince 0.1

Extends Titanium.Proxy

The ResultSet instance returned by Titanium.Database.DB.execute.

A result set represents the results returned by a database query.

The 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 next method to iterate through the rows in the set.

Use the field or 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 field, which contains an SQLite-specific unique identifier for each row.

Properties 6

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

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

Default: true

fieldCount

Numbersince 3.3.0read-only

The number of columns in this result set.

rowCount

Numberread-only

The number of rows in this result set.

validRow

Booleanread-only

Indicates whether the current row is valid.

Methods 11

Inherited from Titanium.Proxy

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

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

Callback function to invoke when the event is fired.

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.

Closes this result set and release resources. Once closed, the result set must no longer be used.

Retrieves 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
ParametersTypeDescription
indexNumber

A zero-based column index.

type?Number

Type to cast field value.

Returns String | Number | Titanium.Blob

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.

Retrieves 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
ParametersTypeDescription
nameString

A column name or alias used in the SQL query.

type?Number

Type to cast for the field value.

Returns String | Number | Titanium.Blob

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.

Returns the field name for the specified field index.

Parameters
ParametersTypeDescription
indexNumber

A zero-based column index for the field.

Returns String

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
ParametersTypeDescription
nameString

Name of the event.

event?Dictionary

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

Returns the field name for the specified field index.

Parameters
ParametersTypeDescription
indexNumber

A zero-based column index for the field.

Returns String

Returns whether the current row is valid.

Returns Boolean

Advances to the next row in the result set and returns true if one exists, or false otherwise.

Returns Boolean

Inherited from Titanium.Proxy

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

Parameters
ParametersTypeDescription
nameString

Name of the event.

callbackCallback<Titanium.Event>

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

4 fields
bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

source Object

Source object that fired the event.

type String

Name of the event fired.