GncSqlSlotsBackend Class Reference

Slots are neither loadable nor committable. More...

#include <gnc-slots-sql.h>

Inheritance diagram for GncSqlSlotsBackend:

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

Slots are neither loadable nor committable.

Note that the default write() implementation is also a no-op.

Definition at line 41 of file gnc-slots-sql.h.

Member Function Documentation

commit()

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

inlineoverridevirtual

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 47 of file gnc-slots-sql.h.

{ return false; }

create_tables()

void GncSqlSlotsBackend::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 836 of file gnc-slots-sql.cpp.

{
    gint version;
    gboolean ok;

    g_return_if_fail (sql_be != NULL);

    version = sql_be->get_table_version( TABLE_NAME);
    if (version == 0)
    {
        (void)sql_be->create_table(TABLE_NAME, TABLE_VERSION, col_table);

        ok = sql_be->create_index ("slots_guid_index", TABLE_NAME,
                               obj_guid_col_table);
        if (!ok)
        {
            PERR ("Unable to create index\n");
        }
    }
    else if (version < m_version)
    {
        /* Upgrade:
            1->2: 64-bit int values to proper definition, add index
            2->3: Add gdate field
            3->4: Use DATETIME instead of TIMESTAMP in MySQL
        */
        if (version == 1)
        {
            sql_be->upgrade_table(TABLE_NAME, col_table);
            ok = sql_be->create_index ("slots_guid_index", TABLE_NAME,
                                   obj_guid_col_table);
            if (!ok)
            {
                PERR ("Unable to create index\n");
            }
        }
        else if (version == 2)
        {
            ok = sql_be->add_columns_to_table(TABLE_NAME, gdate_col_table);
            if (!ok)
            {
                PERR ("Unable to add gdate column\n");
            }
        }
        else
        {
            sql_be->upgrade_table(TABLE_NAME, col_table);
        }
        sql_be->set_table_version (TABLE_NAME, TABLE_VERSION);
        PINFO ("Slots table upgraded from version %d to version %d\n", version,
               TABLE_VERSION);
    }
}

load_all()

void GncSqlSlotsBackend::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 45 of file gnc-slots-sql.h.

{ return; }

---

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

• gnc-slots-sql.h
• gnc-slots-sql.cpp