GncSqlTransBackend Class Reference

Inheritance diagram for GncSqlTransBackend:

Public Member Functions
void	load_all (GncSqlBackend *) override
	Loads all transactions. More...
void	create_tables (GncSqlBackend *) override
	Creates the transaction and split tables. More...
bool	commit (GncSqlBackend *sql_be, QofInstance *inst) override
	UPDATE/INSERT a single instance of m_type_name into the database. More...
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. More...
const char *	type () const noexcept
	Return the m_type_name for the class. More...
const bool	is_version (int version) const noexcept
	Compare a version with the compiled version (m_version). More...
bool	instance_in_db (const GncSqlBackend *sql_be, QofInstance *inst) const noexcept
	Check the presence of an object in the backend's database. More...

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 36 of file gnc-transaction-sql.h.

Member Function Documentation

commit()

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

overridevirtual

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

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

{
    E_DB_OPERATION op;
    gboolean is_ok = TRUE;
    const char* err = NULL;

    g_return_val_if_fail (sql_be != NULL, FALSE);
    g_return_val_if_fail (inst != NULL, FALSE);

    auto pTx = GNC_TRANS(inst);
    auto 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 (op != OP_DB_DELETE)
    {
        gnc_commodity* commodity = xaccTransGetCurrency (pTx);
        // Ensure the commodity is in the db
        is_ok = sql_be->save_commodity(commodity);
        if (! is_ok)
        {
            err = "Commodity save failed: Probably an invalid or missing currency";
            qof_backend_set_error ((QofBackend*)sql_be, ERR_BACKEND_DATA_CORRUPT);
        }
    }

    if (is_ok)
    {
        is_ok = sql_be->do_db_operation(op, TRANSACTION_TABLE, GNC_ID_TRANS,
                                        pTx, tx_col_table);
        if (! is_ok)
        {
            err = "Transaction header save failed. Check trace log for SQL errors";
        }
    }

    if (is_ok)
    {
        // Commit slots
        auto guid = qof_instance_get_guid (inst);
        if (!qof_instance_get_destroying (inst))
        {
            is_ok = gnc_sql_slots_save (sql_be, guid, is_infant, inst);
            if (! is_ok)
            {
                err = "Slots save failed. Check trace log for SQL errors";
            }
        }
        else
        {
            is_ok = gnc_sql_slots_delete (sql_be, guid);
            if (! is_ok)
            {
                err = "Slots delete failed. Check trace log for SQL errors";
            }
            if (is_ok)
            {
                is_ok = delete_splits (sql_be, pTx);
                if (! is_ok)
                {
                    err = "Split delete failed. Check trace log for SQL errors";
                }
            }
        }
    }
    if (! is_ok)
    {
        Split* split = xaccTransGetSplit (pTx, 0);
        Account* acc = xaccSplitGetAccount (split);
        gchar *datestr = qof_print_date (xaccTransGetDate (pTx));
        /* FIXME: This needs to be implemented
        const char *message1 = "Transaction %s dated %s in account %s not saved due to %s.%s";
        const char *message2 = "\nDatabase may be corrupted, check your data carefully.";
        qof_error_format_secondary_text( GTK_MESSAGE_DIALOG( msg ),
                              message1,
                             xaccTransGetDescription( pTx ),
                              qof_print_date( xaccTransGetDate( pTx ) ),
                              xaccAccountGetName( acc ),
                              err,
                              message2 );
        */
        PERR ("Transaction %s dated %s in account %s not saved due to %s.\n",
              xaccTransGetDescription (pTx), datestr, xaccAccountGetName (acc), err);
        g_free (datestr);
    }
    return is_ok;
}

create_tables()

void GncSqlTransBackend::create_tables ( GncSqlBackend *  sql_be )

overridevirtual

Creates the transaction and split tables.

Parameters

sql_be

SQL backend

Reimplemented from GncSqlObjectBackend.

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

{
    gint version;
    gboolean ok;

    g_return_if_fail (sql_be != NULL);

    version = sql_be->get_table_version( m_table_name.c_str());
    if (version == 0)
    {
        (void)sql_be->create_table(TRANSACTION_TABLE, TX_TABLE_VERSION,
                                    tx_col_table);
        ok = sql_be->create_index ("tx_post_date_index", TRANSACTION_TABLE,
                                   post_date_col_table);
        if (!ok)
        {
            PERR ("Unable to create index\n");
        }
    }
    else if (version < m_version)
    {
        /* Upgrade:
            1->2: 64 bit int handling
            2->3: allow dates to be NULL
            3->4: Use DATETIME instead of TIMESTAMP in MySQL
        */
        sql_be->upgrade_table(m_table_name.c_str(), tx_col_table);
        sql_be->set_table_version (m_table_name.c_str(), m_version);
        PINFO ("Transactions table upgraded from version %d to version %d\n",
               version, m_version);
    }
}

load_all()

void GncSqlTransBackend::load_all ( GncSqlBackend *  sql_be )

overridevirtual

Loads all transactions.

This might be used during a save-as operation to ensure that all data is in memory and ready to be saved.

Parameters

sql_be

SQL backend

Implements GncSqlObjectBackend.

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

{
    g_return_if_fail (sql_be != NULL);

    auto root = gnc_book_get_root_account (sql_be->book());
    gnc_account_foreach_descendant(root, (AccountCb)xaccAccountBeginEdit,
                                   nullptr);
    query_transactions (sql_be, "");
    gnc_account_foreach_descendant(root, (AccountCb)xaccAccountCommitEdit,
                                   nullptr);
}

---

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

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