GNUnet  0.20.0
sq.c File Reference

helper functions for Sqlite3 DB interactions More...

#include "gnunet_common.h"
#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_conndatabase connection
paramsparameters to the statement
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 1 of file sq.c.

33 {
34  unsigned int j;
35 
36  j = 1;
37  for (unsigned int i = 0; NULL != params[i].conv; i++)
38  {
39  if (GNUNET_OK !=
40  params[i].conv (params[i].conv_cls,
41  params[i].data,
42  params[i].size,
43  stmt,
44  j))
45  {
47  "sq",
48  _ ("Failure to bind %u-th SQL parameter\n"),
49  i);
50  if (SQLITE_OK !=
51  sqlite3_reset (stmt))
52  {
54  "sq",
55  _ ("Failure in sqlite3_reset (!)\n"));
56  return GNUNET_SYSERR;
57  }
58  }
59  GNUNET_assert (0 != params[i].num_params);
60  j += params[i].num_params;
61  }
62  return GNUNET_OK;
63 }
static GstElement * conv
uint32_t data
The data value.
#define GNUNET_log_from(kind, comp,...)
@ GNUNET_OK
@ GNUNET_SYSERR
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
@ GNUNET_ERROR_TYPE_WARNING
static unsigned int size
Size of the "table".
Definition: peer.c:68
#define _(String)
GNU gettext support macro.
Definition: platform.h:178
GNUNET_SQ_QueryConverter conv
Function for how to handle this type of entry.
Definition: gnunet_sq_lib.h:60
unsigned int num_params
Number of parameters eaten by this operation.
Definition: gnunet_sq_lib.h:80

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(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), peerstore_sqlite_delete_records(), peerstore_sqlite_expire_records(), peerstore_sqlite_iterate_records(), peerstore_sqlite_store_record(), 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
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 1 of file sq.c.

78 {
79  unsigned int j = 0;
80 
81  for (unsigned int i = 0; NULL != rs[i].conv; i++)
82  {
83  if (NULL == rs[i].result_size)
84  rs[i].result_size = &rs[i].dst_size;
85  if (GNUNET_OK !=
86  rs[i].conv (rs[i].cls,
87  result,
88  j,
89  rs[i].result_size,
90  rs[i].dst))
91  {
92  for (unsigned int k = 0; k < i; k++)
93  if (NULL != rs[k].cleaner)
94  rs[k].cleaner (rs[k].cls);
95  return GNUNET_SYSERR;
96  }
97  GNUNET_assert (0 != rs[i].num_params);
98  j += rs[i].num_params;
99  }
100  return GNUNET_OK;
101 }
static int result
Global testing status.
size_t * result_size
Where to store actual size of the result.
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.
unsigned int num_params
Number of parameters (columns) eaten by this operation.
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...

Referenced by execute_get(), get_any(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), 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
rsreult specification to clean up

Definition at line 105 of file sq.c.

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

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

Referenced by execute_get(), get_any(), get_typed(), namecache_sqlite_lookup_block(), peerstore_sqlite_iterate_records(), 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
dbhdatabase handle
stmtstatement to reset

Definition at line 120 of file sq.c.

122 {
123  if (SQLITE_OK !=
124  sqlite3_reset (stmt))
126  "sqlite",
127  _ ("Failed to reset sqlite statement with error: %s\n"),
128  sqlite3_errmsg (dbh));
129 }
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_BULK

References _, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_ERROR, and GNUNET_log_from.

Referenced by delete_by_rowid(), execute_get(), get_any(), get_typed(), namecache_sqlite_cache_block(), namecache_sqlite_expire_blocks(), namecache_sqlite_lookup_block(), peerstore_sqlite_delete_records(), peerstore_sqlite_expire_records(), peerstore_sqlite_iterate_records(), peerstore_sqlite_store_record(), sqlite_plugin_get_closest(), sqlite_plugin_get_replication(), sqlite_plugin_put(), and sqlite_plugin_remove_key().

Here is the caller graph for this function: