mozIStorageConnection represents a database connection attached to
a specific file or to the in-memory data storage. It is the
primary interface for interacting with a database, including
creating prepared statements, executing SQL, and examining database
errors.
@note From the main thread, you should rather use mozIStorageAsyncConnection.
@threadsafe
Closes a database connection. Callers must finalize all statements created
for this connection prior to calling this method. It is illegal to use
call this method if any asynchronous statements have been executed on this
connection.
@throws NS_ERROR_UNEXPECTED
If any statement has been executed asynchronously on this object.
@throws NS_ERROR_UNEXPECTED
If is called on a thread other than the one that opened it.
Clones a database connection and makes the clone read only if needed.
@throws NS_ERROR_UNEXPECTED
If this connection is a memory database.
@note If your connection is already read-only, you will get a read-only
clone.
@note Due to a bug in SQLite, if you use the shared cache (openDatabase),
you end up with the same privileges as the first connection opened
regardless of what is specified in aReadOnly.
@note The following pragmas are copied over to a read-only clone:
- cache_size
- temp_store
The following pragmas are copied over to a writeable clone:
- cache_size
- temp_store
- foreign_keys
- journal_size_limit
- synchronous
- wal_autocheckpoint
| aReadOnly | If true, the returned database should be put into read-only mode. Defaults to false. |
| the cloned database connection. |
Create a mozIStorageStatement for the given SQL expression. The
expression may use ? to indicate sequential numbered arguments,
?1, ?2 etc. to indicate specific numbered arguments or :name and
$var to indicate named arguments.
| aSQLStatement | The SQL statement to execute. |
| a new mozIStorageStatement |
Execute a SQL expression, expecting no arguments.
| aSQLStatement | The SQL statement to execute |
Check if the given table exists.
| aTableName | The table to check |
| TRUE if table exists, FALSE otherwise. |
Check if the given index exists.
| aIndexName | The index to check |
| TRUE if the index exists, FALSE otherwise. |
Begin a new transaction. sqlite default transactions are deferred.
If a transaction is active, throws an error.
Commits the current transaction. If no transaction is active,
@throws NS_ERROR_UNEXPECTED.
@throws NS_ERROR_NOT_INITIALIZED.
Rolls back the current transaction. If no transaction is active,
@throws NS_ERROR_UNEXPECTED.
@throws NS_ERROR_NOT_INITIALIZED.
Create the table with the given name and schema.
If the table already exists, NS_ERROR_FAILURE is thrown.
(XXX at some point in the future it will check if the schema is
the same as what is specified, but that doesn’t happen currently.)
@throws NS_ERROR_FAILURE
If the table already exists or could not be created for any other
reason.
| aTableName | The table name to be created, consisting of [A-Za-z0-9_], and beginning with a letter. |
| aTableSchema | The schema of the table; what would normally go between the parens in a CREATE TABLE statement: e.g., "foo INTEGER, bar STRING". |
Controls SQLITE_FCNTL_CHUNK_SIZE setting in sqlite. This helps avoid fragmentation
by growing/shrinking the database file in SQLITE_FCNTL_CHUNK_SIZE increments. To
conserve memory on systems short on storage space, this function will have no effect
on mobile devices or if less than 500MiB of space is left available.
| aIncrement | The database file will grow in multiples of chunkSize. |
| aDatabaseName | Sqlite database name. "" means pass NULL for zDbName to sqlite3_file_control. See http://sqlite.org/c3ref/file_control.html for more details. @throws NS_ERROR_FILE_TOO_BIG If the system is short on storage space. |
Enable a predefined virtual table implementation.
@throws NS_ERROR_FAILURE
For unknown module names.
| aModuleName | The module to enable. Only "filesystem" is currently supported. |
The default size for SQLite database pages used by mozStorage for new
databases.
Indicates if the connection is open and ready to use. This will be false
if the connection failed to open, or it has been closed.
lastInsertRowID returns the row ID from the last INSERT
operation.
affectedRows returns the number of database rows that were changed or
inserted or deleted by last operation.
The last error SQLite error code.
The last SQLite error as a string (in english, straight from the
sqlite library).
The schema version of the database. This should not be used until the
database is ready. The schema will be reported as zero if it is not set.
Returns true if a transaction is active on this connection.
Begins a new transaction with the given type.