gnc-slots-sql.h File Reference

load and save accounts data to SQL More...

#include <glib.h>
#include "guid.h"
#include "qof.h"
#include "gnc-sql-object-backend.hpp"

Go to the source code of this file.

Data Structures
class	GncSqlSlotsBackend
	Slots are neither loadable nor committable. More...

Typedefs
typedef QofInstance *(*	BookLookupFn) (const GncGUID *guid, const QofBook *book)

Functions
gboolean	gnc_sql_slots_save (GncSqlBackend *sql_be, const GncGUID *guid, gboolean is_infant, QofInstance *inst)
	gnc_sql_slots_save - Saves slots for an object to the db.
gboolean	gnc_sql_slots_delete (GncSqlBackend *sql_be, const GncGUID *guid)
	gnc_sql_slots_delete - Deletes slots for an object from the db.
void	gnc_sql_slots_load (GncSqlBackend *sql_be, QofInstance *inst)
	Loads slots for an object from the db.
void	gnc_sql_slots_load_for_sql_subquery (GncSqlBackend *sql_be, const std::string subquery, BookLookupFn lookup_fn)
	gnc_sql_slots_load_for_sql_subquery - Loads slots for all objects whose guid is supplied by a subquery.
void	gnc_sql_init_slots_handler (void)

Detailed Description

load and save accounts data to SQL

Author

Copyright (c) 2006-2008 Phil Longstaff plong.nosp@m.staf.nosp@m.f@rog.nosp@m.ers..nosp@m.com

This file implements the top-level QofBackend API for saving/ restoring data to/from an SQL database

Definition in file gnc-slots-sql.h.

Typedef Documentation

BookLookupFn

typedef QofInstance *(* BookLookupFn) (const GncGUID *guid, const QofBook *book)

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

Function Documentation

gnc_sql_slots_delete()

gboolean gnc_sql_slots_delete	(	GncSqlBackend *	sql_be,
		const GncGUID *	guid
	)

gnc_sql_slots_delete - Deletes slots for an object from the db.

Parameters

sql_be	SQL backend
guid	Object guid

Returns

TRUE if successful, FALSE if error

Definition at line 659 of file gnc-slots-sql.cpp.

{
    gchar* buf;
    gchar guid_buf[GUID_ENCODING_LENGTH + 1];
    slot_info_t slot_info = { NULL, NULL, TRUE, NULL, KvpValue::Type::INVALID,
                              NULL, FRAME, NULL, "" };
 
    g_return_val_if_fail (sql_be != NULL, FALSE);
    g_return_val_if_fail (guid != NULL, FALSE);
 
    (void)guid_to_string_buff (guid, guid_buf);
 
    buf = g_strdup_printf ("SELECT * FROM %s WHERE obj_guid='%s' and slot_type in ('%d', '%d') and not guid_val is null",
                           TABLE_NAME, guid_buf, KvpValue::Type::FRAME, KvpValue::Type::GLIST);
    auto stmt = sql_be->create_statement_from_sql(buf);
    g_free (buf);
    if (stmt != nullptr)
    {
        auto result = sql_be->execute_select_statement(stmt);
        for (auto row : *result)
        {
            const GncSqlColumnTableEntryPtr table_row =
                    col_table[guid_val_col];
            GncGUID child_guid;
            auto val = row.get_string_at_col (table_row->name());
            if (val && string_to_guid (val->c_str(), &child_guid))
                gnc_sql_slots_delete (sql_be, &child_guid);
        }
    }
 
    slot_info.be = sql_be;
    slot_info.guid = guid;
    slot_info.is_ok = TRUE;
    slot_info.is_ok = sql_be->do_db_operation(OP_DB_DELETE, TABLE_NAME,
                                              TABLE_NAME, &slot_info,
                                              obj_guid_col_table);
 
    return slot_info.is_ok;
}

gnc_sql_slots_load()

void gnc_sql_slots_load	(	GncSqlBackend *	sql_be,
		QofInstance *	inst
	)

Loads slots for an object from the db.

Parameters

sql_be

SQL backend

Definition at line 727 of file gnc-slots-sql.cpp.

{
    slot_info_t info = { NULL, NULL, TRUE, NULL, KvpValue::Type::INVALID,
                         NULL, FRAME, NULL, "" };
    g_return_if_fail (sql_be != NULL);
    g_return_if_fail (inst != NULL);
 
    info.be = sql_be;
    info.guid = qof_instance_get_guid (inst);
    info.pKvpFrame = qof_instance_get_slots (inst);
    info.context = NONE;
 
    slots_load_info (&info);
}

gnc_sql_slots_load_for_sql_subquery()

void gnc_sql_slots_load_for_sql_subquery	(	GncSqlBackend *	sql_be,
		const std::string	subquery,
		BookLookupFn	lookup_fn
	)

gnc_sql_slots_load_for_sql_subquery - Loads slots for all objects whose guid is supplied by a subquery.

The subquery should be of the form "SELECT DISTINCT guid FROM ...". This is faster than loading for one object at a time because fewer SQL queries * are used.

Parameters

sql_be	SQL backend
subquery	Subquery SQL string
lookup_fn	Lookup function to get the right object from the book

The subquery should be of the form "SELECT DISTINCT guid FROM ...". This is faster than loading for one object at a time because fewer SQL queries * are used.

Parameters

sql_be	SQL backend
subquery	Subquery SQL string
lookup_fn	Lookup function

Definition at line 808 of file gnc-slots-sql.cpp.

{
    g_return_if_fail (sql_be != NULL);
 
    // Ignore empty subquery
    if (subquery.empty()) return;
 
    std::string pkey(obj_guid_col_table[0]->name());
    std::string sql("SELECT * FROM " TABLE_NAME " WHERE ");
    sql += pkey + " IN (" + subquery + ")";
 
    // Execute the query and load the slots
    auto stmt = sql_be->create_statement_from_sql(sql);
    if (stmt == nullptr)
    {
        PERR ("stmt == NULL, SQL = '%s'\n", sql.c_str());
        return;
    }
    auto result = sql_be->execute_select_statement(stmt);
    for (auto row : *result)
        load_slot_for_book_object (sql_be, row, lookup_fn);
    delete result;
}

gnc_sql_slots_save()

gboolean gnc_sql_slots_save	(	GncSqlBackend *	sql_be,
		const GncGUID *	guid,
		gboolean	is_infant,
		QofInstance *	inst
	)

gnc_sql_slots_save - Saves slots for an object to the db.

Parameters

sql_be	SQL backend
guid	Object guid
is_infant	Is this an infant object?
inst	The QodInstance owning the slots.

Returns

TRUE if successful, FALSE if error

Definition at line 634 of file gnc-slots-sql.cpp.

{
    slot_info_t slot_info = { NULL, NULL, TRUE, NULL, KvpValue::Type::INVALID,
                              NULL, FRAME, NULL, "" };
    KvpFrame* pFrame = qof_instance_get_slots (inst);
 
    g_return_val_if_fail (sql_be != NULL, FALSE);
    g_return_val_if_fail (guid != NULL, FALSE);
    g_return_val_if_fail (pFrame != NULL, FALSE);
 
    // If this is not saving into a new db, clear out the old saved slots first
    if (!sql_be->pristine() && !is_infant)
    {
        (void)gnc_sql_slots_delete (sql_be, guid);
    }
 
    slot_info.be = sql_be;
    slot_info.guid = guid;
    pFrame->for_each_slot_temp (save_slot, slot_info);
 
    return slot_info.is_ok;
}