The base interface for both pure asynchronous storage statements
(mozIStorageAsyncStatement) and ‘classic’ storage statements
(mozIStorageStatement) that can be used for both synchronous and asynchronous
purposes.
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.
Bind the given value at the given numeric index.
| aParamIndex | 0-based index, 0 corresponding to the first numbered argument or "?1". |
| aValue | Argument value. |
| aValueSize | Length of aValue in bytes. @{ |
@}*/
Binds the array of parameters to the statement. When executeAsync is
called, all the parameters in aParameters are bound and then executed.
@note This is only works on statements being used asynchronously.
| aParameters | The array of parameters to bind to the statement upon execution. |
Creates a new mozIStorageBindingParamsArray that can be used to bind
multiple sets of data to a statement with bindParameters.
@note This is only useful for statements being used asynchronously.
| a mozIStorageBindingParamsArray that multiple sets of parameters can be bound to. |
Execute a query asynchronously using any currently bound parameters. This
statement can be reused immediately, and reset does not need to be called.
@note If you have any custom defined functions, they must be re-entrant
since they can be called on multiple threads.
| aCallback | [optional] The callback object that will be notified of progress, errors, and completion. |
| an object that can be used to cancel the statements execution. |
Escape a string for SQL LIKE search.
@note Consumers will have to use same escape char when doing statements
such as: …LIKE ‘?1’ ESCAPE ‘/’…
| aValue | The string to escape for SQL LIKE. |
| aEscapeChar | The escape character. |
| 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 '/'). |
Find out whether the statement is usable (has not been finalized).
The statement is not usable, either because it failed to initialize or
was explicitly finalized.
The statement is usable.
Indicates that the statement is executing and the row getters may be used.
@note This is only relevant for mozIStorageStatement instances being used
in a synchronous fashion.