modules: several small doxygen bug fixes
[sip-router] / modules / db_mysql / km_dbase.h
1 /*
2  * $Id$
3  *
4  * MySQL module core functions
5  *
6  * Copyright (C) 2001-2003 FhG Fokus
7  * Copyright (C) 2008 1&1 Internet AG
8  *
9  * This file is part of Kamailio, a free SIP server.
10  *
11  * Kamailio is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version
15  *
16  * Kamailio is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License 
22  * along with this program; if not, write to the Free Software 
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24  */
25
26 /*! \file
27  *  \brief DB_MYSQL :: Core
28  *  \ingroup db_mysql
29  *  Module: \ref db_mysql
30  */
31
32
33
34 #ifndef KM_DBASE_H
35 #define KM_DBASE_H
36
37
38 #include "../../lib/srdb1/db_con.h"
39 #include "../../lib/srdb1/db_res.h"
40 #include "../../lib/srdb1/db_key.h"
41 #include "../../lib/srdb1/db_op.h"
42 #include "../../lib/srdb1/db_val.h"
43 #include "../../str.h"
44
45 /*! \brief
46  * Initialize database connection
47  */
48 db1_con_t* db_mysql_init(const str* _sqlurl);
49
50
51 /*! \brief
52  * Close a database connection
53  */
54 void db_mysql_close(db1_con_t* _h);
55
56
57 /*! \brief
58  * Free all memory allocated by get_result
59  */
60 int db_mysql_free_result(db1_con_t* _h, db1_res_t* _r);
61
62
63 /*! \brief
64  * Do a query
65  */
66 int db_mysql_query(const db1_con_t* _h, const db_key_t* _k, const db_op_t* _op,
67              const db_val_t* _v, const db_key_t* _c, const int _n, const int _nc,
68              const db_key_t _o, db1_res_t** _r);
69
70
71 /*! \brief
72  * fetch rows from a result
73  */
74 int db_mysql_fetch_result(const db1_con_t* _h, db1_res_t** _r, const int nrows);
75
76
77 /*! \brief
78  * Raw SQL query
79  */
80 int db_mysql_raw_query(const db1_con_t* _h, const str* _s, db1_res_t** _r);
81
82
83 /*! \brief
84  * Insert a row into table
85  */
86 int db_mysql_insert(const db1_con_t* _h, const db_key_t* _k, const db_val_t* _v, const int _n);
87
88
89 /*! \brief
90  * Delete a row from table
91  */
92 int db_mysql_delete(const db1_con_t* _h, const db_key_t* _k, const 
93         db_op_t* _o, const db_val_t* _v, const int _n);
94
95
96 /*! \brief
97  * Update a row in table
98  */
99 int db_mysql_update(const db1_con_t* _h, const db_key_t* _k, const db_op_t* _o,
100         const db_val_t* _v, const db_key_t* _uk, const db_val_t* _uv, const int _n,
101         const int _un);
102
103
104 /*! \brief
105  * Just like insert, but replace the row if it exists
106  */
107 int db_mysql_replace(const db1_con_t* handle, const db_key_t* keys, const db_val_t* vals, const int n);
108
109 /*! \brief
110  * Returns the last inserted ID
111  */
112 int db_mysql_last_inserted_id(const db1_con_t* _h);
113
114
115 /*! \brief
116  * Returns number of affected rows for last query
117  */
118 int db_mysql_affected_rows(const db1_con_t* _h);
119
120
121 /*! \brief
122  * Insert a row into table, update on duplicate key
123  */
124 int db_mysql_insert_update(const db1_con_t* _h, const db_key_t* _k, const db_val_t* _v,
125         const int _n);
126
127
128 /*! \brief
129  * Insert a row into table
130  */
131 int db_mysql_insert_delayed(const db1_con_t* _h, const db_key_t* _k,
132                 const db_val_t* _v, const int _n);
133
134
135 /*! \brief
136  * Store name of table that will be used by
137  * subsequent database functions
138  */
139 int db_mysql_use_table(db1_con_t* _h, const str* _t);
140
141
142 /**
143  * Allocate a buffer for database module
144  * No function should be called before this
145  * \return zero on success, negative value on failure
146  */
147 int db_mysql_alloc_buffer(void);
148
149 #endif /* KM_DBASE_H */