#include <Ccdb_Navigation.h>

Inheritance diagram for dbSpaces::dbcli::Navigation:

Collaboration diagram for dbSpaces::dbcli::Navigation:

Public Member Functions
	~Navigation ()

NavigationTable *	CreateTable ()

dtULARGE	GetBatchUpdateSize ()

dtULARGE	GetIncrementalFetchSize ()

dtULARGE	GetInitialFetchSize ()

dtULARGE	GetMaxFetchSize ()

const dtBOOLEAN	IsRowBindingEnabled ()

const dtBOOLEAN	IsCachingEnabled ()

const dtBOOLEAN	IsUpdatableCachingEnabled ()

dtRtnStatus	SetFetchSizeIncremental (dtULARGE)

dtRtnStatus	SetFetchSizeInitial (dtULARGE)

Public Member Functions inherited from dbSpaces::dbcli::cdbBase
	cdbBase (cdbBase *, ccdbClassType, dtBOOLEAN=TRUE)

virtual	~cdbBase ()

cdb_childList_t &	GetChildList ()

Ccoms_CommsManager *	GetTransportComms ()

ccdbClassType	GetType ()

void	SetTransportComms (Ccoms_CommsManager *)

Detailed Description

The Navigation object allows the database client API to access tables using NO-SQL methods.

The Navigation API's are a set of API's that allow access to tables in a database in a navigational method without using any SQL.

You can position (using the Find method) to a particular row in a table to read it and if required update it or delete it. Additionally you can move through the rows in a table using methods such as Next() and Previous().

The Navigation object is obtained from the Connection object.

A DatabaseException will be thrown if a database error occurs and exceptions are enabled. If exceptions are not enabled the following error methods can be used to get information about the error;

GetErrorStatus()
GetErrorCode()
GetErrorMessage()

See also: Connection.

Since: Version 1.0

Constructor & Destructor Documentation

◆ ~Navigation()

dbSpaces::dbcli::Navigation::~Navigation ( )

Navigation destructor.

Since: Version 1.0

Member Function Documentation

◆ CreateTable()

NavigationTable * dbSpaces::dbcli::Navigation::CreateTable ( )

Create a new NavigationTable object.

Returns: The new NavigationTable object.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ GetBatchUpdateSize()

dtULARGE dbSpaces::dbcli::Navigation::GetBatchUpdateSize ( )

Get the batch update size.

Returns: The batch update size.

Since: Version 1.0

◆ GetIncrementalFetchSize()

dtULARGE dbSpaces::dbcli::Navigation::GetIncrementalFetchSize ( )

Get the incremental fetch size for returning rows from the database.

Returns: The incremental fetch size.

See also: SetIncrementalFetchSize().

Since: Version 1.0

◆ GetInitialFetchSize()

dtULARGE dbSpaces::dbcli::Navigation::GetInitialFetchSize ( )

Get the initial fetch size for returning rows.

Returns: The initial fetch size.

See also: SetInitialFetchSize().

Since: Version 1.0

◆ GetMaxFetchSize()

dtULARGE dbSpaces::dbcli::Navigation::GetMaxFetchSize ( )

Get the maximum fetch size for returning rows.

Returns: The maximum fetch size.

See also: SetInitialFetchSize().

Since: Version 1.0

◆ IsCachingEnabled()

const dtBOOLEAN dbSpaces::dbcli::Navigation::IsCachingEnabled ( )

Check if table caching is enabled. If enabled then all read requests retrieve more then 1 row at a time so that next read request will attempt to retrieve the row locally first.

Returns: TRUE if is enabled; FALSE if otherwise.

Since: Version 1.0

◆ IsRowBindingEnabled()

const dtBOOLEAN dbSpaces::dbcli::Navigation::IsRowBindingEnabled ( )

Is row binding enabled?

Returns: TRUE if is enabled; FALSE if otherwise.

Since: Version 1.0

◆ IsUpdatableCachingEnabled()

const dtBOOLEAN dbSpaces::dbcli::Navigation::IsUpdatableCachingEnabled ( )

Check if updatable table caching is enabled. If enabled then all update requests are cached locally until a read or a close request is made on the cached table.

Returns: TRUE if is enabled; FALSE if otherwise.

Since: Version 1.0

◆ SetFetchSizeIncremental()

dtRtnStatus dbSpaces::dbcli::Navigation::SetFetchSizeIncremental ( dtULARGE )

Set the row cache incremental fetch size for the navigation connection.

Parameters

size	The incremental fetch size.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Since: Version 1.0

◆ SetFetchSizeInitial()

dtRtnStatus dbSpaces::dbcli::Navigation::SetFetchSizeInitial ( dtULARGE )

Set the row cache initial fetch size for the navigation connection.