GncSqlObjectBackend Class Reference

Encapsulates per-class table schema with functions to load, create a table, commit a changed front-end object (note that database transaction semantics are not yet implemented; edit/commit applies to the front-end object!) and write all front-end objects of the type to the database. More...

#include <gnc-sql-object-backend.hpp>

Inheritance diagram for GncSqlObjectBackend:

Public Member Functions
	GncSqlObjectBackend (int version, const std::string &type, const std::string &table, const EntryVec &vec)
virtual void	load_all (GncSqlBackend *sql_be)=0
	Load all objects of m_type in the database into memory.
virtual void	create_tables (GncSqlBackend *sql_be)
	Conditionally create or update a database table from m_col_table.
virtual bool	commit (GncSqlBackend *sql_be, QofInstance *inst)
	UPDATE/INSERT a single instance of m_type_name into the database.
virtual bool	write (GncSqlBackend *sql_be)
	Write all objects of m_type_name to the database.
const char *	type () const noexcept
	Return the m_type_name for the class.
const bool	is_version (int version) const noexcept
	Compare a version with the compiled version (m_version).
bool	instance_in_db (const GncSqlBackend *sql_be, QofInstance *inst) const noexcept
	Check the presence of an object in the backend's database.

Protected Attributes
const std::string	m_table_name
const int	m_version
const std::string	m_type_name
const EntryVec &	m_col_table
	The front-end QofIdType.

Detailed Description

Encapsulates per-class table schema with functions to load, create a table, commit a changed front-end object (note that database transaction semantics are not yet implemented; edit/commit applies to the front-end object!) and write all front-end objects of the type to the database.

Additional functions for creating and running queries existed but were unused and untested. They've been temporarily removed until the front end is ready to use them.

Definition at line 48 of file gnc-sql-object-backend.hpp.

Constructor & Destructor Documentation

GncSqlObjectBackend()

GncSqlObjectBackend::GncSqlObjectBackend ( int  version, const std::string &  type, const std::string &  table, const EntryVec &  vec  )

inline

Definition at line 51 of file gnc-sql-object-backend.hpp.

                                                                      :
        m_table_name{table}, m_version{version}, m_type_name{type},
        m_col_table(vec) {}

Member Function Documentation

commit()

bool GncSqlObjectBackend::commit ( GncSqlBackend *  sql_be, QofInstance *  inst  )

virtual

UPDATE/INSERT a single instance of m_type_name into the database.

Parameters

sql_be	The GncSqlBackend containing the database.
inst	The QofInstance to be written out.

Reimplemented in GncSqlAccountBackend, GncSqlCommodityBackend, GncSqlEmployeeBackend, GncSqlRecurrenceBackend, GncSqlSlotsBackend, GncSqlVendorBackend, GncSqlBudgetBackend, GncSqlInvoiceBackend, GncSqlPriceBackend, GncSqlSchedXactionBackend, GncSqlTaxTableBackend, GncSqlTransBackend, and GncSqlSplitBackend.

Definition at line 33 of file gnc-sql-object-backend.cpp.

{
    const GncGUID* guid;
    gboolean is_infant;
    E_DB_OPERATION op;
    gboolean is_ok;
 
    is_infant = qof_instance_get_infant (inst);
    if (qof_instance_get_destroying (inst))
    {
        op = OP_DB_DELETE;
    }
    else if (sql_be->pristine() || is_infant)
    {
        op = OP_DB_INSERT;
    }
    else
    {
        op = OP_DB_UPDATE;
    }
    is_ok = sql_be->do_db_operation(op, m_table_name.c_str(),
                                    m_type_name.c_str(), inst, m_col_table);
 
    if (is_ok)
    {
        // Now, commit any slots
        guid = qof_instance_get_guid (inst);
        if (!qof_instance_get_destroying (inst))
        {
            is_ok = gnc_sql_slots_save (sql_be, guid, is_infant, inst);
        }
        else
        {
            is_ok = gnc_sql_slots_delete (sql_be, guid);
        }
    }
 
    return is_ok;
}

create_tables()

void GncSqlObjectBackend::create_tables ( GncSqlBackend *  sql_be )

virtual

Conditionally create or update a database table from m_col_table.

The condition is the version returned by querying the database's version table: If it's 0 then the table wasn't found and will be created; All tables areat least version 1. If the database's version is less than the compiled version then the table schema is upgraded but the data isn't, that's the engine's responsibility when the object is loaded. If the version is greater than the compiled version then nothing is touched.

Parameters

sql_be

The GncSqlBackend containing the database connection.

