RDbTable Class Reference

class RDbTable : public RDbRowSet

Provides access to table data as a rowset, allowing manipulation of a named table in the database. Additionally, a named index can be used to order the rowset, and to provide fast key-based row retrieval from the table.

There are no special rules to consider when deriving from this class.

Inherits from

Public Member Functions
IMPORT_C TInt Open ( RDbDatabase &, const TDesC &, TAccess )
IMPORT_C TBool SeekL (const TDbSeekKey &, TComparison )
TInt SetIndex (const TDesC &)
TInt SetNoIndex ()
Private Member Functions
IMPORT_C TInt SetIndex (const TDesC *)
Inherited Functions
RDbRowSet::AtBeginning()const
RDbRowSet::AtEnd()const
RDbRowSet::AtRow()const
RDbRowSet::BeginningL()
RDbRowSet::Bookmark()const
RDbRowSet::Cancel()
RDbRowSet::Close()
RDbRowSet::ColCount()const
RDbRowSet::ColDef(TDbColNo)const
RDbRowSet::ColDes(TDbColNo)const
RDbRowSet::ColDes16(TDbColNo)const
RDbRowSet::ColDes8(TDbColNo)const
RDbRowSet::ColInt(TDbColNo)const
RDbRowSet::ColInt16(TDbColNo)const
RDbRowSet::ColInt32(TDbColNo)const
RDbRowSet::ColInt64(TDbColNo)const
RDbRowSet::ColInt8(TDbColNo)const
RDbRowSet::ColLength(TDbColNo)const
RDbRowSet::ColReal(TDbColNo)const
RDbRowSet::ColReal32(TDbColNo)const
RDbRowSet::ColReal64(TDbColNo)const
RDbRowSet::ColSetL()const
RDbRowSet::ColSize(TDbColNo)const
RDbRowSet::ColTime(TDbColNo)const
RDbRowSet::ColType(TDbColNo)const
RDbRowSet::ColUint(TDbColNo)const
RDbRowSet::ColUint16(TDbColNo)const
RDbRowSet::ColUint32(TDbColNo)const
RDbRowSet::ColUint8(TDbColNo)const
RDbRowSet::CountL(TAccuracy)const
RDbRowSet::DeleteL()
RDbRowSet::EndL()
RDbRowSet::FindL(TDirection,TDbQuery)
RDbRowSet::FirstL()
RDbRowSet::GetL()
RDbRowSet::GotoL(TPosition)
RDbRowSet::GotoL(const TDbBookmark &)
RDbRowSet::InsertCopyL()
RDbRowSet::InsertL()
RDbRowSet::IsColNull(TDbColNo)const
RDbRowSet::IsEmptyL()const
RDbRowSet::LastL()
RDbRowSet::MatchL(const RDbRowConstraint &)
RDbRowSet::NextL()
RDbRowSet::PreviousL()
RDbRowSet::PutL()
RDbRowSet::Reset()
RDbRowSet::SetColL(TDbColNo,TInt)
RDbRowSet::SetColL(TDbColNo,TInt32)
RDbRowSet::SetColL(TDbColNo,TInt64)
RDbRowSet::SetColL(TDbColNo,TReal32)
RDbRowSet::SetColL(TDbColNo,TReal64)
RDbRowSet::SetColL(TDbColNo,TTime)
RDbRowSet::SetColL(TDbColNo,TUint)
RDbRowSet::SetColL(TDbColNo,TUint32)
RDbRowSet::SetColL(TDbColNo,const TDesC16 &)
RDbRowSet::SetColL(TDbColNo,const TDesC8 &)
RDbRowSet::SetColNullL(TDbColNo)
RDbRowSet::UpdateL()
Public Member Enumerations
enum TComparison { ELessThan , ELessEqual , EEqualTo , EGreaterEqual , EGreaterThan }
Inherited Enumerations
RDbRowSet:TAccess
RDbRowSet:TAccuracy
RDbRowSet:TDirection
RDbRowSet:TPosition
Inherited Attributes
RDbRowSet::iCursor

Member Functions Documentation

Open(RDbDatabase &, const TDesC &, TAccess)

IMPORT_C TInt Open ( RDbDatabase & aDatabase,
const TDesC & aName,
TAccess anAccess = EUpdatable
)

Opens the named table object on a database with the specified access.

If successful, the rowset is positioned to the beginning.

capability
Note For a secure shared database, the caller must satisfy either the read or the write access policy for the table.

Parameters

RDbDatabase & aDatabase The database on which to open the table.
const TDesC & aName The name of the table to open.
TAccess anAccess = EUpdatable The access specification for the rowset, the default is updatable access.

SeekL(const TDbSeekKey &, TComparison)

IMPORT_C TBool SeekL ( const TDbSeekKey & aKey,
TComparison aComparison = EEqualTo
)

Parameters

const TDbSeekKey & aKey
TComparison aComparison = EEqualTo

SetIndex(const TDesC &)

TInt SetIndex ( const TDesC & anIndex ) [inline]

Sets the specified index as the active index for this table. The rows will be presented in index order, and this index key will be used for lookup by the SeekL() function.

If successful, the rowset is reset to the beginning.

capability
Note For a secure shared database, the caller must satisfy the read access policy for the table.

Parameters

const TDesC & anIndex The name of the index to activate.

SetIndex(const TDesC *)

IMPORT_C TInt SetIndex ( const TDesC * anIndex ) [private]

Sets the specified index as the active index for this table. The rows will be presented in index order, and this index key will be used for lookup by the SeekL() function.

If successful, the rowset is reset to the beginning.

capability
Note For a secure shared database, the caller must satisfy the read access policy for the table.

Parameters

const TDesC * anIndex The name of the index to activate.

SetNoIndex()

TInt SetNoIndex ( ) [inline]

Sets the ordering to be the underlying ordering of the rows this will usually provide faster navigation of the rowset.

capability
Note For a secure shared database, the caller must satisfy the read access policy for the table.

Member Enumerations Documentation

Enum TComparison

Database table seek comparison types.

Enumerators

ELessThan

Retrieve the last row which is strictly less than the key value.

ELessEqual

Retrieve the last row which is equal to or less than the key value.

EEqualTo

Retrieve the first row which is equal to the key value.

EGreaterEqual

Retrieve the first row which is equal to or greater than the key value.

EGreaterThan

Retrieve the first row which is strictly greater than the key value.