GncSqlObjectBackend Struct Reference

#include <gnc-backend-sql.h>

Data Fields
int	version
const gchar *	type_name
gboolean(*	commit )(GncSqlBackend *be, QofInstance *inst)
void(*	initial_load )(GncSqlBackend *be)
void(*	create_tables )(GncSqlBackend *be)
gpointer(*	compile_query )(GncSqlBackend *be, QofQuery *pQuery)
void(*	run_query )(GncSqlBackend *be, gpointer pQuery)
void(*	free_query )(GncSqlBackend *be, gpointer pQuery)
gboolean(*	write )(GncSqlBackend *be)

---

Detailed Description

Struct used to handle a specific engine object type for an SQL backend. This handler should be registered with qof_object_register_backend().

commit() - commit an object to the db initial_load() - load stuff when new db opened create_tables() - create any db tables compile_query() - compile a backend object query run_query() - run a compiled query free_query() - free a compiled query write() - write all objects

Definition at line 240 of file gnc-backend-sql.h.

---

Field Documentation

gboolean(* GncSqlObjectBackend::commit)(GncSqlBackend *be, QofInstance *inst)

Commit an instance of this object to the database

Returns:

TRUE if successful, FALSE if error

Definition at line 248 of file gnc-backend-sql.h.

gpointer(* GncSqlObjectBackend::compile_query)(GncSqlBackend *be, QofQuery *pQuery)

Compile a query on these objects

Definition at line 257 of file gnc-backend-sql.h.

void(* GncSqlObjectBackend::create_tables)(GncSqlBackend *be)

Create database tables for this object

Definition at line 254 of file gnc-backend-sql.h.

void(* GncSqlObjectBackend::free_query)(GncSqlBackend *be, gpointer pQuery)

Free a query on these objects

Definition at line 263 of file gnc-backend-sql.h.

void(* GncSqlObjectBackend::initial_load)(GncSqlBackend *be)

Load all objects of this type from the database

Definition at line 251 of file gnc-backend-sql.h.

void(* GncSqlObjectBackend::run_query)(GncSqlBackend *be, gpointer pQuery)

Run a query on these objects

Definition at line 260 of file gnc-backend-sql.h.

const gchar* GncSqlObjectBackend::type_name

Engine object type name

Definition at line 243 of file gnc-backend-sql.h.

int GncSqlObjectBackend::version

Backend version number

Definition at line 242 of file gnc-backend-sql.h.

gboolean(* GncSqlObjectBackend::write)(GncSqlBackend *be)

Write all objects of this type to the database

Returns:

TRUE if successful, FALSE if error

Definition at line 268 of file gnc-backend-sql.h.

---

The documentation for this struct was generated from the following file:

• gnc-backend-sql.h