Readonly columnNumber of columns returned
Readonly numThe number of entries in the array (each corresponding to a column in the database row)
Readonly parameterNumber of parameters
Readonly stateFind out whether the statement is usable (has not been finalized).
Optional aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Binds the array of parameters to the statement. When executeAsync is called, all the parameters in aParameters are bound and then executed.
This is only works on statements being used asynchronously.
The array of parameters to bind to the statement upon execution.
Create a clone of this statement, by initializing a new statement with the same connection and same SQL statement as this one. It does not preserve statement state; that is, if a statement is being executed when it is cloned, the new statement will not be executing.
Escape a string for SQL LIKE search.
Consumers will have to use same escape char when doing statements such as: ...LIKE '?1' ESCAPE '/'...
an AString of an escaped version of aValue (%, _ and the escape char are escaped with the escape char) For example, we will convert "foo/bar_baz%20cheese" into "foo//bar/_baz/%20cheese" (if the escape char is '/').
The string to escape for SQL LIKE.
The escape character.
Execute a query asynchronously using any currently bound parameters. This statement can be reused immediately, and reset does not need to be called.
If you have any custom defined functions, they must be re-entrant since they can be called on multiple threads.
an object that can be used to cancel the statements execution.
[optional] The callback object that will be notified of progress, errors, and completion.
Execute a query, using any currently-bound parameters. Reset must be called on the statement after the last call of executeStep.
a boolean indicating whether there are more rows or not; row data may be accessed using mozIStorageValueArray methods on the statement.
Finalizes a statement so you can successfully close a database connection. Once a statement has been finalized it can no longer be used for any purpose.
Statements are implicitly finalized when their reference counts hits zero. If you are a native (C++) caller this is accomplished by setting all of your nsCOMPtr instances to be NULL. If you are operating from JavaScript code then you cannot rely on this behavior because of the involvement of garbage collection.
When finalizing an asynchronous statement you do not need to worry about whether the statement has actually been executed by the asynchronous thread; you just need to call finalize after your last call to executeAsync involving the statement. However, you do need to use asyncClose instead of close on the connection if any statements have been used asynchronously.
@}
Retrieve the contents of a column from the current result row as a blob.
0-based colummn index. @param[out] aDataSize The number of bytes in the blob. @param[out] aData The contents of the BLOB. This will be NULL if aDataSize == 0.
Retrieve the contents of a Blob column from the current result row as a UTF8 string.
The value for the result Blob column interpreted as a UTF8 String. No encoding conversion is performed.
0-based colummn index.
Returns a shared string pointer.
0-based colummn index.
The number of bytes in the string or blob. This is the same as the number of characters for UTF-8 strings, and twice the number of characters for UTF-16 strings.
A pointer to the string or blob.
Indicate the data type of the current result row for the the given column. SQLite will perform type conversion if you ask for a value as a different type than it is stored as.
The type of the value at the given column index; one of VALUE_TYPE_NULL, VALUE_TYPE_INTEGER, VALUE_TYPE_FLOAT, VALUE_TYPE_TEXT, VALUE_TYPE_BLOB.
0-based column index.
Retrieve the contents of a column from the current result row as a string.
The value for the result column interpreted as a string. If the stored value was NULL, you will get an empty string with IsVoid set to distinguish it from an explicitly set empty string. @{
0-based colummn index.
Creates a new mozIStorageBindingParamsArray that can be used to bind multiple sets of data to a statement with bindParameters.
a mozIStorageBindingParamsArray that multiple sets of parameters can be bound to.
This is only useful for statements being used asynchronously.
Generated using TypeDoc
A SQL statement that can be used for both synchronous and asynchronous purposes.