Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbStartDatabaseEngine

Starts the FairCom DB database engine .DLL model.

Declaration

CTDBRET ctdbStartDatabaseEngine(void)

Description

A developer can call ctdbStartDatabaseEngine() once before making any other FairCom DB API or FairCom DB calls, and then call function ctdbStopDatabaseEngine() when finished with database activities to shut down the database engine. ctdbStartDatabaseEngine() must be called before any other FairCom DB API calls are performed. ctdbStartDatabaseEngine() loads the ctsrvr.cfg configuration file, creates the data and index caches, and initializes the multithreading subsystem.

Note that automatic recovery takes place on startup which can result in short delays after making this call, especially if the process was interrupted previously and an application shutdown without calling ctdbStopDatabaseEngine().

Returns

ctdbStartDatabaseEngine() returns CTDBRET_OK on success, or FairCom DB API API error on failure.

Example

ret = ctdbSetConfigurationFile("ctsrvr.cfg");

ret = ctdbStartDatabaseEngine();

...

...

ret = ctdbStopDatabaseEngine();

See also

ctdbStopDatabaseEngine(), ctdbSetConfigurationFile()

TOCIndex