Inherits com.dbSpaces.jdb.Base.

Public Member Functions
NavigationTable	createTable () throws DatabaseException

int	getBatchUpdateSize ()

int	getIncrementalFetchSize ()

int	getInitialFetchSize ()

int	getMaxFetchSize ()

boolean	isCachingEnabled ()

boolean	isRowBindingEnabled ()

boolean	isUpdatableCachingEnabled ()

dtRtnStatus	setFetchSizeIncremental (int size)

dtRtnStatus	setFetchSizeInitial (int size)

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 navagational 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

Member Function Documentation

◆ createTable()

NavigationTable com.dbSpaces.jdb.Navigation.createTable ( ) throws DatabaseException

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()

int com.dbSpaces.jdb.Navigation.getBatchUpdateSize ( )

Get the batch update cache size.

Returns: The batch update size.

Since: Version 1.0

◆ getIncrementalFetchSize()

int com.dbSpaces.jdb.Navigation.getIncrementalFetchSize ( )

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

Returns: The incremental fetch size.

Since: Version 1.0

◆ getInitialFetchSize()

int com.dbSpaces.jdb.Navigation.getInitialFetchSize ( )

Get the initial fetch size for retrieving rows from the database.

Returns: The initial fetch size.

Since: Version 1.0

◆ getMaxFetchSize()

int com.dbSpaces.jdb.Navigation.getMaxFetchSize ( )

Get the maximum fetch size for retrieving rows from the database.

Returns: The maximum fetch size.

Since: Version 1.0

◆ isCachingEnabled()

boolean com.dbSpaces.jdb.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()

boolean com.dbSpaces.jdb.Navigation.isRowBindingEnabled ( )

Is row binding enabled.

Returns: true if is enabled; false if otherwise.

Since: Version 1.0

◆ isUpdatableCachingEnabled()

boolean com.dbSpaces.jdb.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 com.dbSpaces.jdb.Navigation.setFetchSizeIncremental ( int size )

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

Parameters

size	The incremental fetch size.

Returns: dtRtnStatus.RTN_STATUS_SUCCESS or dtRtnStatus.RTN_STATUS_ERROR.

Since: Version 1.0

◆ setFetchSizeInitial()

dtRtnStatus com.dbSpaces.jdb.Navigation.setFetchSizeInitial ( int size )

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