2 This file is part of GNUnet
3 Copyright (C) 2012 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @author Christian Grothoff
24 * Helper library to access a MySQL database
26 * @defgroup mysql MySQL library
27 * Helper library to access a MySQL database.
30 #ifndef GNUNET_MY_LIB_H
31 #define GNUNET_MY_LIB_H
33 #include "gnunet_util_lib.h"
34 #include "gnunet_mysql_lib.h"
35 #include <mysql/mysql.h>
40 #if 0 /* keep Emacsens' auto-indent happy */
48 * Information we pass to #GNUNET_MY_exec_prepared() to
49 * initialize the arguments of the prepared statement.
51 struct GNUNET_MY_QueryParam;
55 * Function called to convert input argument into SQL parameters.
58 * @param pq data about the query
59 * @param qbind array of parameters to initialize
63 (*GNUNET_MY_QueryConverter)(void *cls,
64 const struct GNUNET_MY_QueryParam *qp,
69 * Information we pass to #GNUNET_MY_exec_prepared() to
70 * initialize the arguments of the prepared statement.
72 struct GNUNET_MY_QueryParam
76 * Function to call for the type conversion.
78 GNUNET_MY_QueryConverter conv;
81 * Closure for @e conv.
86 * Number of arguments the @a conv converter expects to initialize.
88 unsigned int num_params;
91 * Information to pass to @e conv.
96 * Information to pass to @e conv. Size of @a data.
98 unsigned long data_len;
104 * End of query parameter specification.
106 * @return array last entry for the result specification to use
108 #define GNUNET_MY_query_param_end { NULL, NULL, 0, NULL, 0 }
113 * Generate query parameter for a buffer @a ptr of
116 * @param ptr pointer to the query parameter to pass
117 * @oaran ptr_size number of bytes in @a ptr
119 struct GNUNET_MY_QueryParam
120 GNUNET_MY_query_param_fixed_size (const void *ptr,
125 * Run a prepared SELECT statement.
127 * @param mc mysql context
128 * @param sh handle to SELECT statment
129 * @param params parameters to the statement
133 GNUNET_MY_exec_prepared (struct GNUNET_MYSQL_Context *mc,
134 struct GNUNET_MYSQL_StatementHandle *sh,
135 const struct GNUNET_MY_QueryParam *params);
139 * Information we pass to #GNUNET_MY_extract_result() to
140 * initialize the arguments of the prepared statement.
142 struct GNUNET_MY_ResultParam;
146 * Function called to convert input argument into SQL parameters.
149 * @param pq data about the query
150 * @return -1 on error
153 (*GNUNET_MY_ResultConverter)(void *cls,
154 struct GNUNET_MY_QueryParam *qp,
155 MYSQL_BIND *results);
159 * Information we pass to #GNUNET_MY_extract_result() to
160 * initialize the arguments of the prepared statement.
162 struct GNUNET_MY_ResultSpec
166 * Function to call for the type conversion.
168 GNUNET_MY_ResultConverter conv;
171 * Closure for @e conv.
176 * Destination for the data.
181 * Allowed size for the data, 0 for variable-size
182 * (in this case, the type of @e dst is a `void **`
183 * and we need to allocate a buffer of the right size).
188 * Where to store actual size of the result.
196 * End of result speceter specification.
198 * @return array last entry for the result specification to use
200 #define GNUNET_MY_result_spec_end { NULL, NULL, NULL, 0, NULL }
205 * Obtain fixed size result of @a ptr_size bytes from
206 * MySQL, store in already allocated buffer at @a ptr.
208 * @spec ptr where to write the result
209 * @oaran ptr_size number of bytes available at @a ptr
211 struct GNUNET_MY_ResultSpec
212 GNUNET_MY_result_spec_fixed_size (void *ptr,
217 * We expect a fixed-size result, with size determined by the type of `* dst`
219 * @spec name name of the field in the table
220 * @spec dst point to where to store the result, type fits expected result size
221 * @return array entry for the result specification to use
223 #define GNUNET_MY_result_spec_auto_from_type(dst) GNUNET_MY_result_spec_fixed_size ((dst), sizeof (*(dst)))
230 GNUNET_MY_extract_result (struct GNUNET_MYSQL_Context *mc,
231 struct GNUNET_MYSQL_StatementHandle *stmt,
233 struct GNUNET_MY_ResultSpec *specs);
235 #if 0 /* keep Emacsens' auto-indent happy */
244 /** @} */ /* end of group */