GncSqlSplitBackend Class Reference

Inheritance diagram for GncSqlSplitBackend:

Public Member Functions
void	load_all (GncSqlBackend *) override
	Load all objects of m_type in the database into memory.
void	create_tables (GncSqlBackend *) override
	Conditionally create or update a database table from m_col_table.
bool	commit (GncSqlBackend *sql_be, QofInstance *inst) override
	Commits a split to the database.
Public Member Functions inherited from GncSqlObjectBackend
	GncSqlObjectBackend (int version, const std::string &type, const std::string &table, const EntryVec &vec)
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.

Additional Inherited Members
Protected Attributes inherited from GncSqlObjectBackend
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

Definition at line 45 of file gnc-transaction-sql.h.

Constructor & Destructor Documentation

GncSqlSplitBackend()

GncSqlSplitBackend::GncSqlSplitBackend

(

)

Definition at line 146 of file gnc-transaction-sql.cpp.

                                       :
    GncSqlObjectBackend(SPLIT_TABLE_VERSION, GNC_ID_SPLIT,
                        SPLIT_TABLE, split_col_table) {}

Member Function Documentation

commit()

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

overridevirtual

Commits a split to the database.

Parameters

sql_be	SQL backend
inst	Split

Returns

TRUE if successful, FALSE if error

Reimplemented from GncSqlObjectBackend.

Definition at line 542 of file gnc-transaction-sql.cpp.

{
    E_DB_OPERATION op;
    gboolean is_infant;
    gboolean is_ok;
    GncGUID* guid = (GncGUID*)qof_instance_get_guid (inst);
 
    g_return_val_if_fail (inst != NULL, FALSE);
    g_return_val_if_fail (sql_be != NULL, FALSE);
 
    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;
    }
 
    if (guid_equal (guid, guid_null ()))
    {
        *guid = guid_new_return ();
        qof_instance_set_guid (inst, guid);
    }
 
    is_ok = sql_be->do_db_operation(op, SPLIT_TABLE, GNC_ID_SPLIT,
                                    inst, split_col_table);
 
    if (is_ok && !qof_instance_get_destroying (inst))
    {
        is_ok = gnc_sql_slots_save (sql_be, guid, is_infant, inst);
    }
 
    return is_ok;
}

create_tables()

void GncSqlSplitBackend::create_tables ( GncSqlBackend *  sql_be )

overridevirtual

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 from GncSqlObjectBackend.

Definition at line 442 of file gnc-transaction-sql.cpp.

{
    g_return_if_fail (sql_be != nullptr);
 
    auto version = sql_be->get_table_version( m_table_name.c_str());
    if (version == 0)
    {
        (void)sql_be->create_table(m_table_name.c_str(),
                                    m_version, m_col_table);
        if (!sql_be->create_index("splits_tx_guid_index",
                                   m_table_name.c_str(), tx_guid_col_table))
            PERR ("Unable to create index\n");
        if (!sql_be->create_index("splits_account_guid_index",
                                   m_table_name.c_str(),
                                   account_guid_col_table))
            PERR ("Unable to create index\n");
    }
    else if (version < SPLIT_TABLE_VERSION)
    {
 
        /* Upgrade:
           1->2: 64 bit int handling
           3->4: Split reconcile date can be NULL
           4->5: Use DATETIME instead of TIMESTAMP in MySQL
        */
        sql_be->upgrade_table(m_table_name.c_str(), split_col_table);
        if (!sql_be->create_index("splits_tx_guid_index",
                                   m_table_name.c_str(),
                                   tx_guid_col_table))
            PERR ("Unable to create index\n");
        if (!sql_be->create_index("splits_account_guid_index",
                                   m_table_name.c_str(),
                                   account_guid_col_table))
            PERR ("Unable to create index\n");
        sql_be->set_table_version (m_table_name.c_str(), m_version);
        PINFO ("Splits table upgraded from version %d to version %d\n", version,
               m_version);
    }
}

load_all()

void GncSqlSplitBackend::load_all ( GncSqlBackend *  sql_be )

inlineoverridevirtual

Load all objects of m_type in the database into memory.

Parameters

sql_be

The GncSqlBackend containing the database connection.

Implements GncSqlObjectBackend.

Definition at line 49 of file gnc-transaction-sql.h.

{ return; } // loaded by transaction.

---

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

• gnc-transaction-sql.h
• gnc-transaction-sql.cpp