c-treeDB C API Functions

This topic lists the c-treeDB C API broken into functional groupings.

Initialization

The initialization API prepares the environment for c-tree operation and manages transactions.

ctdbAttachSession

ctdbCloseAll

ctdbCloseTable

ctdbConnect

ctdbCreateDatabase

ctdbCreateSession

ctdbDeleteDatabase

ctdbDetachSession

ctdbDisconnect

ctdbDisconnectAll

ctdbDropDatabase

ctdbFindActiveDatabase

ctdbFindActiveDatabaseByUID

ctdbFindDatabase

ctdbFindDatabaseByUID

ctdbFirstDatabase

ctdbFirstResource

ctdbFreeDatabase

ctdbFreeResource

ctdbFreeResultSet

ctdbFreeSession

ctdbGetActiveDatabaseUID

ctdbGetActiveResultSet

ctdbGetAttachMode

ctdbGetDatabaseCount

ctdbGetDatabaseHandle

ctdbGetDatabaseName

ctdbGetDatabasePath

ctdbGetDatabaseUID

ctdbGetHandleType

ctdbGetLastPartition

ctdbGetLockMode

ctdbGetOperationState

ctdbGetTableKSeg

ctdbIsSessionExclusive

ctdbJumpToRecord

ctdbSetSessionExclusive

ctdbSwitchContext

ctdbSwitchInstance

Resources

ctdbAddResource

ctdbAllocResource

ctdbDeleteResource

ctdbFindResource

ctdbFindResourceByName

ctdbFirstResource

ctdbFreeResource

ctdbGetResourceData

ctdbGetResourceDataLength

ctdbGetResourceName

ctdbGetResourceNumber

ctdbGetResourceType

ctdbIsResourceLocked

ctdbNextResource

ctdbSetResourceData

ctdbSetResourceNumber

ctdbSetResourceType

ctdbUnlockResource

ctd

Indexing

ctdbGetCndxIndex

ctdbGetCndxIndexByName

ctdbGetCndxIndexLength

ctdbGetCndxIndexLengthByName

ctdbGetErrorIndex

ctdbGetIdxno

ctdbGetIdxnoByName

ctdbGetIdxnoByNumber

ctdbGetIndexDistinctKeyCountFlag

ctdbGetIndexFileName

ctdbGetIndexKSeg

ctdbGetIndexStatus

ctdbGetRecordKeyPos

ctdbGetSegmentKSeg

ctdbGetTableKSeg

ctdbMoveSegment

ctdbNumberOfKeyEntries

ctdbRecordRangeOff

ctdbRecordRangeOn

ctdbSetIndexCndxExpr

ctdbSetIndexDistinctKeyCountFlag

ctdbSetIndexFileName

ctdbSetIndexKSeg

ctdbSetKSegDefaults

ctdbSetSegmentKSeg

ctdbSetSessionExclusive

ctdbSetTableKSeg

ctdbSetTablePartitionNumberBits

ctdbSetTablePartitionRule

ctdbUpdateCndxIndex

ctdbUpdateCndxIndexByName

Filters

ctdbFilterRecord

ctdbGetFilter

ctdbIsFilteredRecord

ctdbSystemFilterOff

ctdbSystemFilterOn

Full-Text Search / Full-Text Indexing

For information about the functions used for Full-Text Search (FTS) and Full-Text Indexing (FTI), see the Full-Text Search documentation.

Transaction Processing

ctdbAbort

ctdbBegin

ctdbClearSavePoint

ctdbCommit

ctdbGetAutoCommit

ctdbGetKeepLock

ctdbGetRebuildProgress

ctdbGetRecordLock

ctdbGetTransactionMode

ctdbIsLockActive

ctdbIsTransActive

ctdbLock

ctdbLockRecord

ctdbRestoreSavePoint

ctdbSetAutoCommit

ctdbSetKeepLock

ctdbSetSavePoint

ctdbSetTransactionMode

ctdbUnlock

ctdbUnlockRecord

ctdbUnlockTable

Batch Operations

ctdbBatchFiltered

ctdbBatchLoaded

ctdbBatchLocked

ctdbBatchMode

ctdbBatchTotal

ctdbEndBatch

ctdbFindTableXtd

ctdbFirstTableXtd

ctdbGetBatchBufferSize

ctdbInsertBatch

ctdbIsBatchActive

ctdbIsDatabaseExclusive

ctdbIsFieldDefaultValueSet

 

ctdbNextBatch

ctdbNextTableXtd

ctdbReleaseBatchBuffer

ctdbSetBatch

ctdbSetBatchFilter

ctdbSetBatchRangeOff

ctdbSetBatchRangeOn

Partitions

ctdbGetFirstPartition

