nsIFile backupDB ( AString fileName , nsIFile parentDirectory )

Copies the current database file to the specified parent directory with the specified file name. If the parent directory is not specified, it places the backup in the same directory as the current file. This function ensures that the file being created is unique.

Arguments:

fileName: The name of the new file to create.

parentDirectory

Returns:

nsIFile representing the backup file.

void beginTransaction ( )

Begin a new transaction. sqlite default transactions are deferred. If a transaction is active, throws an error.

void beginTransactionAs ( PRInt32 transactionType )

Arguments:

transactionType

void close ( )

Closes a database connection. C++ callers should simply set the database variable to NULL.

void commitTransaction ( )

Commits the current transaction. If no transaction is active,

void createAggregateFunction ( AUTF8String functionName , PRInt32 numArguments , mozIStorageAggregateFunction function )

Create a new SQLite aggregate function

Arguments:

functionName: The name of aggregate function to create, as seen in SQL.

numArguments: The number of arguments the function takes. Pass -1 for variable-argument functions.

function: The instance of mozIStorageAggreagteFunction, which implements the function in question.

void createFunction ( AUTF8String functionName , PRInt32 numArguments , mozIStorageFunction function )

Create a new SQLite function

Arguments:

functionName: The name of function to create, as seen in SQL.

numArguments: The number of arguments the function takes. Pass -1 for variable-argument functions.

function: The instance of mozIStorageFunction, which implements the function in question.

mozIStorageStatement createStatement ( AUTF8String SQLStatement )

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.

Arguments:

SQLStatement: The SQL statement to execute

void createTable ( char* tableName , char* tableSchema )

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.)

Arguments:

tableName: the table name to be created, consisting of [A-Za-z0-9_], and beginning with a letter.

tableSchema: the schema of the table; what would normally go between the parens in a CREATE TABLE statement: e.g., "foo INTEGER, bar STRING".

void executeSimpleSQL ( AUTF8String SQLStatement )

Execute a SQL expression, expecting no arguments.

Arguments:

SQLStatement: The SQL statement to execute

PRBool indexExists ( AUTF8String indexName )

Check if the given index exists.

Arguments:

indexName: The index to check

void removeFunction ( AUTF8String functionName )

Delete custom SQLite function (simple or aggregate one)

Arguments:

functionName: The name of function to remove.

mozIStorageProgressHandler removeProgressHandler ( )

Remove a progress handler.

Returns:

previous registered handler.

void rollbackTransaction ( )

Rolls back the current transaction. If no transaction is active,

mozIStorageProgressHandler setProgressHandler ( PRInt32 granularity , mozIStorageProgressHandler handler )

Sets a progress handler. Only one handler can be registered at a time. If you need more than one, you need to chain them yourself.

Arguments:

granularity: The number of SQL virtual machine steps between progress handler callbacks.

handler: The instance of mozIStorageProgressHandler.

Returns:

previous registered handler.

PRBool tableExists ( AUTF8String tableName )

Check if the given table exists.

Arguments:

tableName: The table to check