Public Member Functions | Public Attributes | List of all members
sbIDatabaseEngine Interface Reference

[USER CODE SHOULD NOT REFERENCE THIS CLASS] More...

import"sbIDatabaseEngine.idl";

Inheritance diagram for sbIDatabaseEngine:
[legend]
Collaboration diagram for sbIDatabaseEngine:
[legend]

Public Member Functions

PRInt32 SubmitQuery (in CDatabaseQueryPtr aDBQuery)
 Submit a query to the database engine for processing. More...
 
void closeDatabase (in AString aDatabaseGUID)
 Shutdown a database. More...
 
void dumpDatabase (in AString aDatabaseGUID, in nsIFile aOutFile)
 Dump the contents of a database to file. More...
 
void dumpMemoryStatistics ()
 Dump memory usage to the console. See components/dbengine/src/sqlite3.c#6625 for details. More...
 
long getCurrentMemoryUsage (in long flag)
 Get the current amount of memory in use for a given sqlite3 flag. More...
 
long getHighWaterMemoryUsage (in long flag)
 Get the high water mark memory in use for a given SQLite3 flag. More...
 
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. More...
 

Public Attributes

const long DATABASE_MEMORYUSED = 0
 MEMORYUSED: total dynamically alocated memory use. More...
 
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) More...
 
readonly attribute AString localeCollationID
 Returns the identifier of the localized collation sequence. More...
 

Detailed Description

[USER CODE SHOULD NOT REFERENCE THIS CLASS]

You should use the sbIDatabaseQuery object to submit SQL queries to the database.

See Also
sbIDatabaseQuery, sbIDatabaseResult

Definition at line 50 of file sbIDatabaseEngine.idl.

Member Function Documentation

void sbIDatabaseEngine::closeDatabase ( in AString  aDatabaseGUID)

Shutdown a database.

Note
Do not use this method unless you really know why you are using it.
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.
void sbIDatabaseEngine::dumpDatabase ( in AString  aDatabaseGUID,
in nsIFile  aOutFile 
)

Dump the contents of a database to file.

void sbIDatabaseEngine::dumpMemoryStatistics ( )

Dump memory usage to the console. See components/dbengine/src/sqlite3.c#6625 for details.

long sbIDatabaseEngine::getCurrentMemoryUsage ( in long  flag)

Get the current amount of memory in use for a given sqlite3 flag.

long sbIDatabaseEngine::getHighWaterMemoryUsage ( in long  flag)

Get the high water mark memory in use for a given SQLite3 flag.

void sbIDatabaseEngine::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.

PRInt32 sbIDatabaseEngine::SubmitQuery ( in CDatabaseQueryPtr  aDBQuery)

Submit a query to the database engine for processing.

Parameters
aDBQuery- Native CDatabaseQuery Pointer.
See Also
sbIDatabaseQuery

Member Data Documentation

const long sbIDatabaseEngine::DATABASE_MEMORYUSED = 0

MEMORYUSED: total dynamically alocated memory use.

SQLITE memory usage flags:

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

Definition at line 99 of file sbIDatabaseEngine.idl.

const long sbIDatabaseEngine::DATABASE_PAGECACHEOVERFLOW = 2

Definition at line 101 of file sbIDatabaseEngine.idl.

const long sbIDatabaseEngine::DATABASE_PAGECACHEUSED = 1

Definition at line 100 of file sbIDatabaseEngine.idl.

attribute boolean sbIDatabaseEngine::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)

Definition at line 116 of file sbIDatabaseEngine.idl.

readonly attribute AString sbIDatabaseEngine::localeCollationID

Returns the identifier of the localized collation sequence.

Definition at line 121 of file sbIDatabaseEngine.idl.

The documentation for this interface was generated from the following file: