Startup/Shutdown functions

Functions
HAILDB_API ib_err_t	ib_init (void) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_startup (const char *format) UNIV_NO_IGNORE
HAILDB_API ib_err_t	ib_shutdown (ib_shutdown_t flag) UNIV_NO_IGNORE

---

Detailed Description

Define the Doxygen groups:

---

Function Documentation

HAILDB_API ib_err_t ib_init

(

void

)

Initialize the InnoDB engine. This must be called prior to calling any other InnoDB API function. You can call only the ib_cfg_*() functions between calls to ib_init() and ib_startup(). No other HailDB functions should be called.

Returns:

DB_SUCCESS or error code

HAILDB_API ib_err_t ib_shutdown

(

ib_shutdown_t

flag

)

Shutdown the InnoDB engine. Call this function when they are no active transactions. It will close all files and release all memory on successful completion. All internal variables will be reset to their default values.

Parameters:

flag

is the shutdown flag

Returns:

DB_SUCCESS or error code

HAILDB_API ib_err_t ib_startup

(

const char *

format

)

Startup the InnoDB engine. If this function is called on a non-existent database then based on the default or user specified configuration settings it will create all the necessary files. If the database was shutdown cleanly but the user deleted the REDO log files then it will recreate the REDO log files.

Parameters:

format

is the max file format name that the engine supports. Currently this is either Antelope or Barracuda although more may be added in the future without API changes.

Returns:

DB_SUCCESS or error code

See also:

DB_SUCCESS