import "sbIDatabaseEngine.idl";
Public Member Functions | |
PRInt32 | SubmitQuery (in CDatabaseQueryPtr aDBQuery) |
Submit a query to the database engine for processing. | |
void | closeDatabase (in AString aDatabaseGUID) |
Shutdown a database. | |
void | dumpDatabase (in AString aDatabaseGUID, in nsIFile aOutFile) |
Dump the contents of a database to file. | |
void | dumpMemoryStatistics () |
Dump memory usage to the console. See components/dbengine/src/sqlite3.c#6625 for details. | |
long | getCurrentMemoryUsage (in long flag) |
Get the current amount of memory in use for a given sqlite3 flag. | |
long | getHighWaterMemoryUsage (in long flag) |
Get the high water mark memory in use for a given SQLite3 flag. | |
void | releaseMemory () |
Release all non-essential memory. Attempt to release all non-essential memory currently held by SQLite. An example of non-essential memory is memory used to cache database pages that are not currently in use. | |
Public Attributes | |
const long | DATABASE_MEMORYUSED = 0 |
MEMORYUSED: total dynamically alocated memory use. PAGECACHEUSED: total used pre-allocated page cache. PAGECACHEOVERFLOW: dynamically allocated page-cache use. There are other allowable flags but the rest are usually not useful. see: http://www.sqlite.org/c3ref/c_status_malloc_size.html. | |
const long | DATABASE_PAGECACHEUSED = 1 |
const long | DATABASE_PAGECACHEOVERFLOW = 2 |
attribute boolean | localeCollationEnabled |
This flag may be set to false to disable locale collation sequences (eg, for consistent unit tests regardless of locale and platform collation implementation). | |
readonly attribute AString | localeCollationID |
Returns the identifier of the localized collation sequence. |
You should use the sbIDatabaseQuery object to submit SQL queries to the database.
Definition at line 50 of file sbIDatabaseEngine.idl.
PRInt32 sbIDatabaseEngine::SubmitQuery | ( | in CDatabaseQueryPtr | aDBQuery | ) |
Submit a query to the database engine for processing.
aDBQuery | - Native CDatabaseQuery Pointer. |
void sbIDatabaseEngine::closeDatabase | ( | in AString | aDatabaseGUID | ) |
Shutdown a database.
You are not guaranteed that the database will remain shutdown. If a query is submitted that requires access to this database, it will be reopened.
const long sbIDatabaseEngine::DATABASE_MEMORYUSED = 0 |
MEMORYUSED: total dynamically alocated memory use. PAGECACHEUSED: total used pre-allocated page cache. PAGECACHEOVERFLOW: dynamically allocated page-cache use. There are other allowable flags but the rest are usually not useful. see: http://www.sqlite.org/c3ref/c_status_malloc_size.html.
SQLITE memory usage flags:
Definition at line 99 of file sbIDatabaseEngine.idl.