GncSqlVendorBackend Class Reference

Inheritance diagram for GncSqlVendorBackend:

Public Member Functions
void	load_all (GncSqlBackend *) override
	Load all objects of m_type in the database into memory.
bool	commit (GncSqlBackend *, QofInstance *) 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)
virtual void	create_tables (GncSqlBackend *sql_be)
	Conditionally create or update a database table from m_col_table.
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-vendor-sql.h.

Constructor & Destructor Documentation

GncSqlVendorBackend()

GncSqlVendorBackend::GncSqlVendorBackend

(

)

Definition at line 82 of file gnc-vendor-sql.cpp.

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

Member Function Documentation

commit()

bool GncSqlVendorBackend::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 134 of file gnc-vendor-sql.cpp.

{
    GncVendor* v;
    const GncGUID* guid;
    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_VENDOR (inst), FALSE);
    g_return_val_if_fail (sql_be != NULL, FALSE);
 
    v = GNC_VENDOR (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 (gncVendorGetCurrency(v));
    }
    if (is_ok)
    {
        is_ok = sql_be->do_db_operation(op, TABLE_NAME, GNC_ID_VENDOR, v,
                                        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;
}

load_all()

void GncSqlVendorBackend::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 114 of file gnc-vendor-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_vendor (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_vendor_lookup);
}

write()

bool GncSqlVendorBackend::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 223 of file gnc-vendor-sql.cpp.

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

---

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

• gnc-vendor-sql.h
• gnc-vendor-sql.cpp