GNUnet  0.10.x
Functions
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

int GNUNET_SQ_bind (sqlite3_stmt *stmt, const struct GNUNET_SQ_QueryParam *params)
 Execute a prepared statement. More...
 
int 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()

int GNUNET_SQ_bind ( sqlite3_stmt *  stmt,
const struct GNUNET_SQ_QueryParam params 
)

Execute a prepared statement.

Execute binding operations for a prepared statement.

Parameters
db_conndatabase connection
paramsparameters to the statement
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 37 of file sq.c.

References _, GNUNET_SQ_QueryParam::conv, 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(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), namestore_sqlite_iterate_records(), namestore_sqlite_lookup_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(), sqlite_plugin_get_closest(), sqlite_plugin_get_expiration(), sqlite_plugin_get_key(), sqlite_plugin_get_random(), sqlite_plugin_get_replication(), sqlite_plugin_get_zero_anonymity(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

39 {
40  unsigned int j;
41 
42  j = 1;
43  for (unsigned int i=0;NULL != params[i].conv; i++)
44  {
45  if (GNUNET_OK !=
46  params[i].conv (params[i].conv_cls,
47  params[i].data,
48  params[i].size,
49  stmt,
50  j))
51  {
53  "sq",
54  _("Failure to bind %u-th SQL parameter\n"),
55  i);
56  if (SQLITE_OK !=
57  sqlite3_reset (stmt))
58  {
60  "sq",
61  _("Failure in sqlite3_reset (!)\n"));
62  return GNUNET_SYSERR;
63  }
64  }
65  GNUNET_assert (0 != params[i].num_params);
66  j += params[i].num_params;
67  }
68  return GNUNET_OK;
69 }
static GstElement * conv
unsigned int num_params
Number of parameters eaten by this operation.
Definition: gnunet_sq_lib.h:80
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
static unsigned int size
Size of the "table".
Definition: peer.c:67
GNUNET_SQ_QueryConverter conv
Function for how to handle this type of entry.
Definition: gnunet_sq_lib.h:60
#define GNUNET_log_from(kind, comp,...)
uint32_t data
The data value.
Here is the caller graph for this function:

◆ GNUNET_SQ_extract_result()

int GNUNET_SQ_extract_result ( sqlite3_stmt *  result,
struct GNUNET_SQ_ResultSpec rs 
)

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

Parameters
resultresult to process
[in,out]rsresult 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 82 of file sq.c.

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, and GNUNET_SQ_ResultSpec::result_size.

Referenced by execute_get(), get_records_and_call_iterator(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), sqlite_plugin_del(), sqlite_plugin_get(), sqlite_plugin_get_closest(), sqlite_plugin_get_keys(), and sqlite_plugin_get_random().

84 {
85  unsigned int j = 0;
86 
87  for (unsigned int i=0;NULL != rs[i].conv; i++)
88  {
89  if (NULL == rs[i].result_size)
90  rs[i].result_size = &rs[i].dst_size;
91  if (GNUNET_OK !=
92  rs[i].conv (rs[i].cls,
93  result,
94  j,
95  rs[i].result_size,
96  rs[i].dst))
97  {
98  for (unsigned int k=0;k<i;k++)
99  if (NULL != rs[k].cleaner)
100  rs[k].cleaner (rs[k].cls);
101  return GNUNET_SYSERR;
102  }
103  GNUNET_assert (0 != rs[i].num_params);
104  j += rs[i].num_params;
105  }
106  return GNUNET_OK;
107 }
static GstElement * conv
GNUNET_SQ_ResultConverter conv
What is the format of the result?
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
GNUNET_SQ_ResultCleanup cleaner
Function to clean up result data, NULL if cleanup is not necessary.
unsigned int num_params
Number of parameters (columns) eaten by this operation.
static int result
Global testing status.
size_t dst_size
Allowed size for the data, 0 for variable-size (in this case, the type of dst is a void ** and we nee...
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
size_t * result_size
Where to store actual size of the result.
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
rsreult specification to clean up

Definition at line 117 of file sq.c.

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

Referenced by execute_get(), get_records_and_call_iterator(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), sqlite_plugin_del(), sqlite_plugin_get(), sqlite_plugin_get_closest(), and sqlite_plugin_get_random().

118 {
119  for (unsigned int i=0;NULL != rs[i].conv; i++)
120  if (NULL != rs[i].cleaner)
121  rs[i].cleaner (rs[i].cls);
122 }
GNUNET_SQ_ResultConverter conv
What is the format of the result?
GNUNET_SQ_ResultCleanup cleaner
Function to clean up result data, NULL if cleanup is not necessary.
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
dbhdatabase handle
stmtstatement to reset

Definition at line 132 of file sq.c.

References _, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_ERROR, and GNUNET_log_from.

Referenced by delete_by_rowid(), execute_get(), get_records_and_call_iterator(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), namestore_sqlite_iterate_records(), namestore_sqlite_lookup_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(), sqlite_plugin_get_closest(), sqlite_plugin_get_random(), sqlite_plugin_get_replication(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

134 {
135  if (SQLITE_OK !=
136  sqlite3_reset (stmt))
138  "sqlite",
139  _("Failed to reset sqlite statement with error: %s\n"),
140  sqlite3_errmsg (dbh));
141 }
#define _(String)
GNU gettext support macro.
Definition: platform.h:208
#define GNUNET_log_from(kind, comp,...)
Here is the caller graph for this function: