FairCom DB API for C

Function Descriptions

This section describes each of the FairCom DB API functions.

In This Section ctdb_u16TOu8 ctdb_u8TOu16 ctdbAbort ctdbAddCriteria ctdbAddDatabase ctdbAddField ctdbAddFTI ctdbAddFTIField ctdbAddFTIFieldByName ctdbAddIndex ctdbAddJSONSegment ctdbAddResource ctdbAddRowIdSegment ctdbAddSegment ctdbAddSegmentByName ctdbAddSegmentByNbr ctdbAddSegmentEx ctdbAddTable ctdbAddTableXtd ctdbAddToFieldMask ctdbAllocateResultSet ctdbAllocDatabase ctdbAllocFTI ctdbAllocRecord ctdbAllocResource ctdbAllocSession ctdbAllocTable ctdbAlterTable ctdbAttachSession ctdbAttachTable ctdbAttachTableXtd ctdbBatchFiltered ctdbBatchLoaded ctdbBatchLocked ctdbBatchMode ctdbBatchTotal ctdbBegin ctdbBeginImpersonation ctdbBigIntToCurrency ctdbBigIntToFloat ctdbBigIntToLong ctdbBigIntToNumber ctdbBigIntToString ctdbBlobAlloc ctdbBlobClear ctdbBlobCmp ctdbBlobFree ctdbBlobGetData ctdbBlobGetSize ctdbBlobSet ctdbBuildTargetKey ctdbCheckFTIBackgroundLoad ctdbCheckIndexBackgroundLoad ctdbClearAllCallback ctdbClearAllFieldDefaultValue ctdbClearCallback ctdbClearError ctdbClearField ctdbClearFieldDefaultValue ctdbClearRecord ctdbClearSavePoint ctdbCloneTable ctdbCloseAll ctdbCloseTable ctdbCommit ctdbConnect ctdbCreateDatabase ctdbCreateSession ctdbCreateTable ctdbCurrencyAbs ctdbCurrencyAdd ctdbCurrencyCmp ctdbCurrencyDiv ctdbCurrencyMul ctdbCurrencyRound ctdbCurrencySub ctdbCurrencyToBigInt ctdbCurrencyToFloat ctdbCurrencyToLong ctdbCurrencyToMoney ctdbCurrencyToNumber ctdbCurrencyToString ctdbCurrentDate ctdbCurrentDateTime ctdbCurrentDateTimeUTC ctdbCurrentTime ctdbCurrentTimestamp ctdbDateCheck ctdbDatePack ctdbDateTimeGetDate ctdbDateTimeGetTime ctdbDateTimeGetTimeMsec ctdbDateTimePack ctdbDateTimePackMsec ctdbDateTimeSetDate ctdbDateTimeSetTime ctdbDateTimeSetTimeMsec ctdbDateTimeToString ctdbDateTimeToTDateTime ctdbDateTimeToUnixTime ctdbDateTimeUnpack ctdbDateTimeUnpackMsec ctdbDateToString ctdbDateUnpack ctdbDayOfWeek ctdbDeleteDatabase ctdbDeleteRecord ctdbDeleteResource ctdbDeleteTable ctdbDelField ctdbDelFieldByName ctdbDelFTI ctdbDelIndex ctdbDelSegment ctdbDelSegmentEx ctdbDetachSession ctdbDetachTable ctdbDisconnect ctdbDisconnectAll ctdbDropDatabase ctdbDropTable ctdbDuplicateRecord ctdbEndBatch ctdbEndImpersonation ctdbEstimateSpan ctdbFilterRecord ctdbFindActiveDatabase ctdbFindActiveDatabaseByUID ctdbFindActiveTable ctdbFindActiveTableByUID ctdbFindDatabase ctdbFindDatabaseByUID ctdbFindRecord ctdbFindResource ctdbFindResourceByName ctdbFindRowid ctdbFindTable ctdbFindTableXtd ctdbFindTableByUID ctdbFindTableDictionaryMark ctdbFindTarget ctdbFirstDatabase ctdbFirstRecord ctdbFirstResource ctdbFirstTable ctdbFirstTableXtd ctdbFloatToBigInt ctdbFloatToCurrency ctdbFloatToMoney ctdbFloatToNumber ctdbFreeDatabase ctdbFreeFTI ctdbFreeRecord ctdbFreeResource ctdbFreeResultSet ctdbFreeSession ctdbFreeTable ctdbFTSearchOff ctdbFTSearchOn ctdbGetActiveDatabaseUID ctdbGetActiveResultSet ctdbGetActiveTableByUID ctdbGetActiveTableUID ctdbGetAttachMode ctdbGetAutoCommit ctdbGetBatchBufferSize ctdbGetBinaryFlag ctdbGetCallback ctdbGetCndxIndex ctdbGetCndxIndexByName ctdbGetCndxIndexLength ctdbGetCndxIndexLengthByName ctdbGetCtreeOWNER ctdbGetDatabaseCount ctdbGetDatabaseHandle ctdbGetDatabaseName ctdbGetDatabasePath ctdbGetDatabaseUID ctdbGetDatno ctdbGetDay ctdbGetDefaultIndex ctdbGetDefaultIndexName ctdbGetDefDateType ctdbGetDefFloatFormat ctdbGetDefTimeType ctdbGetError ctdbGetErrorIndex ctdbGetField ctdbGetFieldAddress ctdbGetFieldAsBigint ctdbGetFieldAsBinary ctdbGetFieldAsBlob ctdbGetFieldAsBool ctdbGetFieldAsCurrency ctdbGetFieldAsDate ctdbGetFieldAsDateTime ctdbGetFieldAsFloat ctdbGetFieldAsJSON ctdbGetFieldAsMoney ctdbGetFieldAsNumber ctdbGetFieldAsSigned ctdbGetFieldAsString ctdbGetFieldAsTime ctdbGetFieldAsTimeMsec ctdbGetFieldAsUnsigned ctdbGetFieldAsUTF16 ctdbGetFieldAutoSysTime ctdbGetFieldByName ctdbGetFieldDataLength ctdbGetFieldDefaultDateType ctdbGetFieldDefaultTimeType ctdbGetFieldDefaultValue ctdbGetFieldHandle ctdbGetFieldLength ctdbGetFieldName ctdbGetFieldNbr ctdbGetFieldNullFlag ctdbGetFieldNumber ctdbGetFieldNumberByName ctdbGetFieldOffset ctdbGetFieldPrecision ctdbGetFieldProperties ctdbGetFieldScale ctdbGetFieldSize ctdbGetFieldStatus ctdbGetFieldStringEncoding ctdbGetFieldType ctdbGetFilter ctdbGetFirstActiveDatabase ctdbGetFirstActiveTable ctdbGetFirstPartition ctdbGetFTI ctdbGetFTIByName ctdbGetFTIByUID ctdbGetFTIField ctdbGetFTIFieldCount ctdbGetFTIFieldMode ctdbGetFTIHandle ctdbGetFTIName ctdbGetFTINbr ctdbGetFTINbrByName ctdbGetFTIStatus ctdbGetHandleType ctdbGetHour ctdbGetIdentityFieldDetails ctdbGetIdxno ctdbGetIdxnoByName ctdbGetIdxnoByNumber ctdbGetIndex ctdbGetIndexByName ctdbGetIndexByUID ctdbGetIndexCndxExpr ctdbGetIndexDistinctKeyCountFlag ctdbGetIndexDuplicateFlag ctdbGetIndexEmptyChar ctdbGetIndexExtension ctdbGetIndexFilename ctdbGetIndexHandle ctdbGetIndexKeyLength ctdbGetIndexKeyType ctdbGetIndexKSeg ctdbGetIndexName ctdbGetIndexNbr ctdbGetIndexNbrByName ctdbGetIndexNullFlag ctdbGetIndexSegmentCount ctdbGetIndexStatus ctdbGetIndexTemporaryFlag ctdbGetIndexUID ctdbGetKeepLock ctdbGetLastIdentity ctdbGetLastPartition ctdbGetLibType ctdbGetLocalTag ctdbGetLockMode ctdbGetLogonOnly ctdbGetMinute ctdbGetMonth ctdbGetNextActiveDatabase ctdbGetNextActiveTable ctdbGetOperationState ctdbGetPadChar ctdbGetPathPrefix ctdbGetProductVersion ctdbGetRebuildProgress ctdbGetRecord ctdbGetRecordBuffer ctdbGetRecordCount ctdbGetRecordHandle ctdbGetRecordKeyPos ctdbGetRecordLength ctdbGetRecordLock ctdbGetRecordNbr ctdbGetRecordPos ctdbGetRecordSize ctdbGetResourceData ctdbGetResourceDataLength ctdbGetResourceName ctdbGetResourceNumber ctdbGetResourceType ctdbGetResultSetByName ctdbGetResultSetCriHandle ctdbGetResultSetHandle ctdbGetRowid ctdbGetSecond ctdbGetSegment ctdbGetSegmentField ctdbGetSegmentFieldName ctdbGetSegmentHandle ctdbGetSegmentKSeg ctdbGetSegmentLength ctdbGetSegmentMode ctdbGetSegmentNbr ctdbGetSegmentPartialField ctdbGetSegmentStatus ctdbGetServerName ctdbGetSessionHandle ctdbGetSessionParams ctdbGetSessionPath ctdbGetSessionType ctdbGetSystemConfig ctdbGetTable ctdbGetTableCount ctdbGetTableCreateMode ctdbGetTableDefaultDataExtentSize ctdbGetTableDefaultIndexExtentSize ctdbGetTableExtension ctdbGetTableFieldCount ctdbGetTableFirstDataExtentSize ctdbGetTableFirstIndexExtentSize ctdbGetTableFTICount ctdbGetTableGroupid ctdbGetTableHandle ctdbGetTableHotAlterCallbackLib ctdbGetTableIndexCount ctdbGetTableKSeg ctdbGetTableName ctdbGetTableNbr ctdbGetTableOpenMode ctdbGetTableOwner ctdbGetTablePassword ctdbGetTablePath ctdbGetTablePermission ctdbGetTableStatus ctdbGetTableUID ctdbGetTransactionMode ctdbGetUserLogonName ctdbGetUserTag ctdbGetYear ctdbHasDelField ctdbHasNullFieldSupport ctdbHasRecbyt ctdbHasRowid ctdbInsertBatch ctdbInsField ctdbInsFieldByName ctdbInsSegment ctdbInsSegmentByName ctdbInsSegmentByNbr ctdbInsSegmentEx ctdbIsActiveDatabase ctdbIsActiveSession ctdbIsActiveTable ctdbIsBatchActive ctdbIsDatabaseExclusive ctdbIsEditedRecord ctdbIsExtSegment ctdbIsFieldDefaultValueSet ctdbIsFieldMaskOn ctdbIsFieldNumeric ctdbIsFilteredRecord ctdbIsFTSearchOn ctdbIsLeapYear ctdbIsLockActive ctdbIsNewRecord ctdbIsNullField ctdbIsNumberZero ctdbIsRecordRangeOn ctdbIsRecordSetOn ctdbIsResourceLocked ctdbIsSessionExclusive ctdbIsTransActive ctdbIsVariableField ctdbJumpToRecord ctdbLastRecord ctdbLock ctdbLockRecord ctdbLogon ctdbLogout ctdbLongToBigInt ctdbLongToCurrency ctdbLongToMoney ctdbLongToNumber ctdbMergeDatabaseDictionary ctdbMergeSessionDictionary ctdbMoneyAbs ctdbMoneyAdd ctdbMoneyCmp ctdbMoneyDiv ctdbMoneyMul ctdbMoneySub ctdbMoneyToCurrency ctdbMoneyToFloat ctdbMoneyToLong ctdbMoneyToNumber ctdbMoneyToString ctdbMoveField ctdbMoveSegment ctdbMoveTable ctdbNextBatch ctdbNextDatabase ctdbNextRecord ctdbNextResource ctdbNextTable ctdbNextTableXtd ctdbNumberAbs ctdbNumberAdd ctdbNumberCmp ctdbNumberCopy ctdbNumberDiv ctdbNumberGetDecimal ctdbNumberMul ctdbNumberNegate ctdbNumberOfKeyEntries ctdbNumberRound ctdbNumberSub ctdbNumberToBigInt ctdbNumberToCurrency ctdbNumberToFloat ctdbNumberToLong ctdbNumberToMoney ctdbNumberToString ctdbNumberZero ctdbOpenTable ctdbOpenTableByUID ctdbPartAdminByKey ctdbPartAdminByName ctdbPartAdminByNumber ctdbPrevRecord ctdbReadRecord ctdbRebuildTable ctdbRecordAtPercentile ctdbRecordRangeOff ctdbRecordRangeOn ctdbRecordSetOff ctdbRecordSetOn ctdbReleaseBatchBuffer ctdbRemoveCriteria ctdbRemoveFieldMask ctdbRemoveTable ctdbRenameTable ctdbResetAll ctdbResetRecord ctdbRestoreSavePoint ctdbResultSetOnOff ctdbSeekRecord ctdbServerDateTime ctdbSetAutoCommit ctdbSetBatch ctdbSetBatchFilter ctdbSetBatchRangeOff ctdbSetBatchRangeOn ctdbSetBinaryFlag ctdbSetCallback ctdbSetConfigurationFile ctdbSetCtreeOWNER ctdbSetCurrentNodeName ctdbSetDatabaseExclusive ctdbSetDatabaseTableMarkFilter ctdbSetDefaultFTI ctdbSetDefaultIndex ctdbSetDefaultIndexByName ctdbSetDefaultSqlTableOwner ctdbSetDefDateType ctdbSetDefFloatFormat ctdbSetDefTimeType ctdbSetDictInSuperfile ctdbSetEditedRecord ctdbSetError ctdbSetExtensionHint ctdbSetFieldAsBigint ctdbSetFieldAsBinary ctdbSetFieldAsBlob ctdbSetFieldAsBool ctdbSetFieldAsCurrency ctdbSetFieldAsDate ctdbSetFieldAsDateTime ctdbSetFieldAsFloat ctdbSetFieldAsJSON ctdbSetFieldAsMoney ctdbSetFieldAsNumber ctdbSetFieldAsSigned ctdbSetFieldAsString ctdbSetFieldAsTime ctdbSetFieldAsTimeMsec ctdbSetFieldAsUnsigned ctdbSetFieldAsUTF16 ctdbSetFieldAutoSysTime ctdbSetFieldBinaryFlag ctdbSetFieldCallback ctdbSetFieldDefaultDateTimeType ctdbSetFieldDefaultValue ctdbSetFieldDefaultValueAsBinary ctdbSetFieldHotAlterCallbackFunction ctdbSetFieldLength ctdbSetFieldName ctdbSetFieldNullFlag ctdbSetFieldPrecision ctdbSetFieldProperties ctdbSetFieldScale ctdbSetFieldStringEncoding ctdbSetFieldType ctdbSetFTICndxExpr ctdbSetFTIOption ctdbSetIdentityField ctdbSetIndexCndxExpr ctdbSetIndexDistinctKeyCountFlag ctdbSetIndexDuplicateFlag ctdbSetIndexEmptyChar ctdbSetIndexExtension ctdbSetIndexFilename ctdbSetIndexKeyType ctdbSetIndexKSeg ctdbSetIndexName ctdbSetIndexNullFlag ctdbSetIndexTemporaryFlag ctdbSetJSONSegmentField ctdbSetKeepLock ctdbSetKSegDefaults ctdbSetLocalTag ctdbSetLogonOnly ctdbSetLogPath ctdbSetNewRecord ctdbSetOperationState ctdbSetPadChar ctdbSetPathPrefix ctdbSetRecordBuffer ctdbSetRecordOffset ctdbSetRecordPos ctdbSetResourceData ctdbSetResourceName ctdbSetResourceNumber ctdbSetResourceType ctdbSetSavePoint ctdbSetSegmentField ctdbSetSegmentKSeg ctdbSetSegmentMode ctdbSetSessionExclusive ctdbSetSessionParams ctdbSetSessionPath ctdbSetSessionType ctdbSetSavePoint ctdbSetStatusLogPath ctdbSetTableDefaultDataExtentSize ctdbSetTableDefaultIndexExtentSize ctdbSetTableDictionaryMark ctdbSetTableExtension ctdbSetTableFirstDataExtentSize ctdbSetTableFirstIndexExtentSize ctdbSetTableGroupid ctdbSetTableHotAlterCallbackLib ctdbSetTableKSeg ctdbSetTableOwner ctdbSetTablePartitionBase ctdbSetTablePartitionIndexNbr ctdbSetTablePartitionMaximumActive ctdbSetTablePartitionNumberBits ctdbSetTablePartitionRule ctdbSetTablePassword ctdbSetTablePath ctdbSetTablePermission ctdbSetTempPath ctdbSetTransactionMode ctdbSetUserTag ctdbStartDatabaseEngine ctdbStartFTIBackgroundLoad ctdbStopDatabaseEngine ctdbStringToBigInt ctdbStringToCurrency ctdbStringToDate ctdbStringToDateTime ctdbStringToMoney ctdbStringToNumber ctdbStringToTDateTime ctdbStringToTime ctdbStringToTimeMsec ctdbStringToUnixTime ctdbSwitchContext ctdbSwitchInstance ctdbSystemFilterOff ctdbSystemFilterOn ctdbTableHasCallback ctdbTableHasLocks ctdbTDateTimeGetDate ctdbTDateTimeGetTime ctdbTDateTimeGetTimeMsec ctdbTDateTimeToDateTime ctdbTDateTimeToString ctdbTimeCheck ctdbTimeMsecToString ctdbTimePack ctdbTimePackMsec ctdbTimeToString ctdbTimeUnpack ctdbTimeUnpackMsec ctdbTruncateTable ctdbUnixTimeGetDate ctdbUnixTimeGetTime ctdbUnixTimeToDateTime ctdbUnixTimeToString ctdbUnlock ctdbUnlockRecord ctdbUnlockResource ctdbUnlockTable ctdbUpdateCndxIndex ctdbUpdateCndxIndexByName ctdbUpdateCreateMode ctdbUpdateCriteria ctdbUpdatePadChar ctdbUpdateResource ctdbWriteRecord