all: updated FSF address in GPL text
[sip-router] / modules / db_unixodbc / dbase.h
1 /*
2  * $Id$
3  *
4  * UNIXODBC module core functions
5  *
6  * Copyright (C) 2005-2006 Marco Lorrai
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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
24  *
25  *
26  * History:
27  * --------
28  *  2005-12-01  initial commit (chgen)
29  */
30
31
32 #ifndef DBASE_H
33 #define DBASE_H
34
35 #include "../../lib/srdb1/db_con.h"
36 #include "../../lib/srdb1/db_res.h"
37 #include "../../lib/srdb1/db_key.h"
38 #include "../../lib/srdb1/db_op.h"
39 #include "../../lib/srdb1/db_val.h"
40
41 /*
42  * Initialize database connection
43  */
44 db1_con_t* db_unixodbc_init(const str* _sqlurl);
45
46 /*
47  * Close a database connection
48  */
49 void db_unixodbc_close(db1_con_t* _h);
50
51 /*
52  * Free all memory allocated by get_result
53  */
54 int db_unixodbc_free_result(db1_con_t* _h, db1_res_t* _r);
55
56 /*
57  * Do a query
58  */
59 int db_unixodbc_query(const db1_con_t* _h, const db_key_t* _k, const db_op_t* _op, const db_val_t* _v,
60 const db_key_t* _c, const int _n, const int _nc, const db_key_t _o, db1_res_t** _r);
61
62 /*
63  * Fetch rows from a result
64  */
65 int db_unixodbc_fetch_result(const db1_con_t* _h, db1_res_t** _r, const int nrows);
66
67 /*
68  * Raw SQL query
69  */
70 int db_unixodbc_raw_query(const db1_con_t* _h, const str* _s, db1_res_t** _r);
71
72 /*
73  * Insert a row into table
74  */
75 int db_unixodbc_insert(const db1_con_t* _h, const db_key_t* _k, const db_val_t* _v, const int _n);
76
77 /*
78  * Delete a row from table
79  */
80 int db_unixodbc_delete(const db1_con_t* _h, const db_key_t* _k, const db_op_t* _o, const db_val_t* _v,
81 const int _n);
82
83 /*
84  * Update a row in table
85  */
86 int db_unixodbc_update(const db1_con_t* _h, const db_key_t* _k, const db_op_t* _o, const db_val_t* _v,
87 const db_key_t* _uk, const db_val_t* _uv, const int _n, const int _un);
88
89 /*
90  * Just like insert, but replace the row if it exists
91  */
92 int db_unixodbc_replace(const db1_con_t* handle, const db_key_t* keys, const db_val_t* vals,
93                 const int n, const int _un, const int _m);
94
95 /*
96  * Store name of table that will be used by
97  * subsequent database functions
98  */
99 int db_unixodbc_use_table(db1_con_t* _h, const str* _t);
100
101 #endif                                                      /* DBASE_H */