FairCom DB API API for C++ - Developers Guide

CTDB API for C++ - Developers Guide Overview Layout of this Documentation Quick Tour Programming with FairCom DB API Common Functionality Error Handling Transaction Processing Session-Wide Locking Default Date, Time and Float formats User Defined Tags Working with Sessions Creating a Session Object Creating a New Session Dictionary Session Logon and Logout Session Properties Server and User Name Properties Active Property Path Property Managing Databases Creating a new Database Adding an existing Database Dropping a Database Deleting a Database First Database Next Database Find Database First Active Database Next Active Database Find Active Database Database UID (Unique IDentifier) Find Database by UID Find active Database by UID Working with Sessions without Dictionary Support Attach and Detach Existing Sessions Session Dictionary Working with Databases Creating a Database object Connecting to a database Database properties Database name Database path Table count Managing Tables Adding an existing table Adding an existing table under transaction control Dropping a table Dropping a table under transaction control Deleting a table Deleting a table under transaction control First Table Next Table Find Table First Active Table Next Active Table Find Active Table Table UID (Unique IDentifier) Find Table by UID Find active Table by UID Database Dictionary Working with Tables Creating a Table object Creating a table object without database support Creating a New Table Adding, inserting or deleting fields Fixed or variable length records Hidden fields Adding or deleting indexes Segment Modes ROWID index RECBYT index Changing default properties Creating the table Creating a table under transaction control Opening a table Opening a table with password Closing a table Altering a table Add, insert, delete, or edit fields Add, edit or delete indexes Alter the table Default Values Adding an index to a table Deleting an index from a table Forcing an index rebuild Forcing a table rebuild Attach and Detach Open Tables Table Properties Table name Table Path Table file extension Index file extension Data file extent size Index file extent size Table password Table group ID Table permission mask Number of fields Number of indexes Field padding Update create mode Working with Records Creating a record object Record buffer layout Sharing the same context Resetting a record The default index Selecting the RECBYT index Selecting the ROWID index Navigating records First record Last record Next record Previous record Seek to record Finding records Find Modes Building a target key Finding records by target key Finding records by ROWID Record Sets Creating a record set Terminating a record set Record Filters FairCom DB Expression Parser and Grammar Constants Variables Parentheses Predefined Functions Type Casting Automatic Type Promotion Operators Custom Application Expressions Parsing Expressions Evaluating Expressions Variable-length Records with Conditional Expressions Conditional Expression Callback Function Record Batches Batches with FairCom DB API Batch Modes Starting a new batch operation Retrieving records by partial key Retrieving records by index range Retrieving records by physical order Deleting a group of records Inserting a group of records Retrieving records Terminating a batch operation Retrieving batch properties Reading and writing field data to a record buffer Automatic data type conversion Null field support Field defined size Field actual length Field address in record buffer Field offset in record buffer Check if field is fixed or variable length Using field names Clearing the record buffer Clearing a field Adding new records Updating existing records Deleting records Record properties New record flag Edited record flag Record offset Record count Record ROWID Record Locking Check if a record is locked Demoting record locks Data Types Scalar Types Date Types Time Types Date/Time (Timestamp) Types Numeric Types CTBIGINT CTMONEY CTCURRENCY CTNUMBER Data Integrity Transactions Atomicity Automatic Recovery Creating tables for transaction processing Starting a transaction Terminating a transaction Save Points Locking Starting locks Lock modes Freeing locks Freeing locks associated with a table Working with Resources Types of Resources Resource Identification Resource Type Resource Number Resource Name FairCom DB API C++ API - Working with Resources Constructing Resource Objects Adding New Resources Deleting Resources Updating Existing Resources Reading Resources Get and Set Resource Properties with the FairCom DB API C++ API Resource Locks Working with Callbacks Callback Function Type Callback Return Codes Callback Handle Parameters Sessions Databases Tables Records Callback Types CTDB_ON_SESSION_LOGON CTDB_ON_ SESSION_LOGOUT CTDB_ON_DATABASE_CONNECT CTDB_ON_DATABASE_DISCONNECT CTDB_ON_TABLE_OPEN CTDB_ON_TABLE_CLOSE CTDB_ON_TABLE_GET_SCHEMA CTDB_ON_TABLE_GET_DODA CTDB_ON_TABLE_GET_RECLEN CTDB_ON_TABLE_GET_EXT_INFO CTDB_ON_TABLE_GET_VTABLE_INFO CTDB_ON_TABLE_ALTER CTDB_ON_TABLE_REBUILD CTDB_ON_RECORD_INIT CTDB_ON_RECORD_RESET CTDB_ON_RECORD_BEFORE_READ CTDB_ON_RECORD_AFTER_READ CTDB_ON_RECORD_BEFORE_BUILD_KEY CTDB_ON_RECORD_AFTER_BUILD_KEY CTDB_ON_RECORD_BEFORE_WRITE CTDB_ON_RECORD_AFTER_WRITE CTDB_ON_RECORD_MAPTOPARENT CTDB_ON_RECORD_MAPTOCHILD Working with Callbacks Allocating and Freeing Memory Inside Callbacks Working with Unicode FairCom DB API Support for Unicode Unicode UTF-16 Unicode UTF-8 FairCom DB API C++ API UTF-8 Compliance Activating FairCom DB API Unicode support ICU - International Components for Unicode Unicode Support FairCom DB Unicode UTF-16 Field Types Creating Tables with Unicode Field types FairCom DB API C++ API Example Reading UTF-16 Field Data Reading UTF-16 Data C++ Example Writing UTF-16 Field Data Writing UTF-16 Data C++ Example Creating Key Segments based on Unicode Fields How to Specify a Unicode Key Segment Specifing a Unicode Key Segment C++ Example Specifying a Unicode Key Segment with CTSEG_UNCSEG CTSEG_UNCSEG C++ API Example ICU Collation Option Overview Storing UTF-8 Data Converting from Unicode UTF-16 to UTF-8 Extended Key Segment Definition FairCom DB API C++ API Methods Extended Key Segment Structure ctKSEG_SSIZ_COMPUTED ctKSEG_SSIZ PROVIDED Compatibility with other c-tree API Technologies Compatibility with FairCom DB ISAM and Low-Level Data Files Compatibility with FairCom DB SQL Field mapping between FairCom DB SQL, FairCom DB API and FairCom DB API .NET FairCom DB API, ISAM, and Low-Level Integration Overview Switching c-tree instances Switching ISAM contexts Obtaining table data and file number Obtaining data file number Obtaining index file number FairCom DB API C++ API Class Reference c-treeDB API Definitions Field Types Find Modes Index Key Types Record Lock Modes Session-Wide Lock Modes Segment Modes Table Create Modes Table Open Modes Table Permissions CTBase Class class CTBase CTBase Public Members CTBase Methods CTBase::CTBase CTBase::~CTBase CTBase::Abort CTBase::GetAutoCommit CTBase::Begin CTBase::ClearError CTBase::Commit CTBase::GetDefDateType CTBase::GetDefFloatFormat CTBase::GetDefTimeType CTBase::GetError CTBase::GetHandle CTBase::GetHandleId CTBase::GetKeepLock CTBase::GetLockMode CTBase::GetOperation CTBase::GetSystemConfig CTBase::GetTransactionMode CTBase::GetUserTag CTBase::IsLockActive CTBase::IsTransActive CTBase::Lock CTBase::RestoreSavePoint CTBase::SetAutoCommit CTBase::SetDefDateType CTBase::SetDefFloatFormat CTBase::SetDefTimeType CTBase::SetError CTBase::SetHandle CTBase::SetKeepLock CTBase::SetOperation CTBase::SetSavePoint CTBase::SetUserTag CTBase::SetTransactionMode CTBase::SwitchInstance CTBase::Unlock CTBigint Class class CTBigint CTBigint Operators CTBigint::operator = CTBigint::operator <, <=, >, >=, ==, != CTBigint Methods CTBigint::CTBigint CTBigint::~CTBigint CTBigint::AsBigint CTBigint::AsFloat CTBigint::AsLong CTBigint::AsMoney CTBigint::AsString CTBigint::IsZero CTBigint::SetBigint CTBigint::Zero CTBlob Class class CTBlob CTBlob Operators CTBlob::operator = CTBlob::operator <, <=, >, >=, ==, != CTBlob Methods CTBlob::CTBlob CTBlob::~CTBlob CTBlob::AsString CTBlob::Get CTBlob::GetBlob CTBlob::GetSize CTBlob::Resize CTBlob::SetBlob CTBlob::UpdateBlob CTCurrency Class class CTCurrency CTCurrency Operators CTCurrency::operator =, +=, -=, *=, /=, abs, +, -, *, / CTCurrency::operator <, <=, >, >=, ==, != CTCurrency Methods CTCurrency::CTCurrency CTCurrency::~CTCurrency CTCurrency::AsBigint CTCurrency::AsCurrency CTCurrency::AsFloat CTCurrency::AsLong CTCurrency::AsMoney CTCurrency::AsString CTCurrency::IsZero CTCurrency::Round CTCurrency::SetCurrency CTCurrency::StringToCurrency CTCurrency::Zero CTDatabase Class class CTDatabase CTDatabase Methods CTDatabase::CTDatabase CTDatabase::~CTDatabase CTDatabase::AddTable CTDatabase::CloseAll CTDatabase::Connect CTDatabase::Create CTDatabase::DeleteTable CTDatabase::Disconnect CTDatabase::DropTable CTDatabase::FindActive CTDatabase::FindTable CTDatabase::FirstTable CTDatabase::GetFirstActive CTDatabase::GetNextActive CTDatabase::GetName CTDatabase::GetPath CTDatabase::GetTableCount CTDatabase::GetTableUID CTDatabase::IsActive CTDatabase::IsExclusive CTDatabase::NextTable CTDatabase::RenameTable CTDatabase::SetExclusive CTDate Class class CTDate CTDate Operators CTDate::operator = CTDate::operator <, <=, >, >=, ==, != CTDate Methods CTDate::CTDate CTDate::~CTDate CTDate::CurrentDate CTDate::DateToString CTDate::Day CTDate::DayOfWeek CTDate::GetDate CTDate::IsLeapYear CTDate::Month CTDate::Pack CTDate::SetDate CTDate::StringToDate CTDate::Unpack CTDate::Year CTDateTime Class class CTDateTime CTDateTime Operators CTDateTime::operator = CTDateTime::operator <, <=, >, >=, ==, != CTDateTime Methods CTDateTime::CTDateTime CTDateTime::~CTDateTime CTDateTime::CurrentDate CTDateTime::CurrentDateTime CTDateTime::DateTimeToString CTDateTime::Day CTDateTime::DayOfWeek CTDateTime::GetDate CTDateTime::GetDateTime CTDateTime::GetTime CTDateTime::IsLeapYear CTDateTime::Hour CTDateTime::Minute CTDateTime::Month CTDateTime::Pack CTDateTime::Second CTDateTime::SetDateTime CTDateTime::StringToDateTime CTDateTime::Unpack CTDateTime::Year CTException Class class CTException CTException Methods CTException::CTException CTException::~CTException CTException::GetErrorCode CTException::GetErrorMsg CTException::GetLineNumber CTException::GetSourceFile CTField Class class CTField CTField Operators CTField::operator= CTField Methods CTField::ClearFieldDefaultValue CTField::CTField CTField::~CTField CTField::GetBinaryFlag CTField::GetFieldDefaultDateType CTField::GetFieldDefaultTimeType CTField::GetFieldDefaultValue CTField::GetLength CTField::GetName CTField::GetNullFlag CTField::GetNumber CTField::GetPrecision CTField::GetScale CTField::GetStatus CTField::GetType CTField::IsFieldDefaultValueSet CTField::IsNumeric CTField::SetBinaryFlag CTField::SetFieldDefaultDateTimeType CTField::SetFieldDefaultValue CTField::SetLength CTField::SetName CTField::SetNullFlag CTField::SetPrecision CTField::SetScale CTField::SetType CTFullTextIndex Class class CTFullTextIndex CTFullTextIndex Methods CTFullTextIndex::AddField CTFullTextIndex::GetField CTFullTextIndex::GetFieldCount CTFullTextIndex::GetFieldMode CTFullTextIndex::GetName CTFullTextIndex::GetNumber CTFullTextIndex::GetStatus CTFullTextIndex::SetOption CTFullTextIndexDictionary Class class CTFullTextIndexDictionary CTFullTextIndexDictionary Methods CTFullTextIndexDictionary::SetOption CTIndex Class class CTIndex CTIndex Operators CTIndex::operator= CTIndex Methods CTIndex::CTIndex CTIndex::~CTIndex CTIndex::AddSegment CTIndex::DelSegment CTIndex::GetDuplicateFlag CTIndex::GetEmptyChar CTIndex::GetIndexFileName CTIndex::GetIndexKSeg CTIndex::GetIdxno CTIndex::GetKeyLength CTIndex::GetKeyType CTIndex::GetName CTIndex::GetNullFlag CTIndex::GetNumber CTIndex::GetSegment CTIndex::GetSegmentCount CTIndex::GetStatus CTIndex::GetTemporaryFlag CTIndex::GetUID CTIndex::InsertSegment CTIndex::MoveSegment CTIndex::SetDuplicateFlag CTIndex::SetEmptyChar CTIndex::SetIndexFileName CTIndex::SetIndexKSeg CTIndex::SetKeyType CTIndex::SetNullFlag CTIndex::SetTemporaryFlag CTMoney Class class CTMoney CTMoney Operators CTMoney::operator =, +=, -=, *=, /=, abs, +, -, *, / CTMoney::operator <, <=, >, >=, ==, != CTMoney Methods CTMoney::CTMoney CTMoney::~CTMoney CTMoney::AsFloat CTMoney::AsLong CTMoney::AsMoney CTMoney::AsString CTMoney::SetInt CTMoney::SetMoney CTMoney::StringToMoney CTNumber Class class CTNumber CTNumber Operators CTNumber::operator =, +, -, (, /, abs CTNumber::operator <, <=, >, >=, ==, != CTNumber Methods CTNumber::CTNumber CTNumber::~CTNumber CTNumber::AsBigint CTNumber::AsCurrency CTNumber::AsFloat CTNumber::AsLong CTNumber::AsMoney CTNumber::AsNumber CTNumber::AsString CTNumber::DecimalDigits CTNumber::IntegralDigits CTNumber::IsZero CTNumber::Round CTNumber::SetNumber CTNumber::Zero CTRecord Class class CTRecord CTRecord Methods CTRecord::AtPercentile CTRecord::BatchLoaded CTRecord::BatchLocked CTRecord::BatchMode CTRecord::BatchTotal CTRecord::BuildTargetKey CTRecord::Clear CTRecord::ClearField CTRecord::CTRecord CTRecord::Delete CTRecord::EndBatch CTRecord::EstimateSpan CTRecord::Find CTRecord::FindRowid CTRecord::FindTarget CTRecord::First CTRecord::FullTextSearchOff CTRecord::FullTextSearchOn CTRecord::GetDefaultIndex CTRecord::GetDefaultIndexName CTRecord::GetErrorIndex CTRecord::GetFieldAddress CTRecord::GetFieldAsBigint CTRecord::GetFieldAsBlob CTRecord::GetFieldAsBool CTRecord::GetFieldAsBytes CTRecord::GetFieldAsCurrency CTRecord::GetFieldAsDate CTRecord::GetFieldAsDateTime CTRecord::GetFieldAsFloat CTRecord::GetFieldAsMoney CTRecord::GetFieldAsNumber CTRecord::GetFieldAsShort CTRecord::GetFieldAsSigned CTRecord::GetFieldAsString CTRecord::GetFieldAsString CTRecord::GetFieldAsTime CTRecord::GetFieldAsUnsigned CTRecord::GetFieldAsUTF16 CTRecord::GetFieldAsWord CTRecord::GetFieldByName CTRecord::GetFieldLength CTRecord::GetFieldName CTRecord::GetFieldOffset CTRecord::GetFieldSize CTRecord::GetFieldType CTRecord::GetFilter CTRecord::GetFullTextSearchErrorDetails CTRecord::GetRecordBuffer CTRecord::GetRecordCount CTRecord::GetRecordKeyPos CTRecord::GetRecordLength CTRecord::GetRecordPos CTRecord::GetRecordSize CTRecord::GetRowid CTRecord::InsertBatch CTRecord::IsBatchActive CTRecord::IsEdited CTRecord::IsFiltered CTRecord::IsFullTextSearchOn CTRecord::IsNew CTRecord::IsNullField CTRecord::IsRangeOn CTRecord::IsRecordSetOn CTRecord::IsVariableField CTRecord::Last CTRecord::LockRecord CTRecord::Next CTRecord::NextBatch CTRecord::NextInBatch CTRecord::NumberOfKeyEntries CTRecord::Prev CTRecord::RangeOff CTRecord::RangeOn CTRecord::Read CTRecord::RecordSetOff CTRecord::RecordSetOn CTRecord::Reset CTRecord::SeekRecord CTRecord::SetBatch CTRecord::SetDefaultFullTextIndex CTRecord::SetDefaultIndex CTRecord::SetEdited CTRecord::SetFieldAsBigint CTRecord::SetFieldAsBlob CTRecord::SetFieldAsBool CTRecord::SetFieldAsByte CTRecord::SetFieldAsChar CTRecord::SetFieldAsCurrency CTRecord::SetFieldAsDate CTRecord::SetFieldAsDateTime CTRecord::SetFieldAsFloat CTRecord::SetFieldAsMoney CTRecord::SetFieldAsNumber CTRecord::SetFieldAsShort CTRecord::SetFieldAsSigned CTRecord::SetFieldAsString CTRecord::SetFieldAsTime CTRecord::SetFieldAsUnsigned CTRecord::SetFieldAsUTF16 CTRecord::SetFieldAsWord CTRecord::SetFilter CTRecord::SetNew CTRecord::SetRecordOffset CTRecord::SetRecordPos CTRecord::SwitchContext CTRecord::UnlockRecord CTRecord::Write CTRecord::~CTRecord CTResource Class class CTResource CTResource Methods CTResource::CTResource CTResource::Add CTResource::Delete CTResource::Find CTResource::First CTResource::GetData CTResource::GetDataLength CTResource::GetName CTResource::GetNumber CTResource::GetType CTResource::IsLocked CTResource::Next CTResource::SetData CTResource::SetName CTResource::SetNumber CTResource::SetType CTResource::Unlock CTResource::Update CTSegment Class class CTSegment CTSegment Operators CTSegment::operator= CTSegment Methods CTSegment::CTSegment CTSegment::~CTSegment CTSegment::GetField CTSegment::GetFieldName CTSegment::GetMode CTSegment::GetNumber CTSegment::GetPartialField CTSegment::GetPartialFieldName CTSegment::GetSegmentKSeg CTSegment::GetStatus CTSegment::MoveSegment CTSegment::SetKSegDefaults CTSegment::SetMode CTSegment::SetSegmentKSeg CTSession Class class CTSession CTSession Methods CTSession::CTSession CTSession::~CTSession CTSession::AddDatabase CTSession::Attach CTSession::BeginImpersonation CTSession::Create CTSession::CreateDatabase CTSession::DeleteDatabase CTSession::Detach CTSession::DisconnectAll CTSession::DropDatabase CTSession::EndImpersonation CTSession::FindActive CTSession::FindDatabase CTSession::FirstDatabase CTSession::GetAttachMode CTSession::GetDatabaseCount CTSession::GetDatabaseUID CTSession::GetFirstActive CTSession::GetLibType CTSession::GetLogonOnly CTSession::GetNextActive CTSession::GetParam CTSession::GetPath CTSession::GetPathPrefix CTSession::GetServerName CTSession::IsActive CTSession::IsExclusive CTSession::Logon CTSession::Logout CTSession::NextDatabase CTSession::SetConfigurationFile CTSession::SetCurrentNodeName CTSession::SetLogonOnly CTSession::SetExclusive CTSession::SetParam CTSession::SetPath CTSession::SetPathPrefix CTSession::StartDatabaseEngine CTSession::StopDatabaseEngine CTString Class class CTString CTString Operators CTString::operator =, +, += CTString::operator[ ] CTString::operator<, <=, >, >=, ==, != CTString Methods CTString::CTString CTString::~CTString CTString::c_str CTString::Compare CTString::CompareIC CTString::Delete CTString::Empty CTString::Insert CTString::IntToHex CTString::IsDelimiter CTString::IsEmpty CTString::IsPathDelimiter CTString::LastChar CTString::LastDelimiter CTString::Left CTString::Length CTString::LowerCase CTString::PadLeft CTString::PadRight CTString::Pos CTString::Right CTString::SetLength CTString::StringOfChar CTString::SubString CTString::ToInt CTString::ToDouble CTString::Trim CTString::TrimLeft CTString::TrimRight CTString::UpperCase CTTable Class class CTTable CTTable Methods CTTable::AddField CTTable::AddField (by field object) - FTS CTTable::AddField (by name) - FTS CTTable::AddField (by number) - FTS CTTable::AddFullTextIndex CTTable::AddIndex CTTable::AddSegment CTTable::Alter CTTable::Attach CTTable::AttachXtd CTTable::ClearAllFieldDefaultValue CTTable::Clone CTTable::Close CTTable::Create CTTable::CTTable CTTable::DelField CTTable::DelFullTextIndex (by index name) CTTable::DelFullTextIndex (by index number) CTTable::DelIndex CTTable::DelSegment CTTable::Detach CTTable::FilterRecord CTTable::GetCndxIndex CTTable::GetCndxIndexByName CTTable::GetCndxIndexLength CTTable::GetCndxIndexLengthByName CTTable::GetCreateMode CTTable::GetDataDefaultExtentSize CTTable::GetDataExtension CTTable::GetDatno CTTable::GetField CTTable::GetFieldCount CTTable::GetFieldNumber CTTable::GetFilter CTTable::GetFirstPartition CTTable::GetFullTextIndex (by index name) CTTable::GetFullTextIndex (by index number) CTTable::GetFullTextIndexCount CTTable::GetGroupid CTTable::GetIdxno CTTable::GetIndex CTTable::GetIndexByUID CTTable::GetIndexCount CTTable::GetIndexDefaultExtentSize CTTable::GetIndexExtension CTTable::GetIndexFileName CTTable::GetLastPartition CTTable::GetName CTTable::GetOpenMode CTTable::GetOwner CTTable::GetPadChar CTTable::GetPartitionIndexNbr CTTable::GetPassword CTTable::GetPath CTTable::GetPermission CTTable::GetSegment CTTable::GetStatus CTTable::GetTableKSeg CTTable::HasDelField CTTable::HasLocks CTTable::HasNullFieldSupport CTTable::HasRecbyt CTTable::HasRowid CTTable::InsertField CTTable::InsertSegment CTTable::IsActive CTTable::IsFilteredRecord CTTable::MoveField CTTable::MoveSegment CTTable::Open CTTable::PartAdminByKey CTTable::PartAdminByName CTTable::PartAdminByNumber CTTable::Rebuild CTTable::Remove CTTable::ResetAll CTTable::SetDataDefaultExtentSize CTTable::SetDataExtension CTTable::SetFullTextIndexOption (by index object) CTTable::SetFullTextIndexOption (by name) CTTable::SetFullTextIndexOption (by number) CTTable::SetGroupid CTTable::SetIndexDefaultExtentSize CTTable::SetIndexExtension CTTable::SetIndexFileName CTTable::SetOwner CTTable::SetPadChar CTTable::SetPartitionIndexNbr CTTable::SetPartitionMaximumActive CTTable::SetPartitionNumberBits CTTable::SetPartitionRule CTTable::SetPassword CTTable::SetPath CTTable::SetPermission CTTable::SetTableKSeg CTTable::SystemFilterOff CTTable::SystemFilterOn CTTable::Truncate CTTable::UnlockTable CTTable::UpdateCreateMode CTTable::UpdatePadChar CTTable::~CTTable CTTime Class class CTTime CTTime Operators CTTime::operator = CTTime::operator <, <=, >, >=, ==, != CTTime Methods CTTable::Attach CTTable::AttachXtd CTTable::ClearAllFieldDefaultValue CTTime::CTTime CTTime::~CTTime CTTime::CurrentTime CTTable::Detach CTTable::GetDatno CTTable::GetIdxno CTTable::GetTableKSeg CTTime::GetTime CTTime::Hour CTTime::Minute CTTable::MoveSegment CTTime::Pack CTTable::Remove CTTime::Second CTTable::SetTableKSeg CTTime::SetTime CTTime::StringToTime CTTable::SystemFilterOff CTTable::SystemFilterOn CTTime::TimeToString CTTime::Unpack FairCom DB Error Code Reference FairCom DB API Error and Return Values FairCom Typographical Conventions Copyright Notice Index