2 * Bacula Catalog Database interface routines
4 * Almost generic set of SQL database interface routines
5 * (with a little more work)
7 * Kern Sibbald, March 2000
13 Copyright (C) 2000-2003 Kern Sibbald and John Walker
15 This program is free software; you can redistribute it and/or
16 modify it under the terms of the GNU General Public License as
17 published by the Free Software Foundation; either version 2 of
18 the License, or (at your option) any later version.
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 General Public License for more details.
25 You should have received a copy of the GNU General Public
26 License along with this program; if not, write to the Free
27 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 /* The following is necessary so that we do not include
33 * the dummy external definition of B_DB.
35 #define __SQL_C /* indicate that this is sql.c */
40 #if HAVE_MYSQL || HAVE_SQLITE || HAVE_POSTGRESQL
42 uint32_t bacula_db_version = 0;
44 /* Forward referenced subroutines */
45 void print_dashes(B_DB *mdb);
46 void print_result(B_DB *mdb);
49 * Called here to retrieve an integer from the database
51 static int int_handler(void *ctx, int num_fields, char **row)
53 uint32_t *val = (uint32_t *)ctx;
55 Dmsg1(50, "int_handler starts with row pointing at %x\n", row);
58 Dmsg1(50, "int_handler finds '%s'\n", row[0]);
61 Dmsg0(50, "int_handler finds zero\n");
64 Dmsg0(50, "int_handler finishes\n");
70 /* NOTE!!! The following routines expect that the
71 * calling subroutine sets and clears the mutex
74 /* Check that the tables correspond to the version we want */
75 int check_tables_version(JCR *jcr, B_DB *mdb)
77 char *query = "SELECT VersionId FROM Version";
79 bacula_db_version = 0;
80 db_sql_query(mdb, query, int_handler, (void *)&bacula_db_version);
81 if (bacula_db_version != BDB_VERSION) {
82 Mmsg(&mdb->errmsg, "Version error for database \"%s\". Wanted %d, got %d\n",
83 mdb->db_name, BDB_VERSION, bacula_db_version);
84 Jmsg(jcr, M_FATAL, 0, "%s", mdb->errmsg);
90 /* Utility routine for queries. The database MUST be locked before calling here. */
92 QueryDB(char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
95 if ((status=sql_query(mdb, cmd)) != 0) {
96 m_msg(file, line, &mdb->errmsg, _("query %s failed:\n%s\n"), cmd, sql_strerror(mdb));
97 j_msg(file, line, jcr, M_FATAL, 0, "%s", mdb->errmsg);
99 j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
104 mdb->result = sql_store_result(mdb);
106 return mdb->result != NULL;
110 * Utility routine to do inserts
111 * Returns: 0 on failure
115 InsertDB(char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
117 if (sql_query(mdb, cmd)) {
118 m_msg(file, line, &mdb->errmsg, _("insert %s failed:\n%s\n"), cmd, sql_strerror(mdb));
119 j_msg(file, line, jcr, M_FATAL, 0, "%s", mdb->errmsg);
121 j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
125 if (mdb->have_insert_id) {
126 mdb->num_rows = sql_affected_rows(mdb);
130 if (mdb->num_rows != 1) {
132 m_msg(file, line, &mdb->errmsg, _("Insertion problem: affected_rows=%s\n"),
133 edit_uint64(mdb->num_rows, ed1));
135 j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
143 /* Utility routine for updates.
144 * Returns: 0 on failure
148 UpdateDB(char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
151 if (sql_query(mdb, cmd)) {
152 m_msg(file, line, &mdb->errmsg, _("update %s failed:\n%s\n"), cmd, sql_strerror(mdb));
153 j_msg(file, line, jcr, M_ERROR, 0, "%s", mdb->errmsg);
155 j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
159 mdb->num_rows = sql_affected_rows(mdb);
160 if (mdb->num_rows != 1) {
162 m_msg(file, line, &mdb->errmsg, _("Update problem: affected_rows=%s\n"),
163 edit_uint64(mdb->num_rows, ed1));
165 j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
173 /* Utility routine for deletes
175 * Returns: -1 on error
176 * n number of rows affected
179 DeleteDB(char *file, int line, JCR *jcr, B_DB *mdb, char *cmd)
182 if (sql_query(mdb, cmd)) {
183 m_msg(file, line, &mdb->errmsg, _("delete %s failed:\n%s\n"), cmd, sql_strerror(mdb));
184 j_msg(file, line, jcr, M_ERROR, 0, "%s", mdb->errmsg);
186 j_msg(file, line, jcr, M_INFO, 0, "%s\n", cmd);
191 return sql_affected_rows(mdb);
196 * Get record max. Query is already in mdb->cmd
199 * Returns: -1 on failure
202 int get_sql_record_max(JCR *jcr, B_DB *mdb)
207 if (QUERY_DB(jcr, mdb, mdb->cmd)) {
208 if ((row = sql_fetch_row(mdb)) == NULL) {
209 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
214 sql_free_result(mdb);
216 Mmsg1(&mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
222 char *db_strerror(B_DB *mdb)
227 void _db_lock(char *file, int line, B_DB *mdb)
230 if ((errstat=rwl_writelock(&mdb->lock)) != 0) {
231 e_msg(file, line, M_ABORT, 0, "rwl_writelock failure. ERR=%s\n",
236 void _db_unlock(char *file, int line, B_DB *mdb)
239 if ((errstat=rwl_writeunlock(&mdb->lock)) != 0) {
240 e_msg(file, line, M_ABORT, 0, "rwl_writeunlock failure. ERR=%s\n",
246 * Start a transaction. This groups inserts and makes things
247 * much more efficient. Usually started when inserting
250 void db_start_transaction(JCR *jcr, B_DB *mdb)
254 /* Allow only 10,000 changes per transaction */
255 if (mdb->transaction && mdb->changes > 10000) {
256 db_end_transaction(jcr, mdb);
258 if (!mdb->transaction) {
259 my_sqlite_query(mdb, "BEGIN"); /* begin transaction */
260 Dmsg0(400, "Start SQLite transaction\n");
261 mdb->transaction = 1;
268 void db_end_transaction(JCR *jcr, B_DB *mdb)
272 if (mdb->transaction) {
273 my_sqlite_query(mdb, "COMMIT"); /* end transaction */
274 mdb->transaction = 0;
275 Dmsg1(400, "End SQLite transaction changes=%d\n", mdb->changes);
283 * Given a full filename, split it into its path
284 * and filename parts. They are returned in pool memory
285 * in the mdb structure.
287 void split_path_and_filename(JCR *jcr, B_DB *mdb, char *fname)
291 /* Find path without the filename.
292 * I.e. everything after the last / is a "filename".
293 * OK, maybe it is a directory name, but we treat it like
294 * a filename. If we don't find a / then the whole name
295 * must be a path name (e.g. c:).
297 for (p=f=fname; *p; p++) {
299 f = p; /* set pos of last slash */
302 if (*f == '/') { /* did we find a slash? */
303 f++; /* yes, point to filename */
304 } else { /* no, whole thing must be path name */
308 /* If filename doesn't exist (i.e. root directory), we
309 * simply create a blank name consisting of a single
310 * space. This makes handling zero length filenames
315 mdb->fname = check_pool_memory_size(mdb->fname, mdb->fnl+1);
316 memcpy(mdb->fname, f, mdb->fnl); /* copy filename */
317 mdb->fname[mdb->fnl] = 0;
319 mdb->fname[0] = ' '; /* blank filename */
324 mdb->pnl = f - fname;
326 mdb->path = check_pool_memory_size(mdb->path, mdb->pnl+1);
327 memcpy(mdb->path, fname, mdb->pnl);
328 mdb->path[mdb->pnl] = 0;
330 Mmsg1(&mdb->errmsg, _("Path length is zero. File=%s\n"), fname);
331 Jmsg(jcr, M_ERROR, 0, "%s", mdb->errmsg);
337 Dmsg2(100, "sllit path=%s file=%s\n", mdb->path, mdb->fname);
340 #endif /* HAVE_MYSQL || HAVE_SQLITE || HAVE_POSTGRESQL */