Class RDbStoreDatabase

class RDbStoreDatabase : public RDbDatabase;

Description

DBMS Store database implementation

Derivation

• RDbDatabase - Abstract class providing the functionality of a database.

• RDbStoreDatabase - DBMS Store database implementation

Members

Defined in RDbStoreDatabase:

• CompressL(CStreamStore &,TStreamId)
• CreateL(CStreamStore *)Creates a new non-secure, non-shareable database, which will be located in a str...
• DecompressL(CStreamStore &,TStreamId)
• OpenL(CStreamStore *,TStreamId)Opens an existing non-secure, non-shareable database, which is located in a stre...

Inherited from RDbDatabase:

• AlterTable(const TDesC &,const CDbColSet &)Alters a table synchronously.
• Begin()Begins a transaction.
• Close()Closes a database. Commits any pending transaction. Frees the allocated resource...
• ColSetL(const TDesC &)constReturns the table definition.
• Commit()Commits the current transaction.
• Compact()Synchronous database compaction. Compacts the database and returns when complete...
• CreateIndex(const TDesC &,const TDesC &,const CDbKey &)Creates an index synchronously.
• CreateTable(const TDesC &,const CDbColSet &)Creates a table on the database.
• CreateTable(const TDesC &,const CDbColSet &,const CDbKey &)Creates a table on the database.
• Destroy()Drops the tables and destroys the database. This handle is closed on successful ...
• DropIndex(const TDesC &,const TDesC &)Drops an index synchronously.
• DropTable(const TDesC &)Drops a table synchronously.
• Execute(const TDesC &,TDbTextComparison)Executes a SQL statement on the database, and returns when it is complete. The a...
• InTransaction()const
• IndexNamesL(const TDesC &)constLists the indexes on a table.
• IsDamaged()constReports the damage status of the database. The function checks database indexes ...
• KeyL(const TDesC &,const TDesC &)constReturns the index key.
• Recover()Synchronous database recovery. RDbDatabase::Recover() will try to rebuild databa...
• Rollback()Rollbacks the current transaction.
• Size()constReturns the currently available size information for the database. This comprise...
• TSize
• TableNamesL()constLists the tables on the database.
• UpdateStats()Update any calculated statistics for the database. Note that this can take an ex...
• iDatabase

IMPORT_C TStreamId CreateL(CStreamStore *aStore);

Description

Creates a new non-secure, non-shareable database, which will be located in a stream store.

Note: RDbNamedDatabase should always be the preferred choice, except the following two cases:

 - your intention is to create, fill and then compress a database, which will be used only in a read-only mode;
 - your intention is to create a database in a stream store, which stream store will be used for storing
   some additional, non-database data;

Parameters

CStreamStore *aStore The stream store object, where the database will be created.

Return value

TStreamId The id of the root stream of the created database.

Leave codes

System-wide or database specific error codes.

See also:

• RDbNamedDatabaseGeneric database implementation

IMPORT_C void OpenL(CStreamStore *aStore, TStreamId anId);

Description

Opens an existing non-secure, non-shareable database, which is located in a stream store.

Note: RDbNamedDatabase should always be the preferred choice, except the following two cases:

 - your intention is to create, fill and then compress a database, which will be used only in a read-only mode;
 - your intention is to create a database in a stream store, which stream store will be used for storing
   some additional, non-database data;

Parameters

CStreamStore *aStore The stream store object, where the database is located. TStreamId anId The id of the root stream of the database.

Leave codes

System-wide or database specific error codes.

See also:

• RDbStoreDatabase::CreateL(CStreamStore *)Creates a new non-secure, non-shareable database, which will be located in a str...
• RDbNamedDatabaseGeneric database implementation

IMPORT_C static void CompressL(CStreamStore &aStore, TStreamId aId);

Description

Parameters

CStreamStore &aStore TStreamId aId

IMPORT_C static void DecompressL(CStreamStore &aStore, TStreamId aId);

Description

Parameters

CStreamStore &aStore TStreamId aId