GncSqlInvoiceBackend Class Reference

Inheritance diagram for GncSqlInvoiceBackend:

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
	UPDATE/INSERT a single instance of m_type_name into the database.
bool	write (GncSqlBackend *) override
	Write all objects of m_type_name to the database.
Public Member Functions inherited from GncSqlObjectBackend
	GncSqlObjectBackend (int version, const std::string &type, const std::string &table, const EntryVec &vec)
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 35 of file gnc-invoice-sql.h.

Constructor & Destructor Documentation

GncSqlInvoiceBackend()

GncSqlInvoiceBackend::GncSqlInvoiceBackend

(

)

Definition at line 100 of file gnc-invoice-sql.cpp.

                                           :
    GncSqlObjectBackend(TABLE_VERSION, GNC_ID_INVOICE,
                        TABLE_NAME, col_table) {}

Member Function Documentation

commit()

bool GncSqlInvoiceBackend::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 180 of file gnc-invoice-sql.cpp.

{
    const GncGUID* guid;
    GncInvoice* invoice;
    E_DB_OPERATION op;
    gboolean is_infant;
    gboolean is_ok = TRUE;
 
    g_return_val_if_fail (inst != NULL, FALSE);
    g_return_val_if_fail (GNC_IS_INVOICE (inst), FALSE);
    g_return_val_if_fail (sql_be != NULL, FALSE);
 
    invoice = GNC_INVOICE (inst);
 
    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)
    {
        // Ensure the commodity is in the db
        is_ok = sql_be->save_commodity(gncInvoiceGetCurrency(invoice));
    }
 
    if (is_ok)
    {
        is_ok = sql_be->do_db_operation(op, TABLE_NAME, GNC_ID_INVOICE, inst,
                                        col_table);
    }
 
    if (is_ok)
    {
        // Now, commit or delete 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 GncSqlInvoiceBackend::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 152 of file gnc-invoice-sql.cpp.

{
    gint version;
 
    g_return_if_fail (sql_be != NULL);
 
    version = sql_be->get_table_version( TABLE_NAME);
    if (version == 0)
    {
        sql_be->create_table(TABLE_NAME, TABLE_VERSION, col_table);
    }
    else if (version < TABLE_VERSION)
    {
        /* Upgrade:
             1->2: 64 bit int handling
             2->3: invoice open date can be NULL
             3->4: Use DATETIME instead of TIMESTAMP in MySQL
        */
        sql_be->upgrade_table(TABLE_NAME, col_table);
        sql_be->set_table_version (TABLE_NAME, TABLE_VERSION);
 
        PINFO ("Invoices table upgraded from version %d to version %d\n", version,
               TABLE_VERSION);
    }
}

load_all()

void GncSqlInvoiceBackend::load_all ( GncSqlBackend *  sql_be )

overridevirtual

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 132 of file gnc-invoice-sql.cpp.

{
    g_return_if_fail (sql_be != NULL);
 
    std::string sql("SELECT * FROM " TABLE_NAME);
    auto stmt = sql_be->create_statement_from_sql(sql);
    auto result = sql_be->execute_select_statement(stmt);
 
    for (auto row : *result)
        load_single_invoice (sql_be, row);
 
    std::string pkey(col_table[0]->name());
    sql = "SELECT DISTINCT ";
    sql += pkey + " FROM " TABLE_NAME;
    gnc_sql_slots_load_for_sql_subquery (sql_be, sql,
                     (BookLookupFn)gnc_invoice_lookup);
}

write()

bool GncSqlInvoiceBackend::write ( GncSqlBackend *  sql_be )

overridevirtual

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

Definition at line 270 of file gnc-invoice-sql.cpp.

{
    g_return_val_if_fail (sql_be != NULL, FALSE);
    write_objects_t data{sql_be, true, this};
 
    qof_object_foreach (GNC_ID_INVOICE, sql_be->book(), write_single_invoice, &data);
 
    return data.is_ok;
}

---

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

• gnc-invoice-sql.h
• gnc-invoice-sql.cpp