Reimplemented in GncSqlBillTermBackend, GncSqlBudgetBackend, GncSqlCustomerBackend, GncSqlEmployeeBackend, GncSqlEntryBackend, GncSqlInvoiceBackend, GncSqlLotsBackend, GncSqlPriceBackend, GncSqlRecurrenceBackend, GncSqlSlotsBackend, GncSqlTaxTableBackend, GncSqlTransBackend, and GncSqlSplitBackend.

Definition at line 74 of file gnc-sql-object-backend.cpp.

{
    g_return_if_fail (sql_be != nullptr);
    int version = sql_be->get_table_version (m_table_name);
    if (version == 0) //No tables, otherwise version will sql_be >= 1.
    {
        sql_be->create_table(m_table_name, m_col_table);
        sql_be->set_table_version(m_table_name, m_version);
    }
    else if (version != m_version)
        PERR("Version mismatch in table %s, expecting %d but backend is %d."
             "Table creation aborted.", m_table_name.c_str(), m_version, version);
}

instance_in_db()

bool GncSqlObjectBackend::instance_in_db ( const GncSqlBackend *  sql_be, QofInstance *  inst  ) const

noexcept

Check the presence of an object in the backend's database.

Parameters

sql_be	Backend owning the database
inst	QofInstance to be checked.

Definition at line 89 of file gnc-sql-object-backend.cpp.

{
    return sql_be->object_in_db(m_table_name.c_str(), m_type_name.c_str(),
                                inst, m_col_table);
}

is_version()

const bool GncSqlObjectBackend::is_version ( int  version ) const

inlinenoexcept

Compare a version with the compiled version (m_version).

Returns

true if they match.

Definition at line 95 of file gnc-sql-object-backend.hpp.

                                                       {
        return version == m_version;
    }

load_all()

virtual void GncSqlObjectBackend::load_all ( GncSqlBackend *  sql_be )

pure virtual

Load all objects of m_type in the database into memory.

Parameters

sql_be

The GncSqlBackend containing the database connection.

Implemented in GncSqlAccountBackend, GncSqlBillTermBackend, GncSqlBookBackend, GncSqlBudgetBackend, GncSqlCommodityBackend, GncSqlCustomerBackend, GncSqlEmployeeBackend, GncSqlEntryBackend, GncSqlInvoiceBackend, GncSqlJobBackend, GncSqlLotsBackend, GncSqlOrderBackend, GncSqlPriceBackend, GncSqlRecurrenceBackend, GncSqlSchedXactionBackend, GncSqlSlotsBackend, GncSqlTaxTableBackend, GncSqlTransBackend, GncSqlSplitBackend, and GncSqlVendorBackend.

type()

const char * GncSqlObjectBackend::type ( ) const

inlinenoexcept

Return the m_type_name for the class.

This value is created at compilation time and is called QofIdType or QofIdTypeConst in other parts of GnuCash. Most values are defined in src/engine/gnc-engine.h.

Returns

m_type_name.

Definition at line 90 of file gnc-sql-object-backend.hpp.

{ return m_type_name.c_str(); }

write()

virtual bool GncSqlObjectBackend::write ( GncSqlBackend *  sql_be )

inlinevirtual

Write all objects of m_type_name to the database.

Parameters

sql_be

The GncSqlBackend containing the database.

Returns

true if the objects were successfully written, false otherwise.

Reimplemented in GncSqlBillTermBackend, GncSqlBudgetBackend, GncSqlCustomerBackend, GncSqlEmployeeBackend, GncSqlEntryBackend, GncSqlInvoiceBackend, GncSqlJobBackend, GncSqlLotsBackend, GncSqlOrderBackend, GncSqlPriceBackend, GncSqlTaxTableBackend, and GncSqlVendorBackend.

Definition at line 83 of file gnc-sql-object-backend.hpp.

{ return true; }

Field Documentation

m_col_table

const EntryVec& GncSqlObjectBackend::m_col_table

protected

The front-end QofIdType.

Definition at line 110 of file gnc-sql-object-backend.hpp.

m_table_name

const std::string GncSqlObjectBackend::m_table_name

protected

Definition at line 107 of file gnc-sql-object-backend.hpp.

m_type_name

const std::string GncSqlObjectBackend::m_type_name

protected

Definition at line 109 of file gnc-sql-object-backend.hpp.

m_version

const int GncSqlObjectBackend::m_version

protected

Definition at line 108 of file gnc-sql-object-backend.hpp.

---

The documentation for this class was generated from the following files:

• gnc-sql-object-backend.hpp
• gnc-sql-object-backend.cpp