ctdbGetLastPartition

ctdbPartAdminByKey

ctdbPartAdminByName

ctdbPartAdminByNumber

ctdbSetTablePartitionIndexNbr

ctdbSetTablePartitionNumberBits

ctdbSetTablePartitionRule

Data Definition

ctdbAddDatabase

ctdbAddField

ctdbAddIndex

ctdbAddSegment

ctdbAddJSONSegment

ctdbAddSegmentByName

ctdbAddSegmentByNbr

ctdbAddSegmentEx

ctdbAddTable

ctdbAddTableXtd

ctdbAllocDatabase

ctdbAllocRecord

ctdbAllocSession

ctdbAllocTable

ctdbAlterTable

ctdbAttachTable

ctdbAttachTableXtd

ctdbBlobAlloc

ctdbBlobFree

ctdbCloneTable

ctdbCreateTable

ctdbDeleteTable

ctdbDelField

ctdbDelFieldByName

ctdbDelIndex

ctdbDelSegment

ctdbDelSegmentEx

ctdbDetachTable

ctdbDropTable

ctdbFindActiveTable

ctdbFindActiveTableByUID

ctdbFindTable

ctdbFindTableByUID

ctdbFirstTable

ctdbFreeRecord

ctdbFreeTable

ctdbGetActiveTableByUID

ctdbGetActiveTableUID

ctdbGetDefaultIndex

ctdbGetDefaultIndexName

ctdbGetFieldDefaultValue

ctdbGetFieldName

ctdbGetFieldNbr

ctdbGetFieldNullFlag

ctdbGetFieldNumber

ctdbGetFieldNumberByName

ctdbGetFieldOffset

ctdbGetFieldPrecision

ctdbGetFieldProperties

ctdbGetFieldScale

ctdbGetFieldSize

ctdbGetFieldStatus

ctdbGetFieldType

ctdbGetPadChar

ctdbMergeDatabaseDictionary

ctdbMergeSessionDictionary

ctdbMoveSegment

ctdbOpenTable

ctdbOpenTableByUID

ctdbSetFieldAsUTF16

ctdbSetFieldDefaultDateTimeType

ctdbSetFieldDefaultValue

ctdbSetIdentityField

ctdbSetPadChar

ctdbUpdatePadChar

Data Manipulation

ctdbBuildTargetKey

ctdbDeleteRecord

ctdbDuplicateRecord

ctdbFindRecord

ctdbFindRowid

ctdbFindTarget

ctdbFirstRecord

ctdbGetField

ctdbGetFieldAddress

ctdbGetFieldAsBigint

ctdbGetFieldAsBinary

ctdbGetFieldAsBlob

ctdbGetFieldAsBool

ctdbGetFieldAsCurrency

ctdbGetFieldAsDate

ctdbGetFieldAsDateTime

ctdbGetFieldAsFloat

ctdbGetFieldAsJSON

ctdbGetFieldAsMoney

ctdbGetFieldAsNumber

ctdbGetFieldAsSigned

ctdbGetFieldAsString

ctdbGetFieldAsTime

ctdbGetFieldAsTimeMsec

ctdbGetFieldAsUnsigned

ctdbGetFieldAsUTF16

ctdbGetFieldAutoSysTime

ctdbGetFieldByName

ctdbGetFieldDataLength

ctdbGetFieldHandle

ctdbGetFieldLength

ctdbGetLastIdentity

ctdbGetRowid

ctdbJumpToRecord

ctdbLastRecord

ctdbNextRecord

ctdbPrevRecord

ctdbReadRecord

ctdbRecordAtPercentile

ctdbRecordSetOff

ctdbRecordSetOn

ctdbRemoveTable

ctdbRenameTable

ctdbSeekRecord

ctdbWriteRecord

Data Types

ctdb_u16TOu8

ctdb_u8TOu16

ctdbBigIntToCurrency

ctdbBigIntToFloat

ctdbBigIntToLong

ctdbBigIntToNumber

ctdbBigIntToString

ctdbBlobClear

ctdbBlobCmp

ctdbBlobGetData

ctdbBlobGetSize

ctdbBlobSet

ctdbCurrencyAbs

ctdbCurrencyAdd

ctdbCurrencyCmp

ctdbCurrencyDiv

ctdbCurrencyMul

ctdbCurrencyRound

ctdbCurrencySub

ctdbCurrencyToBigInt

ctdbCurrencyToFloat

ctdbCurrencyToLong

ctdbCurrencyToMoney

ctdbCurrencyToNumber

ctdbCurrencyToString

ctdbDateCheck

ctdbDatePack

ctdbDateTimeGetDate

ctdbDateTimeGetTime

ctdbDateTimeGetTimeMsec

ctdbDateTimePack

ctdbDateTimePackMsec

ctdbDateTimeSetDate

ctdbDateTimeSetTime

ctdbDateTimeSetTimeMsec

ctdbDateTimeToString

ctdbDateTimeToTDateTime

ctdbDateTimeToUnixTime

ctdbDateTimeUnpack

ctdbDateTimeUnpackMsec

ctdbDateToString

ctdbDateUnpack

ctdbDayOfWeek

ctdbFloatToBigInt

ctdbFloatToCurrency

ctdbFloatToMoney

ctdbFloatToNumber

ctdbGetDay

ctdbGetDefDateType

ctdbGetDefFloatFormat

ctdbGetDefTimeType

ctdbGetFieldAsUTF16

ctdbGetFieldDefaultDateType

ctdbGetFieldDefaultTimeType

ctdbGetHour

ctdbGetMinute

ctdbGetMonth

ctdbGetSecond

ctdbGetYear

ctdbIsLeapYear

ctdbIsNumberZero

ctdbLongToBigInt

ctdbLongToCurrency

ctdbLongToMoney

ctdbLongToNumber

ctdbMoneyAbs

ctdbMoneyAdd

ctdbMoneyCmp

ctdbMoneyDiv

ctdbMoneyMul

ctdbMoneySub

ctdbMoneyToCurrency

ctdbMoneyToFloat

ctdbMoneyToLong

ctdbMoneyToNumber

ctdbMoneyToString

ctdbNumberAbs

ctdbNumberAdd

ctdbNumberCmp

ctdbNumberCopy

ctdbNumberDiv

ctdbNumberGetDecimal

ctdbNumberMul

ctdbNumberNegate

ctdbNumberRound

ctdbNumberSub

ctdbNumberToBigInt

ctdbNumberToCurrency

ctdbNumberToFloat

ctdbNumberToLong

ctdbNumberToMoney

ctdbNumberToString

ctdbNumberZero

ctdbSetDefDateType

ctdbSetDefFloatFormat

ctdbSetDefTimeType

ctdbStringToBigInt

ctdbStringToCurrency

ctdbStringToDate

ctdbStringToDateTime

ctdbStringToMoney

ctdbStringToNumber

ctdbStringToTDateTime

ctdbStringToTime

ctdbStringToTimeMsec

ctdbStringToUnixTime

ctdbTimePack

ctdbTimePackMsec

ctdbTimeToString

ctdbTimeUnpack

ctdbTimeUnpackMsec


Data Structures

ctdbGetFirstActiveDatabase

ctdbGetFirstActiveTable

ctdbGetHandleType

ctdbGetIdentityFieldDetails

ctdbGetIndex

ctdbGetIndexByName

ctdbGetIndexByUID

ctdbGetIndexDuplicateFlag

ctdbGetIndexEmptyChar

ctdbGetIndexExtension

ctdbGetIndexHandle

ctdbGetIndexKeyLength

ctdbGetIndexKeyType

ctdbGetIndexName

ctdbGetIndexNbr

ctdbGetIndexNbrByName

ctdbGetIndexNullFlag

ctdbGetIndexSegmentCount

ctdbGetIndexTemporaryFlag

ctdbGetIndexUID

ctdbGetLibType

ctdbGetLocalTag

ctdbGetLogonOnly

ctdbGetNextActiveDatabase

ctdbGetNextActiveTable

ctdbGetRecord

ctdbGetRecordBuffer

ctdbGetRecordCount

ctdbGetRecordHandle

ctdbGetRecordLength

ctdbGetRecordNbr

ctdbGetRecordPos

ctdbGetRecordSize

ctdbGetRowid

ctdbGetSegment

ctdbGetSegmentField

ctdbGetSegmentFieldName

ctdbGetSegmentHandle

ctdbGetSegmentMode

ctdbGetSegmentNbr

ctdbGetSegmentPartialField

ctdbGetSegmentStatus

ctdbGetServerName

ctdbGetSessionHandle

ctdbGetSessionParams

ctdbGetSessionPath

ctdbGetSessionType

ctdbGetTable

ctdbGetTableCount

ctdbGetTableCreateMode

ctdbGetTableDefaultDataExtentSize

ctdbGetTableDefaultIndexExtentSize

ctdbGetTableExtension

ctdbGetTableFieldCount

ctdbGetTableGroupid

ctdbGetTableHandle

ctdbGetTableIndexCount

ctdbGetTableName

ctdbGetTableNbr

ctdbGetTableOpenMode

ctdbGetTableOwner

ctdbGetTablePassword

ctdbGetTablePath

ctdbGetTablePermission

ctdbGetTableStatus

ctdbGetTableUID

ctdbGetUserLogonName

ctdbGetUserTag

ctdbHasDelField

ctdbHasNullFieldSupport

ctdbHasRecbyt

ctdbHasRowid

ctdbInsField

ctdbInsFieldByName

ctdbInsSegment

ctdbInsSegmentByName

ctdbInsSegmentByNbr

ctdbInsSegmentEx

ctdbIsActiveDatabase

ctdbIsActiveSession

ctdbIsActiveTable

ctdbIsDatabaseExclusive

ctdbIsEditedRecord

ctdbIsExtSegment

ctdbIsFieldDefaultValueSet

ctdbIsFieldNumeric

ctdbIsNewRecord

ctdbIsNullField

ctdbIsRecordRangeOn

ctdbIsRecordSetOn

ctdbIsVariableField

ctdbLogon

ctdbLogout

ctdbMoveField

ctdbNextDatabase

ctdbNextTable

ctdbSetDefaultIndex

ctdbSetDefaultIndexByName

ctdbSetEditedRecord

ctdbSetFieldAsBigint

ctdbSetFieldAsBinary

ctdbSetFieldAsBlob

ctdbSetFieldAsBool

ctdbSetFieldAsCurrency

ctdbSetFieldAsDate

ctdbSetFieldAsDateTime

ctdbSetFieldAsFloat

ctdbSetFieldAsJSON

ctdbSetFieldAsMoney

ctdbSetFieldAsNumber

ctdbSetFieldAsSigned

ctdbSetFieldAsString

ctdbSetFieldAsTime

ctdbSetFieldAsTimeMsec

ctdbSetFieldAsUnsigned

ctdbSetFieldAsUTF16

ctdbSetFieldAutoSysTime

ctdbSetFieldLength

ctdbSetFieldName

ctdbSetFieldNullFlag

ctdbSetFieldPrecision

ctdbSetFieldProperties

ctdbSetFieldScale

ctdbSetFieldStringEncoding

ctdbSetFieldType

ctdbSetIndexDuplicateFlag

ctdbSetIndexEmptyChar

ctdbSetIndexExtension

ctdbSetIndexKeyType

ctdbSetIndexName

ctdbSetIndexNullFlag

ctdbSetIndexTemporaryFlag

ctdbSetJSONSegmentField

ctdbSetLocalTag

ctdbSetLogonOnly

ctdbSetNewRecord

ctdbSetOperationState

ctdbSetPathPrefix

ctdbSetRecordBuffer

ctdbSetRecordOffset

ctdbSetRecordPos

ctdbSetResourceData

ctdbSetResourceName

ctdbSetResourceNumber

ctdbSetResourceType

ctdbSetSegmentMode

ctdbSetSessionParams

ctdbSetSessionPath

ctdbSetSessionType

ctdbSetSingleSavePoint (missing)

ctdbSetTableDefaultDataExtentSize

ctdbSetTableDefaultIndexExtentSize

ctdbSetTableExtension

ctdbSetTableGroupid

ctdbSetTableOwner

ctdbSetTablePassword

ctdbSetTablePath

ctdbSetTablePermission

ctdbSetUserTag

ctdbUpdateCreateMode

Callback

ctdbClearAllCallback

ctdbClearCallback

ctdbGetCallback

ctdbSetCallback

Result Sets

ctdbAddCriteria

ctdbAllocateResultSet

ctdbFreeResultSet

ctdbGetActiveResultSet

ctdbGetResultSetByName

ctdbGetResultSetCriHandle

ctdbGetResultSetHandle

ctdbRemoveCriteria

Utility

ctdbBeginImpersonation

ctdbClearAllFieldDefaultValue

ctdbClearError

ctdbClearField

ctdbClearFieldDefaultValue

ctdbClearRecord

ctdbCurrentDate

ctdbCurrentDateTime

ctdbCurrentDateTimeUTC

ctdbCurrentTime

ctdbEndImpersonation

ctdbEstimateSpan

ctdbGetCtreeOWNER

ctdbGetDatno

ctdbGetError

ctdbGetErrorIndex

ctdbGetOperationState

ctdbGetPathPrefix

ctdbGetProductVersion

ctdbGetSystemConfig

ctdbRebuildTable

ctdbResetAll

ctdbResetRecord

ctdbServerDateTime

ctdbSetCallback

ctdbSetConfigurationFile

ctdbSetCtreeOWNER

ctdbSetCurrentNodeName

ctdbSetDatabaseExclusive

ctdbSetDefaultSqlTableOwner

ctdbSetError

ctdbSetExtensionHint

ctdbStartDatabaseEngine

ctdbStopDatabaseEngine

ctdbTimeCheck