Titanium Mobile

# Titanium.Database.ResultSet

The ResultSet instance returned by execute.

Availability
0.8
0.8
9.2.0
Extends
Titanium.Proxy

# 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

# fieldCount READONLY

Availability
0.8
3.3.0
9.2.0
fieldCount :Number

The number of columns in this result set.

# rowCount READONLY

Availability
0.8
0.8
9.2.0
rowCount :Number

The number of rows in this result set.

# validRow READONLY

Availability
0.8
0.8
9.2.0
validRow :Boolean

Indicates whether the current row is valid.

# Methods

# close

Availability
0.8
0.8
9.2.0
close() → void

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

Returns

Type
void

# field

Availability
0.8
0.8
9.2.0
field(index[, type]) → String | Number | Titanium.Blob

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

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

Availability
0.8
0.8
9.2.0
fieldByName(name[, type]) → String | Number | Titanium.Blob

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

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

Availability
0.8
0.8
9.2.0
fieldName(index) → String

Returns 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

# getFieldName

Availability
0.8
getFieldName(index) → String

Returns 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

Availability
0.8
0.8
9.2.0
isValidRow() → Boolean

Returns whether the current row is valid.

Returns

Type
Boolean

# next

Availability
0.8
0.8
9.2.0
next() → Boolean

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

Returns

Type
Boolean

Contents