sq.c File Reference

helper functions for Sqlite3 DB interactions More...

#include "platform.h"
#include "gnunet_sq_lib.h"

Include dependency graph for sq.c:

Go to the source code of this file.

Functions
enum GNUNET_GenericReturnValue	GNUNET_SQ_bind (sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
	Execute binding operations for a prepared statement. More...
enum GNUNET_GenericReturnValue	GNUNET_SQ_extract_result (sqlite3_stmt *result, struct GNUNET_SQ_ResultSpec *rs)
	Extract results from a query result according to the given specification. More...
void	GNUNET_SQ_cleanup_result (struct GNUNET_SQ_ResultSpec *rs)
	Free all memory that was allocated in rs during GNUNET_SQ_extract_result(). More...
void	GNUNET_SQ_reset (sqlite3 *dbh, sqlite3_stmt *stmt)
	Reset stmt and log error. More...

Detailed Description

helper functions for Sqlite3 DB interactions

Author

Christian Grothoff

Definition in file sq.c.

Function Documentation

GNUNET_SQ_bind()

enum GNUNET_GenericReturnValue GNUNET_SQ_bind	(	sqlite3_stmt *	stmt,
		const struct GNUNET_SQ_QueryParam *	params
	)

Execute binding operations for a prepared statement.

Parameters

db_conn	database connection
params	parameters to the statement

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 30 of file sq.c.

{
  unsigned int j;
 
  j = 1;
  for (unsigned int i = 0; NULL != params[i].conv; i++)
  {
    if (GNUNET_OK !=
        params[i].conv (params[i].conv_cls,
                        params[i].data,
                        params[i].size,
                        stmt,
                        j))
    {
      GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
                       "sq",
                       _ ("Failure to bind %u-th SQL parameter\n"),
                       i);
      if (SQLITE_OK !=
          sqlite3_reset (stmt))
      {
        GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
                         "sq",
                         _ ("Failure in sqlite3_reset (!)\n"));
        return GNUNET_SYSERR;
      }
    }
    GNUNET_assert (0 != params[i].num_params);
    j += params[i].num_params;
  }
  return GNUNET_OK;
}

References _, conv, GNUNET_SQ_QueryParam::conv, data, GNUNET_assert, GNUNET_ERROR_TYPE_WARNING, GNUNET_log_from, GNUNET_OK, GNUNET_SYSERR, GNUNET_SQ_QueryParam::num_params, and size.

Referenced by delete_by_rowid(), get_any(), get_typed(), lookup_records(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), namestore_sqlite_editor_hint_clear(), namestore_sqlite_iterate_records(), namestore_sqlite_store_records(), namestore_sqlite_zone_to_name(), peerstore_sqlite_delete_records(), peerstore_sqlite_expire_records(), peerstore_sqlite_iterate_records(), peerstore_sqlite_store_record(), sqlite_plugin_del(), sqlite_plugin_get_closest(), sqlite_plugin_get_expiration(), sqlite_plugin_get_key(), sqlite_plugin_get_replication(), sqlite_plugin_get_zero_anonymity(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

Here is the caller graph for this function:

GNUNET_SQ_extract_result()

enum GNUNET_GenericReturnValue GNUNET_SQ_extract_result	(	sqlite3_stmt *	result,
		struct GNUNET_SQ_ResultSpec *	rs
	)

Extract results from a query result according to the given specification.

Parameters

	result	result to process
[in,out]	rs	result specification to extract for

Returns

GNUNET_OK if all results could be extracted GNUNET_SYSERR if a result was invalid (non-existing field)

Definition at line 75 of file sq.c.

{
  unsigned int j = 0;
 
  for (unsigned int i = 0; NULL != rs[i].conv; i++)
  {
    if (NULL == rs[i].result_size)
      rs[i].result_size = &rs[i].dst_size;
    if (GNUNET_OK !=
        rs[i].conv (rs[i].cls,
                    result,
                    j,
                    rs[i].result_size,
                    rs[i].dst))
    {
      for (unsigned int k = 0; k < i; k++)
        if (NULL != rs[k].cleaner)
          rs[k].cleaner (rs[k].cls);
      return GNUNET_SYSERR;
    }
    GNUNET_assert (0 != rs[i].num_params);
    j += rs[i].num_params;
  }
  return GNUNET_OK;
}

References GNUNET_SQ_ResultSpec::cleaner, conv, GNUNET_SQ_ResultSpec::conv, GNUNET_SQ_ResultSpec::dst_size, GNUNET_assert, GNUNET_OK, GNUNET_SYSERR, GNUNET_SQ_ResultSpec::num_params, result, and GNUNET_SQ_ResultSpec::result_size.

Referenced by execute_get(), get_any(), get_records_and_call_iterator(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), sqlite_plugin_del(), sqlite_plugin_get_closest(), and sqlite_plugin_get_keys().

Here is the caller graph for this function:

GNUNET_SQ_cleanup_result()

void GNUNET_SQ_cleanup_result

(

struct GNUNET_SQ_ResultSpec *

rs

)

Free all memory that was allocated in rs during GNUNET_SQ_extract_result().

Parameters

rs	result specification to clean up

Definition at line 104 of file sq.c.

{
  for (unsigned int i = 0; NULL != rs[i].conv; i++)
    if (NULL != rs[i].cleaner)
      rs[i].cleaner (rs[i].cls);
}

References GNUNET_SQ_ResultSpec::cleaner, and GNUNET_SQ_ResultSpec::conv.

Referenced by execute_get(), get_any(), get_records_and_call_iterator(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), sqlite_plugin_del(), and sqlite_plugin_get_closest().

Here is the caller graph for this function:

GNUNET_SQ_reset()

void GNUNET_SQ_reset	(	sqlite3 *	dbh,
		sqlite3_stmt *	stmt
	)

Reset stmt and log error.

Parameters

dbh	database handle
stmt	statement to reset

Definition at line 119 of file sq.c.

{
  if (SQLITE_OK !=
      sqlite3_reset (stmt))
    GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                     "sqlite",
                     _ ("Failed to reset sqlite statement with error: %s\n"),
                     sqlite3_errmsg (dbh));
}

References _, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_ERROR, and GNUNET_log_from.

Referenced by delete_by_rowid(), execute_get(), get_any(), get_records_and_call_iterator(), get_typed(), lookup_records(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), namestore_sqlite_editor_hint_clear(), namestore_sqlite_iterate_records(), namestore_sqlite_store_records(), namestore_sqlite_zone_to_name(), peerstore_sqlite_delete_records(), peerstore_sqlite_expire_records(), peerstore_sqlite_iterate_records(), peerstore_sqlite_store_record(), sqlite_plugin_del(), sqlite_plugin_get_closest(), sqlite_plugin_get_replication(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

Here is the caller graph for this function: