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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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_MYSQL_LIB_H
31 #define GNUNET_MYSQL_LIB_H
33 #include "gnunet_util_lib.h"
34 #include <mysql/mysql.h>
39 #if 0 /* keep Emacsens' auto-indent happy */
48 struct GNUNET_MYSQL_Context;
52 * Handle for a prepared statement.
54 struct GNUNET_MYSQL_StatementHandle;
58 * Type of a callback that will be called for each
59 * data set returned from MySQL.
61 * @param cls user-defined argument
62 * @param num_values number of elements in values
63 * @param values values returned by MySQL
64 * @return #GNUNET_OK to continue iterating, #GNUNET_SYSERR to abort
67 (*GNUNET_MYSQL_DataProcessor) (void *cls,
68 unsigned int num_values,
73 * Create a mysql context.
75 * @param cfg configuration
76 * @param section configuration section to use to get MySQL configuration options
77 * @return the mysql context
79 struct GNUNET_MYSQL_Context *
80 GNUNET_MYSQL_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
85 * Destroy a mysql context. Also frees all associated prepared statements.
87 * @param mc context to destroy
90 GNUNET_MYSQL_context_destroy (struct GNUNET_MYSQL_Context *mc);
94 * Close database connection and all prepared statements (we got a DB
95 * error). The connection will automatically be re-opened and
96 * statements will be re-prepared if they are needed again later.
98 * @param mc mysql context
101 GNUNET_MYSQL_statements_invalidate (struct GNUNET_MYSQL_Context *mc);
105 * Get internal handle for a prepared statement. This function should rarely
106 * be used, and if, with caution! On failures during the interaction with
107 * the handle, you must call #GNUNET_MYSQL_statements_invalidate()!
109 * @param sh prepared statement to introspect
110 * @return MySQL statement handle, NULL on error
113 GNUNET_MYSQL_statement_get_stmt (struct GNUNET_MYSQL_StatementHandle *sh);
117 * Prepare a statement. Prepared statements are automatically discarded
118 * when the MySQL context is destroyed.
120 * @param mc mysql context
121 * @param query query text
122 * @return prepared statement, NULL on error
124 struct GNUNET_MYSQL_StatementHandle *
125 GNUNET_MYSQL_statement_prepare (struct GNUNET_MYSQL_Context *mc,
130 * Run a SQL statement.
132 * @param mc mysql context
133 * @param sql SQL statement to run
134 * @return #GNUNET_OK on success
135 * #GNUNET_SYSERR if there was a problem
138 GNUNET_MYSQL_statement_run (struct GNUNET_MYSQL_Context *mc,
142 #if 0 /* keep Emacsens' auto-indent happy */
151 /** @} */ /* end of group */