FairCom.CtreeDb.Types

Class OPEN_MODE

java.lang.Object

FairCom.CtreeDb.Types.OPEN_MODE

public class OPEN_MODE
extends java.lang.Object

Open mode used on a CTTable.Open(java.lang.String, int) call

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECKLOCK Tables opened with this mode requires a record lock before a record can be updated.
static int	CHECKREAD Tables opened with this mode requires a record lock as records are read.
static int	CORRUPT This mode opens tables with corrupted indexes or in certain cases, tables with corrupted data.
static int	DATAONLY Open only the data table.
static int	EXCLUSIVE This mode opens the table as exclusive.
static int	NORMAL Use this mode if no other open modes apply.
static int	PERMANENT Many operating systems and/or C compiler run-time libraries limit the number of files that can be opened at one time.
static int	RAW Tables opened with this mode to force the internals to ignore the record definition and load the records as raw buffers.
static int	READONLY Opens the table in OPEN_MODE.READONLY mode and does not allow any modifications to the table structure or data records.
static int	UNLOCKONCLOSE Causes an internal call to ctdbUnlockTable() when the table is closed to remove any lock on the table

Constructor Summary

Constructors

Constructor and Description
OPEN_MODE()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NORMAL

public static final int NORMAL

Use this mode if no other open modes apply.

See Also:

Constant Field Values

EXCLUSIVE

public static final int EXCLUSIVE

This mode opens the table as exclusive. If this mode is used, only one user can open a table. If an application already has the file open in any mode, no other application can open the table as OPEN_MODE.EXCLUSIVE. Once an application opens a table as CTOPEN_EXCLUSIVE, no other application can open it. Reads and writes are cached for index files opened with this file mode since there are no integrity issues with only one process in the file.

See Also:

Constant Field Values

PERMANENT

public static final int PERMANENT

Many operating systems and/or C compiler run-time libraries limit the number of files that can be opened at one time. A permanent file open causes the file to be opened and stay open until the program executes a file close. A non-permanent file open causes the table data and index files to be opened, but allows them to be transparently closed and reopened to allow other data and index files to be used. When it is necessary for a data and index file to be temporarily closed, c-treeACE selects the least recently used file. This file remains closed until it is used, at which time it will be automatically reopened. This strategy causes c-treeACE to use all available file descriptors.

See Also:

Constant Field Values

CORRUPT

public static final int CORRUPT

This mode opens tables with corrupted indexes or in certain cases, tables with corrupted data. With c-treeDB this mode is usually used in conjunction with CTTable.Alter() mode to perform a rebuild if the indexes became corrupted: open table with OPEN_MODE.CORRUPT mode, then call CTTable.Alter() with ALTER_TABLE.INDEX mode to force the rebuild of all indices of the table. If a table table becomes corrupt, the table may be open with OPEN_MODE.CORRUPT mode and then CTTable.Alter() with ALTER_TABEL.FULL is invoked to try to recover the table.

See Also:

Constant Field Values

CHECKLOCK

public static final int CHECKLOCK

Tables opened with this mode requires a record lock before a record can be updated. If a lock is not obtained, the error code CTDBRET.DADV_ERR is returned.

See Also:

Constant Field Values

CHECKREAD

public static final int CHECKREAD

Tables opened with this mode requires a record lock as records are read. Obtain at least a read lock on a record before it can be read, otherwise the function will return error code CTDBRET.DADV_ERR

See Also:

Constant Field Values

READONLY

public static final int READONLY

Opens the table in OPEN_MODE.READONLY mode and does not allow any modifications to the table structure or data records.

See Also:

Constant Field Values

DATAONLY

public static final int DATAONLY

Open only the data table. Used to rebuild a table that may or may not be missing indices.

See Also:

Constant Field Values

UNLOCKONCLOSE

public static final int UNLOCKONCLOSE

Causes an internal call to ctdbUnlockTable() when the table is closed to remove any lock on the table

See Also:

Constant Field Values

RAW

public static final int RAW

Tables opened with this mode to force the internals to ignore the record definition and load the records as raw buffers. This mode forces the read only mode

See Also:

Constant Field Values

Constructor Detail

OPEN_MODE

public OPEN_MODE()