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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @author Christian Grothoff
22 * Helper library to access a MySQL database
24 * @defgroup mysql MySQL library
25 * Helper library to access a MySQL database.
28 #ifndef GNUNET_MYSQL_LIB_H
29 #define GNUNET_MYSQL_LIB_H
31 #include "gnunet_util_lib.h"
32 #include <mysql/mysql.h>
37 #if 0 /* keep Emacsens' auto-indent happy */
46 struct GNUNET_MYSQL_Context;
50 * Handle for a prepared statement.
52 struct GNUNET_MYSQL_StatementHandle;
56 * Type of a callback that will be called for each
57 * data set returned from MySQL.
59 * @param cls user-defined argument
60 * @param num_values number of elements in values
61 * @param values values returned by MySQL
62 * @return #GNUNET_OK to continue iterating, #GNUNET_SYSERR to abort
65 (*GNUNET_MYSQL_DataProcessor) (void *cls,
66 unsigned int num_values,
71 * Create a mysql context.
73 * @param cfg configuration
74 * @param section configuration section to use to get MySQL configuration options
75 * @return the mysql context
77 struct GNUNET_MYSQL_Context *
78 GNUNET_MYSQL_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
83 * Destroy a mysql context. Also frees all associated prepared statements.
85 * @param mc context to destroy
88 GNUNET_MYSQL_context_destroy (struct GNUNET_MYSQL_Context *mc);
92 * Close database connection and all prepared statements (we got a DB
93 * error). The connection will automatically be re-opened and
94 * statements will be re-prepared if they are needed again later.
96 * @param mc mysql context
99 GNUNET_MYSQL_statements_invalidate (struct GNUNET_MYSQL_Context *mc);
103 * Get internal handle for a prepared statement. This function should rarely
104 * be used, and if, with caution! On failures during the interaction with
105 * the handle, you must call #GNUNET_MYSQL_statements_invalidate()!
107 * @param sh prepared statement to introspect
108 * @return MySQL statement handle, NULL on error
111 GNUNET_MYSQL_statement_get_stmt (struct GNUNET_MYSQL_StatementHandle *sh);
115 * Prepare a statement. Prepared statements are automatically discarded
116 * when the MySQL context is destroyed.
118 * @param mc mysql context
119 * @param query query text
120 * @return prepared statement, NULL on error
122 struct GNUNET_MYSQL_StatementHandle *
123 GNUNET_MYSQL_statement_prepare (struct GNUNET_MYSQL_Context *mc,
128 * Run a SQL statement.
130 * @param mc mysql context
131 * @param sql SQL statement to run
132 * @return #GNUNET_OK on success
133 * #GNUNET_SYSERR if there was a problem
136 GNUNET_MYSQL_statement_run (struct GNUNET_MYSQL_Context *mc,
140 #if 0 /* keep Emacsens' auto-indent happy */
149 /** @} */ /* end of group */