2 * Bacula Catalog Database routines specific to SQLite
4 * Kern Sibbald, January 2002
10 Copyright (C) 2002-2005 Kern Sibbald
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /* The following is necessary so that we do not include
31 * the dummy external definition of DB.
33 #define __SQL_C /* indicate that this is sql.c */
38 #if HAVE_SQLITE || HAVE_SQLITE3
40 /* -----------------------------------------------------------------------
42 * SQLite dependent defines and subroutines
44 * -----------------------------------------------------------------------
47 extern const char *working_directory;
49 /* List of open databases */
50 static BQUEUE db_list = {&db_list, &db_list};
52 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
54 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
58 * Initialize database data structure. In principal this should
59 * never have errors, or it is really fatal.
62 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
63 const char *db_address, int db_port, const char *db_socket,
64 int mult_db_connections)
68 P(mutex); /* lock DB queue */
69 /* Look to see if DB already open */
70 if (!mult_db_connections) {
71 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
72 if (strcmp(mdb->db_name, db_name) == 0) {
73 Dmsg2(300, "DB REopen %d %s\n", mdb->ref_count, db_name);
76 return mdb; /* already open */
80 Dmsg0(300, "db_open first time\n");
81 mdb = (B_DB *) malloc(sizeof(B_DB));
82 memset(mdb, 0, sizeof(B_DB));
83 mdb->db_name = bstrdup(db_name);
84 mdb->have_insert_id = TRUE;
85 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
87 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
88 mdb->cached_path = get_pool_memory(PM_FNAME);
89 mdb->cached_path_id = 0;
91 mdb->fname = get_pool_memory(PM_FNAME);
92 mdb->path = get_pool_memory(PM_FNAME);
93 mdb->esc_name = get_pool_memory(PM_FNAME);
94 mdb->allow_transactions = mult_db_connections;
95 qinsert(&db_list, &mdb->bq); /* put db in list */
101 * Now actually open the database. This can generate errors,
102 * which are returned in the errmsg
104 * DO NOT close the database or free(mdb) here !!!!
107 db_open_database(JCR *jcr, B_DB *mdb)
115 if (mdb->connected) {
119 mdb->connected = FALSE;
121 if ((errstat=rwl_init(&mdb->lock)) != 0) {
122 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
128 /* open the database */
129 len = strlen(working_directory) + strlen(mdb->db_name) + 5;
130 db_name = (char *)malloc(len);
131 strcpy(db_name, working_directory);
132 strcat(db_name, "/");
133 strcat(db_name, mdb->db_name);
134 strcat(db_name, ".db");
135 if (stat(db_name, &statbuf) != 0) {
136 Mmsg1(&mdb->errmsg, _("Database %s does not exist, please create it.\n"),
144 int stat = sqlite3_open(db_name, &mdb->db);
145 if (stat != SQLITE_OK) {
146 mdb->sqlite_errmsg = (char *)sqlite3_errmsg(mdb->db);
148 mdb->sqlite_errmsg = NULL;
152 mdb->db = sqlite_open(
153 db_name, /* database name */
155 &mdb->sqlite_errmsg); /* error message */
158 Dmsg0(300, "sqlite_open\n");
160 if (mdb->db == NULL) {
161 Mmsg2(&mdb->errmsg, _("Unable to open Database=%s. ERR=%s\n"),
162 db_name, mdb->sqlite_errmsg ? mdb->sqlite_errmsg : _("unknown"));
168 if (!check_tables_version(jcr, mdb)) {
173 mdb->connected = true;
179 db_close_database(JCR *jcr, B_DB *mdb)
184 db_end_transaction(jcr, mdb);
187 if (mdb->ref_count == 0) {
189 if (mdb->connected && mdb->db) {
190 sqlite_close(mdb->db);
192 rwl_destroy(&mdb->lock);
193 free_pool_memory(mdb->errmsg);
194 free_pool_memory(mdb->cmd);
195 free_pool_memory(mdb->cached_path);
196 free_pool_memory(mdb->fname);
197 free_pool_memory(mdb->path);
198 free_pool_memory(mdb->esc_name);
208 * Return the next unique index (auto-increment) for
209 * the given table. Return 0 on error.
211 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
219 "SELECT id FROM NextId WHERE TableName=\"%s\"", table);
220 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
221 Mmsg(mdb->errmsg, _("next_index query error: ERR=%s\n"), sql_strerror(mdb));
225 if ((row = sql_fetch_row(mdb)) == NULL) {
226 Mmsg(mdb->errmsg, _("Error fetching index: ERR=%s\n"), sql_strerror(mdb));
230 bstrncpy(index, row[0], 28);
231 sql_free_result(mdb);
234 "UPDATE NextId SET id=id+1 WHERE TableName=\"%s\"", table);
235 if (!QUERY_DB(jcr, mdb, mdb->cmd)) {
236 Mmsg(mdb->errmsg, _("next_index update error: ERR=%s\n"), sql_strerror(mdb));
240 sql_free_result(mdb);
244 strcpy(index, "NULL");
250 * Escape strings so that SQLite is happy
252 * NOTE! len is the length of the old string. Your new
253 * string must be long enough (max 2*old+1) to hold
254 * the escaped output.
257 db_escape_string(char *snew, char *old, int len)
284 DB_RESULT_HANDLER *result_handler;
289 * Convert SQLite's callback into Bacula DB callback
291 static int sqlite_result(void *arh_data, int num_fields, char **rows, char **col_names)
293 struct rh_data *rh_data = (struct rh_data *)arh_data;
295 if (rh_data->result_handler) {
296 (*(rh_data->result_handler))(rh_data->ctx, num_fields, rows);
302 * Submit a general SQL command (cmd), and for each row returned,
303 * the sqlite_handler is called with the ctx.
305 int db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
307 struct rh_data rh_data;
311 if (mdb->sqlite_errmsg) {
313 sqlite3_free(mdb->sqlite_errmsg);
315 actuallyfree(mdb->sqlite_errmsg);
317 mdb->sqlite_errmsg = NULL;
319 rh_data.result_handler = result_handler;
321 stat = sqlite_exec(mdb->db, query, sqlite_result, (void *)&rh_data, &mdb->sqlite_errmsg);
323 Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
332 * Submit a sqlite query and retrieve all the data
334 int my_sqlite_query(B_DB *mdb, char *cmd)
338 if (mdb->sqlite_errmsg) {
339 actuallyfree(mdb->sqlite_errmsg);
340 mdb->sqlite_errmsg = NULL;
342 stat = sqlite_get_table(mdb->db, cmd, &mdb->result, &mdb->nrow, &mdb->ncolumn,
343 &mdb->sqlite_errmsg);
344 mdb->row = 0; /* row fetched */
348 /* Fetch one row at a time */
349 SQL_ROW my_sqlite_fetch_row(B_DB *mdb)
351 if (mdb->row >= mdb->nrow) {
355 return &mdb->result[mdb->ncolumn * mdb->row];
358 void my_sqlite_free_table(B_DB *mdb)
362 if (mdb->fields_defined) {
363 for (i=0; i < sql_num_fields(mdb); i++) {
364 free(mdb->fields[i]);
367 mdb->fields_defined = false;
369 sqlite_free_table(mdb->result);
370 mdb->nrow = mdb->ncolumn = 0;
373 void my_sqlite_field_seek(B_DB *mdb, int field)
376 if (mdb->result == NULL) {
379 /* On first call, set up the fields */
380 if (!mdb->fields_defined && sql_num_fields(mdb) > 0) {
381 mdb->fields = (SQL_FIELD **)malloc(sizeof(SQL_FIELD) * mdb->ncolumn);
382 for (i=0; i < sql_num_fields(mdb); i++) {
383 mdb->fields[i] = (SQL_FIELD *)malloc(sizeof(SQL_FIELD));
384 mdb->fields[i]->name = mdb->result[i];
385 mdb->fields[i]->length = cstrlen(mdb->fields[i]->name);
386 mdb->fields[i]->max_length = mdb->fields[i]->length;
387 for (j=1; j <= mdb->nrow; j++) {
389 if (mdb->result[i + mdb->ncolumn *j]) {
390 len = (uint32_t)cstrlen(mdb->result[i + mdb->ncolumn * j]);
394 if (len > mdb->fields[i]->max_length) {
395 mdb->fields[i]->max_length = len;
398 mdb->fields[i]->type = 0;
399 mdb->fields[i]->flags = 1; /* not null */
401 mdb->fields_defined = TRUE;
403 if (field > sql_num_fields(mdb)) {
404 field = sql_num_fields(mdb);
410 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb)
412 return mdb->fields[mdb->field++];
415 #endif /* HAVE_SQLITE */