C API Functions H

ctdbHasDelField

Tests for the presence of the internal delete flag.

Declaration

CTBOOL ctdbDECL ctdbHasDelField(CTHANDLE Handle);

Description

ctdbHasDelField() tests for the presence of the internal delete flag, $DELFLD$, field in a table. $DELFLD$ is a hidden field that FairCom DB API automatically creates as the first field in the record buffer. $DELFLD$ is defined as a 4-byte CT_ARRAY field (to ensure proper alignment of subsequent fields) and its only purpose is to keep a place at the beginning of the record to hold the c-tree delete record flag byte when a record is deleted. This field is handled internally by FairCom DB API and should never be modified by the user.

ctdbHasDelField() receives a table handle as parameter and returns YES if the table was created with a $DELFLD$ field. ctdbHasDelField() returns NO if the table was not created with a $DELFLD$ field.

Return

Symbolic Constant

Explanation

YES

$DELFLD$ in table.

NO

$DELFLD$ not in table.

ctdbHasNullFieldSupport

Indicate if a table has Null field support.

Declaration

CTBOOL ctdbHasNullFieldSupport(CTHANDLE Handle)

Description

ctdbHasNullFieldSupport() indicates if a table has Null field support.

  • Handle [in] the Table Handle.

Returns

ctdbHasNullFieldSupport() returns YES if the table has NULL field support, NO otherwise.

See also

ctdbIsNullField()

ctdbHasRecbyt

Indicate if the table has support for recbyt index.

Declaration

CTBOOL ctdbHasRecbyt(CTHANDLE Handle)

Description

ctdbHasRecbyt() indicates if the table has support for RECBYT index. This support is enabled by default when the table is created. If a table has support to a RECBYT index, the record position or offset may be retrieved with ctdbGetRecordPos().

  • Handle [in] the Table Handle.

Returns

ctdbHasRecbyt() returns yes if the function has support, and no otherwise.

See also

ctdbAllocTable(), ctdbGetRecordPos(), ctdbCreateTable()

ctdbHasRowid

Indicate if the table has support for rowid index.

Declaration

CTBOOL ctdbHasRowid(CTHANDLE Handle)

Description

ctdbHasRowid() indicates if the table has support for a ROWID index. By default, all tables created by FairCom DB API have support for ROWID. To create a table without support for ROWID, use the create mode CTCREATE_NOROWID in ctdbCreateTable().

ROWID holds the auto-increment value generated automatically by c-tree every time a new record is added to the table. This is a read-only field.

  • Handle [in] the Table Handle.

Returns

ctdbHasRowid() returns yes if the function has support, and no otherwise.

See also

ctdbAllocTable(), ctdbFindRowid(), ctdbGetRowid(), ctdbCreateTable(), ctdbHasRecbyt()