2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
33 * Anyone who accesses the database will need to include
36 * This file contains definitions common to sql.c and
37 * the external world, and definitions destined only
38 * for the external world. This is control with
39 * the define __SQL_C, which is defined only in sql.c
45 Here is how database versions work.
47 While I am working on a new release with database changes, the
48 update scripts are in the src/cats directory under the names
49 update_xxx_tables.in. Most of the time, I make database updates
50 in one go and immediately update the version, but not always. If
51 there are going to be several updates as is the case with version
52 1.37, then I will often forgo changing the version until the last
53 update otherwise I will end up with too many versions and a lot
56 When I am pretty sure there will be no more updates, I will
57 change the version from 8 to 9 (in the present case), and when I
58 am 100% sure there will be no more changes, the update script
59 will be copied to the updatedb directory with the correct name
60 (in the present case 8 to 9).
62 Now, in principle, each of the different DB implementations
63 can have a different version, but in practice they are all
64 the same (simplifies things). The exception is the internal
65 database, which is no longer used, and hence, no longer changes.
74 SQL_TYPE_POSTGRESQL = 1,
80 typedef void (DB_LIST_HANDLER)(void *, const char *);
81 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
83 #define db_lock(mdb) _db_lock(__FILE__, __LINE__, mdb)
84 #define db_unlock(mdb) _db_unlock(__FILE__, __LINE__, mdb)
88 #if defined(BUILDING_CATS)
90 #error "SQLite2 is now deprecated, use SQLite3 instead."
92 #define BDB_VERSION 11
96 /* Define opaque structure for sqlite */
101 #define IS_NUM(x) ((x) == 1)
102 #define IS_NOT_NULL(x) ((x) == 1)
104 typedef struct s_sql_field {
105 char *name; /* name of column */
106 int length; /* length */
107 int max_length; /* max length */
108 uint32_t type; /* type */
109 uint32_t flags; /* flags */
113 * This is the "real" definition that should only be
114 * used inside sql.c and associated database interface
119 BQUEUE bq; /* queue control */
120 brwlock_t lock; /* transaction lock */
124 int nrow; /* nrow returned from sqlite */
125 int ncolumn; /* ncolum returned from sqlite */
126 int num_rows; /* used by code */
127 int row; /* seek row */
128 int field; /* seek field */
129 SQL_FIELD **fields; /* defined fields */
133 char *db_address; /* host name address */
134 char *db_socket; /* socket for local access */
136 int db_port; /* port for host name address */
137 bool connected; /* connection made to db */
138 bool have_insert_id; /* do not have insert id */
139 bool fields_defined; /* set when fields defined */
140 char *sqlite_errmsg; /* error message returned by sqlite */
141 POOLMEM *errmsg; /* nicely edited error message */
142 POOLMEM *cmd; /* SQL command string */
143 POOLMEM *cached_path; /* cached path name */
144 int cached_path_len; /* length of cached path */
145 uint32_t cached_path_id; /* cached path id */
146 bool allow_transactions; /* transactions allowed */
147 bool transaction; /* transaction started */
148 int changes; /* changes during transaction */
149 POOLMEM *fname; /* Filename only */
150 POOLMEM *path; /* Path only */
151 POOLMEM *esc_name; /* Escaped file name */
152 POOLMEM *esc_path; /* Escaped path name */
153 int fnl; /* file name length */
154 int pnl; /* path name length */
159 * "Generic" names for easier conversion
163 #define sql_store_result(x) (x)->result
164 #define sql_free_result(x) my_sqlite_free_table(x)
165 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
166 #define sql_query(x, y) my_sqlite_query((x), (y))
168 #define sql_insert_id(x,y) sqlite3_last_insert_rowid((x)->db)
169 #define sql_close(x) sqlite3_close((x)->db)
170 #define sql_affected_rows(x) sqlite3_changes((x)->db)
172 #define sql_insert_id(x,y) sqlite_last_insert_rowid((x)->db)
173 #define sql_close(x) sqlite_close((x)->db)
174 #define sql_affected_rows(x) 1
176 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
177 #define sql_num_rows(x) (x)->nrow
178 #define sql_data_seek(x, i) (x)->row = (i)
179 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
180 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
181 #define sql_num_fields(x) ((x)->ncolumn)
182 #define SQL_ROW char**
183 #define SQL_MATCH "MATCH"
185 #define sql_batch_start(x,y) my_batch_start(x,y)
186 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
187 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
188 #define sql_batch_lock_path_query my_sqlite_batch_lock_query
189 #define sql_batch_lock_filename_query my_sqlite_batch_lock_query
190 #define sql_batch_unlock_tables_query my_sqlite_batch_unlock_query
191 #define sql_batch_fill_filename_query my_sqlite_batch_fill_filename_query
192 #define sql_batch_fill_path_query my_sqlite_batch_fill_path_query
194 /* In cats/sqlite.c */
195 void my_sqlite_free_table(B_DB *mdb);
196 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
197 int my_sqlite_query(B_DB *mdb, const char *cmd);
198 void my_sqlite_field_seek(B_DB *mdb, int field);
199 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
200 extern const char* my_sqlite_batch_lock_query;
201 extern const char* my_sqlite_batch_unlock_query;
202 extern const char* my_sqlite_batch_fill_filename_query;
203 extern const char* my_sqlite_batch_fill_path_query;
214 #define BDB_VERSION 11
218 /* Define opaque structure for sqlite */
223 #define IS_NUM(x) ((x) == 1)
224 #define IS_NOT_NULL(x) ((x) == 1)
226 typedef struct s_sql_field {
227 char *name; /* name of column */
228 int length; /* length */
229 int max_length; /* max length */
230 uint32_t type; /* type */
231 uint32_t flags; /* flags */
235 * This is the "real" definition that should only be
236 * used inside sql.c and associated database interface
241 BQUEUE bq; /* queue control */
242 brwlock_t lock; /* transaction lock */
246 int nrow; /* nrow returned from sqlite */
247 int ncolumn; /* ncolum returned from sqlite */
248 int num_rows; /* used by code */
249 int row; /* seek row */
250 int field; /* seek field */
251 SQL_FIELD **fields; /* defined fields */
255 char *db_address; /* host name address */
256 char *db_socket; /* socket for local access */
258 int db_port; /* port for host name address */
259 bool connected; /* connection made to db */
260 bool have_insert_id; /* do not have insert id */
261 bool fields_defined; /* set when fields defined */
262 char *sqlite_errmsg; /* error message returned by sqlite */
263 POOLMEM *errmsg; /* nicely edited error message */
264 POOLMEM *cmd; /* SQL command string */
265 POOLMEM *cached_path; /* cached path name */
266 int cached_path_len; /* length of cached path */
267 uint32_t cached_path_id; /* cached path id */
268 bool allow_transactions; /* transactions allowed */
269 bool transaction; /* transaction started */
270 int changes; /* changes during transaction */
271 POOLMEM *fname; /* Filename only */
272 POOLMEM *path; /* Path only */
273 POOLMEM *esc_name; /* Escaped file name */
274 POOLMEM *esc_path; /* Escaped path name */
275 int fnl; /* file name length */
276 int pnl; /* path name length */
280 * Conversion of sqlite 2 names to sqlite3
282 #define sqlite_last_insert_rowid sqlite3_last_insert_rowid
283 #define sqlite_open sqlite3_open
284 #define sqlite_close sqlite3_close
285 #define sqlite_result sqlite3_result
286 #define sqlite_exec sqlite3_exec
287 #define sqlite_get_table sqlite3_get_table
288 #define sqlite_free_table sqlite3_free_table
292 * "Generic" names for easier conversion
296 #define sql_store_result(x) (x)->result
297 #define sql_free_result(x) my_sqlite_free_table(x)
298 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
299 #define sql_query(x, y) my_sqlite_query((x), (y))
301 #define sql_insert_id(x,y) sqlite3_last_insert_rowid((x)->db)
302 #define sql_close(x) sqlite3_close((x)->db)
304 #define sql_insert_id(x,y) sqlite_last_insert_rowid((x)->db)
305 #define sql_close(x) sqlite_close((x)->db)
307 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
308 #define sql_num_rows(x) (x)->nrow
309 #define sql_data_seek(x, i) (x)->row = (i)
310 #define sql_affected_rows(x) sqlite3_changes((x)->db)
311 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
312 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
313 #define sql_num_fields(x) ((x)->ncolumn)
314 #define sql_batch_start(x,y) my_batch_start(x,y)
315 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
316 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
317 #define SQL_ROW char**
318 #define SQL_MATCH "MATCH"
319 #define sql_batch_lock_path_query my_sqlite_batch_lock_query
320 #define sql_batch_lock_filename_query my_sqlite_batch_lock_query
321 #define sql_batch_unlock_tables_query my_sqlite_batch_unlock_query
322 #define sql_batch_fill_filename_query my_sqlite_batch_fill_filename_query
323 #define sql_batch_fill_path_query my_sqlite_batch_fill_path_query
325 /* In cats/sqlite.c */
326 void my_sqlite_free_table(B_DB *mdb);
327 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
328 int my_sqlite_query(B_DB *mdb, const char *cmd);
329 void my_sqlite_field_seek(B_DB *mdb, int field);
330 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
331 extern const char* my_sqlite_batch_lock_query;
332 extern const char* my_sqlite_batch_unlock_query;
333 extern const char* my_sqlite_batch_fill_filename_query;
334 extern const char* my_sqlite_batch_fill_path_query;
341 #define BDB_VERSION 11
346 * This is the "real" definition that should only be
347 * used inside sql.c and associated database interface
353 BQUEUE bq; /* queue control */
354 brwlock_t lock; /* transaction lock */
359 my_ulonglong num_rows;
364 char *db_address; /* host address */
365 char *db_socket; /* socket for local access */
366 int db_port; /* port of host address */
367 int have_insert_id; /* do have insert_id() */
369 POOLMEM *errmsg; /* nicely edited error message */
370 POOLMEM *cmd; /* SQL command string */
371 POOLMEM *cached_path;
372 int cached_path_len; /* length of cached path */
373 uint32_t cached_path_id;
374 bool allow_transactions; /* transactions allowed */
375 int changes; /* changes made to db */
376 POOLMEM *fname; /* Filename only */
377 POOLMEM *path; /* Path only */
378 POOLMEM *esc_name; /* Escaped file name */
379 POOLMEM *esc_path; /* Escaped path name */
380 int fnl; /* file name length */
381 int pnl; /* path name length */
384 #define DB_STATUS int
386 /* "Generic" names for easier conversion */
387 #define sql_store_result(x) mysql_store_result((x)->db)
388 #define sql_use_result(x) mysql_use_result((x)->db)
389 #define sql_free_result(x) my_mysql_free_result(x)
390 #define sql_fetch_row(x) mysql_fetch_row((x)->result)
391 #define sql_query(x, y) mysql_query((x)->db, (y))
392 #define sql_strerror(x) mysql_error((x)->db)
393 #define sql_num_rows(x) mysql_num_rows((x)->result)
394 #define sql_data_seek(x, i) mysql_data_seek((x)->result, (i))
395 #define sql_affected_rows(x) mysql_affected_rows((x)->db)
396 #define sql_insert_id(x,y) mysql_insert_id((x)->db)
397 #define sql_field_seek(x, y) mysql_field_seek((x)->result, (y))
398 #define sql_fetch_field(x) mysql_fetch_field((x)->result)
399 #define sql_num_fields(x) (int)mysql_num_fields((x)->result)
400 #define SQL_ROW MYSQL_ROW
401 #define SQL_FIELD MYSQL_FIELD
402 #define SQL_MATCH "MATCH"
404 #define sql_batch_start(x,y) my_batch_start(x,y)
405 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
406 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
407 #define sql_batch_lock_path_query my_mysql_batch_lock_path_query
408 #define sql_batch_lock_filename_query my_mysql_batch_lock_filename_query
409 #define sql_batch_unlock_tables_query my_mysql_batch_unlock_tables_query
410 #define sql_batch_fill_filename_query my_mysql_batch_fill_filename_query
411 #define sql_batch_fill_path_query my_mysql_batch_fill_path_query
414 extern const char* my_mysql_batch_lock_path_query;
415 extern const char* my_mysql_batch_lock_filename_query;
416 extern const char* my_mysql_batch_unlock_tables_query;
417 extern const char* my_mysql_batch_fill_filename_query;
418 extern const char* my_mysql_batch_fill_path_query;
419 extern void my_mysql_free_result(B_DB *mdb);
423 #ifdef HAVE_POSTGRESQL
425 #define BDB_VERSION 11
427 #include <libpq-fe.h>
429 /* TEMP: the following is taken from select OID, typname from pg_type; */
430 #define IS_NUM(x) ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
431 #define IS_NOT_NULL(x) ((x) == 1)
433 typedef char **POSTGRESQL_ROW;
434 typedef struct pg_field {
438 unsigned int flags; // 1 == not null
443 * This is the "real" definition that should only be
444 * used inside sql.c and associated database interface
447 * P O S T G R E S Q L
450 BQUEUE bq; /* queue control */
451 brwlock_t lock; /* transaction lock */
456 POSTGRESQL_FIELD *fields;
458 int row_size; /* size of malloced rows */
460 int fields_size; /* size of malloced fields */
461 int row_number; /* row number from my_postgresql_data_seek */
462 int field_number; /* field number from my_postgresql_field_seek */
467 char *db_address; /* host address */
468 char *db_socket; /* socket for local access */
469 int db_port; /* port of host address */
470 int have_insert_id; /* do have insert_id() */
472 POOLMEM *errmsg; /* nicely edited error message */
473 POOLMEM *cmd; /* SQL command string */
474 POOLMEM *cached_path;
475 int cached_path_len; /* length of cached path */
476 uint32_t cached_path_id;
477 bool allow_transactions; /* transactions allowed */
478 bool transaction; /* transaction started */
479 int changes; /* changes made to db */
480 POOLMEM *fname; /* Filename only */
481 POOLMEM *path; /* Path only */
482 POOLMEM *esc_name; /* Escaped file name */
483 POOLMEM *esc_path; /* Escaped path name */
484 int fnl; /* file name length */
485 int pnl; /* path name length */
488 void my_postgresql_free_result(B_DB *mdb);
489 POSTGRESQL_ROW my_postgresql_fetch_row (B_DB *mdb);
490 int my_postgresql_query (B_DB *mdb, const char *query);
491 void my_postgresql_data_seek (B_DB *mdb, int row);
492 int my_postgresql_currval (B_DB *mdb, const char *table_name);
493 void my_postgresql_field_seek (B_DB *mdb, int row);
494 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
496 int my_postgresql_batch_start(JCR *jcr, B_DB *mdb);
497 int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error);
498 typedef struct ATTR_DBR ATTR_DBR;
499 int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
500 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
502 extern const char* my_pg_batch_lock_path_query;
503 extern const char* my_pg_batch_lock_filename_query;
504 extern const char* my_pg_batch_unlock_tables_query;
505 extern const char* my_pg_batch_fill_filename_query;
506 extern const char* my_pg_batch_fill_path_query;
508 /* "Generic" names for easier conversion */
509 #define sql_store_result(x) ((x)->result)
510 #define sql_free_result(x) my_postgresql_free_result(x)
511 #define sql_fetch_row(x) my_postgresql_fetch_row(x)
512 #define sql_query(x, y) my_postgresql_query((x), (y))
513 #define sql_close(x) PQfinish((x)->db)
514 #define sql_strerror(x) PQerrorMessage((x)->db)
515 #define sql_num_rows(x) ((unsigned) PQntuples((x)->result))
516 #define sql_data_seek(x, i) my_postgresql_data_seek((x), (i))
517 #define sql_affected_rows(x) ((unsigned) atoi(PQcmdTuples((x)->result)))
518 #define sql_insert_id(x,y) my_postgresql_currval((x), (y))
519 #define sql_field_seek(x, y) my_postgresql_field_seek((x), (y))
520 #define sql_fetch_field(x) my_postgresql_fetch_field(x)
521 #define sql_num_fields(x) ((x)->num_fields)
523 #define sql_batch_start(x,y) my_postgresql_batch_start(x,y)
524 #define sql_batch_end(x,y,z) my_postgresql_batch_end(x,y,z)
525 #define sql_batch_insert(x,y,z) my_postgresql_batch_insert(x,y,z)
526 #define sql_batch_lock_path_query my_pg_batch_lock_path_query
527 #define sql_batch_lock_filename_query my_pg_batch_lock_filename_query
528 #define sql_batch_unlock_tables_query my_pg_batch_unlock_tables_query
529 #define sql_batch_fill_filename_query my_pg_batch_fill_filename_query
530 #define sql_batch_fill_path_query my_pg_batch_fill_path_query
532 #define SQL_ROW POSTGRESQL_ROW
533 #define SQL_FIELD POSTGRESQL_FIELD
534 #define SQL_MATCH "~"
540 #define BDB_VERSION 11
544 #ifdef HAVE_BATCH_FILE_INSERT
545 #include <dbi/dbi-dev.h>
546 #endif //HAVE_BATCH_FILE_INSERT
548 #define IS_NUM(x) ((x) == 1 || (x) == 2 )
549 #define IS_NOT_NULL(x) ((x) == (1 << 0))
551 typedef char **DBI_ROW;
552 typedef struct dbi_field {
556 unsigned int flags; // 1 == not null
559 typedef struct dbi_field_get {
565 * This is the "real" definition that should only be
566 * used inside sql.c and associated database interface
572 BQUEUE bq; /* queue control */
573 brwlock_t lock; /* transaction lock */
577 dbi_error_flag status;
580 DBI_FIELD_GET *field_get;
582 int row_size; /* size of malloced rows */
584 int fields_size; /* size of malloced fields */
585 int row_number; /* row number from my_postgresql_data_seek */
586 int field_number; /* field number from my_postgresql_field_seek */
588 int db_type; /* DBI driver defined */
589 char *db_driverdir ; /* DBI driver dir */
590 char *db_driver; /* DBI type database */
594 char *db_address; /* host address */
595 char *db_socket; /* socket for local access */
596 int db_port; /* port of host address */
597 int have_insert_id; /* do have insert_id() */
599 POOLMEM *errmsg; /* nicely edited error message */
600 POOLMEM *cmd; /* SQL command string */
601 POOLMEM *cached_path;
602 int cached_path_len; /* length of cached path */
603 uint32_t cached_path_id;
604 bool allow_transactions; /* transactions allowed */
605 bool transaction; /* transaction started */
606 int changes; /* changes made to db */
607 POOLMEM *fname; /* Filename only */
608 POOLMEM *path; /* Path only */
609 POOLMEM *esc_name; /* Escaped file name */
610 POOLMEM *esc_path; /* Escaped path name */
611 int fnl; /* file name length */
612 int pnl; /* path name length */
615 void my_dbi_free_result(B_DB *mdb);
616 DBI_ROW my_dbi_fetch_row (B_DB *mdb);
617 int my_dbi_query (B_DB *mdb, const char *query);
618 void my_dbi_data_seek (B_DB *mdb, int row);
619 void my_dbi_field_seek (B_DB *mdb, int row);
620 DBI_FIELD * my_dbi_fetch_field(B_DB *mdb);
621 const char * my_dbi_strerror (B_DB *mdb);
622 int my_dbi_getisnull (dbi_result *result, int row_number, int column_number);
623 char * my_dbi_getvalue (dbi_result *result, int row_number, unsigned int column_number);
624 //int my_dbi_getvalue (dbi_result *result, int row_number, unsigned int column_number, char *value);
625 int my_dbi_sql_insert_id(B_DB *mdb, char *table_name);
627 int my_dbi_batch_start(JCR *jcr, B_DB *mdb);
628 int my_dbi_batch_end(JCR *jcr, B_DB *mdb, const char *error);
629 typedef struct ATTR_DBR ATTR_DBR;
630 int my_dbi_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
631 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
632 // typedefs for libdbi work with postgresql copy insert
633 typedef int (*custom_function_insert_t)(void*, const char*, int);
634 typedef char* (*custom_function_error_t)(void*);
635 typedef int (*custom_function_end_t)(void*, const char*);
637 extern const char* my_dbi_batch_lock_path_query[4];
638 extern const char* my_dbi_batch_lock_filename_query[4];
639 extern const char* my_dbi_batch_unlock_tables_query[4];
640 extern const char* my_dbi_batch_fill_filename_query[4];
641 extern const char* my_dbi_batch_fill_path_query[4];
642 extern const char* my_dbi_match[4];
644 /* "Generic" names for easier conversion */
645 #define sql_store_result(x) (x)->result
646 #define sql_free_result(x) my_dbi_free_result(x)
647 #define sql_fetch_row(x) my_dbi_fetch_row(x)
648 #define sql_query(x, y) my_dbi_query((x), (y))
649 #define sql_close(x) dbi_conn_close((x)->db)
650 #define sql_strerror(x) my_dbi_strerror(x)
651 #define sql_num_rows(x) dbi_result_get_numrows((x)->result)
652 #define sql_data_seek(x, i) my_dbi_data_seek((x), (i))
653 #define SQL_MATCH my_dbi_match[db_type]
654 /* #define sql_affected_rows(x) dbi_result_get_numrows_affected((x)->result) */
655 #define sql_affected_rows(x) 1
656 #define sql_insert_id(x,y) my_dbi_sql_insert_id((x), (y))
657 #define sql_field_seek(x, y) my_dbi_field_seek((x), (y))
658 #define sql_fetch_field(x) my_dbi_fetch_field(x)
659 #define sql_num_fields(x) ((x)->num_fields)
660 #define sql_batch_start(x,y) my_dbi_batch_start(x,y)
661 #define sql_batch_end(x,y,z) my_dbi_batch_end(x,y,z)
662 #define sql_batch_insert(x,y,z) my_dbi_batch_insert(x,y,z)
663 #define sql_batch_lock_path_query my_dbi_batch_lock_path_query[db_type]
664 #define sql_batch_lock_filename_query my_dbi_batch_lock_filename_query[db_type]
665 #define sql_batch_unlock_tables_query my_dbi_batch_unlock_tables_query[db_type]
666 #define sql_batch_fill_filename_query my_dbi_batch_fill_filename_query[db_type]
667 #define sql_batch_fill_path_query my_dbi_batch_fill_path_query[db_type]
669 #define SQL_ROW DBI_ROW
670 #define SQL_FIELD DBI_FIELD
673 #else /* USE BACULA DB routines */
675 #define HAVE_BACULA_DB 1
677 /* Change this each time there is some incompatible
678 * file format change!!!!
680 #define BDB_VERSION 13 /* file version number */
683 int bdb_version; /* Version number */
684 uint32_t JobId; /* next Job Id */
685 uint32_t PoolId; /* next Pool Id */
686 uint32_t MediaId; /* next Media Id */
687 uint32_t JobMediaId; /* next JobMedia Id */
688 uint32_t ClientId; /* next Client Id */
689 uint32_t FileSetId; /* nest FileSet Id */
690 time_t time; /* time file written */
694 /* This is the REAL definition for using the
698 BQUEUE bq; /* queue control */
699 /* pthread_mutex_t mutex; */ /* single thread lock */
700 brwlock_t lock; /* transaction lock */
701 int ref_count; /* number of times opened */
702 struct s_control control; /* control file structure */
703 int cfd; /* control file device */
704 FILE *jobfd; /* Jobs records file descriptor */
705 FILE *poolfd; /* Pool records fd */
706 FILE *mediafd; /* Media records fd */
707 FILE *jobmediafd; /* JobMedia records fd */
708 FILE *clientfd; /* Client records fd */
709 FILE *filesetfd; /* FileSet records fd */
710 char *db_name; /* name of database */
711 POOLMEM *errmsg; /* nicely edited error message */
712 POOLMEM *cmd; /* Command string */
713 POOLMEM *cached_path;
714 int cached_path_len; /* length of cached path */
715 uint32_t cached_path_id;
718 #endif /* HAVE_SQLITE3 */
719 #endif /* HAVE_MYSQL */
720 #endif /* HAVE_SQLITE */
721 #endif /* HAVE_POSTGRESQL */
722 #endif /* HAVE_DBI */
725 /* Use for better error location printing */
726 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
727 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
728 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
729 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
732 #else /* not __SQL_C */
734 /* This is a "dummy" definition for use outside of sql.c
737 int dummy; /* for SunOS compiler */
742 /* ==============================================================
744 * What follows are definitions that are used "globally" for all
745 * the different SQL engines and both inside and external to the
749 extern uint32_t bacula_db_version;
754 * Structure used when calling db_get_query_ids()
755 * allows the subroutine to return a list of ids.
757 class dbid_list : public SMARTALLOC {
759 DBId_t *DBId; /* array of DBIds */
760 char *PurgedFiles; /* Array of PurgedFile flags */
761 int num_ids; /* num of ids actually stored */
762 int max_ids; /* size of id array */
763 int num_seen; /* number of ids processed */
764 int tot_ids; /* total to process */
766 dbid_list(); /* in sql.c */
767 ~dbid_list(); /* in sql.c */
773 /* Job information passed to create job record and update
774 * job record at end of job. Note, although this record
775 * contains all the fields found in the Job database record,
776 * it also contains fields found in the JobMedia record.
781 char Job[MAX_NAME_LENGTH]; /* Job unique name */
782 char Name[MAX_NAME_LENGTH]; /* Job base name */
783 int JobType; /* actually char(1) */
784 int JobLevel; /* actually char(1) */
785 int JobStatus; /* actually char(1) */
786 DBId_t ClientId; /* Id of client */
787 DBId_t PoolId; /* Id of pool */
788 DBId_t FileSetId; /* Id of FileSet */
789 DBId_t PriorJobId; /* Id of migrated (prior) job */
790 time_t SchedTime; /* Time job scheduled */
791 time_t StartTime; /* Job start time */
792 time_t EndTime; /* Job termination time of orig job */
793 time_t RealEndTime; /* Job termination time of this job */
794 utime_t JobTDate; /* Backup time/date in seconds */
795 uint32_t VolSessionId;
796 uint32_t VolSessionTime;
799 uint32_t JobMissingFiles;
805 /* Note, FirstIndex, LastIndex, Start/End File and Block
806 * are only used in the JobMedia record.
808 uint32_t FirstIndex; /* First index this Volume */
809 uint32_t LastIndex; /* Last index this Volume */
815 char cSchedTime[MAX_TIME_LENGTH];
816 char cStartTime[MAX_TIME_LENGTH];
817 char cEndTime[MAX_TIME_LENGTH];
818 char cRealEndTime[MAX_TIME_LENGTH];
819 /* Extra stuff not in DB */
820 int limit; /* limit records to display */
822 uint32_t FileIndex; /* added during Verify */
825 /* Job Media information used to create the media records
826 * for each Volume used for the job.
828 /* JobMedia record */
829 struct JOBMEDIA_DBR {
830 DBId_t JobMediaId; /* record id */
831 JobId_t JobId; /* JobId */
832 DBId_t MediaId; /* MediaId */
833 uint32_t FirstIndex; /* First index this Volume */
834 uint32_t LastIndex; /* Last index this Volume */
835 uint32_t StartFile; /* File for start of data */
836 uint32_t EndFile; /* End file on Volume */
837 uint32_t StartBlock; /* start block on tape */
838 uint32_t EndBlock; /* last block */
839 // uint32_t Copy; /* identical copy */
843 /* Volume Parameter structure */
845 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
846 char MediaType[MAX_NAME_LENGTH]; /* Media Type */
847 char Storage[MAX_NAME_LENGTH]; /* Storage name */
848 uint32_t VolIndex; /* Volume seqence no. */
849 uint32_t FirstIndex; /* First index this Volume */
850 uint32_t LastIndex; /* Last index this Volume */
851 int32_t Slot; /* Slot */
852 uint64_t StartAddr; /* Start address */
853 uint64_t EndAddr; /* End address */
854 int32_t InChanger; /* InChanger flag */
855 // uint32_t Copy; /* identical copy */
856 // uint32_t Stripe; /* RAIT strip number */
860 /* Attributes record -- NOT same as in database because
861 * in general, this "record" creates multiple database
862 * records (e.g. pathname, filename, fileattributes).
865 char *fname; /* full path & filename */
866 char *link; /* link if any */
867 char *attr; /* attributes statp */
881 /* File record -- same format as database */
890 char Digest[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
891 int DigestType; /* NO_SIG/MD5_SIG/SHA1_SIG */
894 /* Pool record -- same format as database */
897 char Name[MAX_NAME_LENGTH]; /* Pool name */
898 uint32_t NumVols; /* total number of volumes */
899 uint32_t MaxVols; /* max allowed volumes */
900 int32_t LabelType; /* Bacula/ANSI/IBM */
901 int32_t UseOnce; /* set to use once only */
902 int32_t UseCatalog; /* set to use catalog */
903 int32_t AcceptAnyVolume; /* set to accept any volume sequence */
904 int32_t AutoPrune; /* set to prune automatically */
905 int32_t Recycle; /* default Vol recycle flag */
906 uint32_t ActionOnPurge; /* action on purge, e.g. truncate the disk volume */
907 utime_t VolRetention; /* retention period in seconds */
908 utime_t VolUseDuration; /* time in secs volume can be used */
909 uint32_t MaxVolJobs; /* Max Jobs on Volume */
910 uint32_t MaxVolFiles; /* Max files on Volume */
911 uint64_t MaxVolBytes; /* Max bytes on Volume */
912 DBId_t RecyclePoolId; /* RecyclePool destination when media is purged */
913 DBId_t ScratchPoolId; /* ScratchPool source when media is needed */
914 char PoolType[MAX_NAME_LENGTH];
915 char LabelFormat[MAX_NAME_LENGTH];
916 /* Extra stuff not in DB */
923 char Name[MAX_NAME_LENGTH]; /* Device name */
924 DBId_t MediaTypeId; /* MediaType */
925 DBId_t StorageId; /* Storage id if autochanger */
926 uint32_t DevMounts; /* Number of times mounted */
927 uint32_t DevErrors; /* Number of read/write errors */
928 uint64_t DevReadBytes; /* Number of bytes read */
929 uint64_t DevWriteBytes; /* Number of bytew written */
930 uint64_t DevReadTime; /* time spent reading volume */
931 uint64_t DevWriteTime; /* time spent writing volume */
932 uint64_t DevReadTimeSincCleaning; /* read time since cleaning */
933 uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
934 time_t CleaningDate; /* time last cleaned */
935 utime_t CleaningPeriod; /* time between cleanings */
941 char Name[MAX_NAME_LENGTH]; /* Device name */
942 int AutoChanger; /* Set if autochanger */
944 /* Not in database */
945 bool created; /* set if created by db_create ... */
948 class MEDIATYPE_DBR {
951 char MediaType[MAX_NAME_LENGTH]; /* MediaType string */
952 int ReadOnly; /* Set if read-only */
956 /* Media record -- same as the database */
958 DBId_t MediaId; /* Unique volume id */
959 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
960 char MediaType[MAX_NAME_LENGTH]; /* Media type */
961 DBId_t PoolId; /* Pool id */
962 time_t FirstWritten; /* Time Volume first written this usage */
963 time_t LastWritten; /* Time Volume last written */
964 time_t LabelDate; /* Date/Time Volume labeled */
965 time_t InitialWrite; /* Date/Time Volume first written */
966 int32_t LabelType; /* Label (Bacula/ANSI/IBM) */
967 uint32_t VolJobs; /* number of jobs on this medium */
968 uint32_t VolFiles; /* Number of files */
969 uint32_t VolBlocks; /* Number of blocks */
970 uint32_t VolMounts; /* Number of times mounted */
971 uint32_t VolErrors; /* Number of read/write errors */
972 uint32_t VolWrites; /* Number of writes */
973 uint32_t VolReads; /* Number of reads */
974 uint64_t VolBytes; /* Number of bytes written */
975 uint32_t VolParts; /* Number of parts written */
976 uint64_t MaxVolBytes; /* Max bytes to write to Volume */
977 uint64_t VolCapacityBytes; /* capacity estimate */
978 uint64_t VolReadTime; /* time spent reading volume */
979 uint64_t VolWriteTime; /* time spent writing volume */
980 utime_t VolRetention; /* Volume retention in seconds */
981 utime_t VolUseDuration; /* time in secs volume can be used */
982 uint32_t ActionOnPurge; /* action on purge, e.g. truncate the disk volume */
983 uint32_t MaxVolJobs; /* Max Jobs on Volume */
984 uint32_t MaxVolFiles; /* Max files on Volume */
985 int32_t Recycle; /* recycle yes/no */
986 int32_t Slot; /* slot in changer */
987 int32_t Enabled; /* 0=disabled, 1=enabled, 2=archived */
988 int32_t InChanger; /* Volume currently in changer */
989 DBId_t StorageId; /* Storage record Id */
990 uint32_t EndFile; /* Last file on volume */
991 uint32_t EndBlock; /* Last block on volume */
992 uint32_t RecycleCount; /* Number of times recycled */
993 char VolStatus[20]; /* Volume status */
994 DBId_t DeviceId; /* Device where Vol last written */
995 DBId_t LocationId; /* Where Volume is -- user defined */
996 DBId_t ScratchPoolId; /* Where to move if scratch */
997 DBId_t RecyclePoolId; /* Where to move when recycled */
998 /* Extra stuff not in DB */
999 faddr_t rec_addr; /* found record address */
1000 /* Since the database returns times as strings, this is how we pass
1003 char cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
1004 char cLastWritten[MAX_TIME_LENGTH]; /* LastWritten returned from DB */
1005 char cLabelDate[MAX_TIME_LENGTH]; /* LabelData returned from DB */
1006 char cInitialWrite[MAX_TIME_LENGTH]; /* InitialWrite returned from DB */
1007 bool set_first_written;
1008 bool set_label_date;
1011 /* Client record -- same as the database */
1013 DBId_t ClientId; /* Unique Client id */
1015 utime_t FileRetention;
1016 utime_t JobRetention;
1017 char Name[MAX_NAME_LENGTH]; /* Client name */
1018 char Uname[256]; /* Uname for client */
1021 /* Counter record as in database */
1022 struct COUNTER_DBR {
1023 char Counter[MAX_NAME_LENGTH];
1026 int32_t CurrentValue;
1027 char WrapCounter[MAX_NAME_LENGTH];
1031 /* FileSet record -- same as the database */
1032 struct FILESET_DBR {
1033 DBId_t FileSetId; /* Unique FileSet id */
1034 char FileSet[MAX_NAME_LENGTH]; /* FileSet name */
1035 char MD5[50]; /* MD5 signature of include/exclude */
1036 time_t CreateTime; /* date created */
1038 * This is where we return CreateTime
1040 char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
1041 /* Not in DB but returned by db_create_fileset() */
1042 bool created; /* set when record newly created */
1045 /* Call back context for getting a 32/64 bit value from the database */
1046 struct db_int64_ctx {
1047 int64_t value; /* value returned */
1048 int count; /* number of values seen */
1051 /* Call back context for getting a list of comma separated strings from the
1056 POOLMEM *list; /* list */
1057 int count; /* number of values seen */
1059 db_list_ctx() { list = get_pool_memory(PM_FNAME); *list = 0; count = 0; }
1060 ~db_list_ctx() { free_pool_memory(list); list = NULL; }
1063 db_list_ctx(const db_list_ctx&); /* prohibit pass by value */
1064 db_list_ctx &operator=(const db_list_ctx&); /* prohibit class assignment */
1070 #include "sql_cmds.h"
1073 * Exported globals from sql.c
1075 extern int DLL_IMP_EXP db_type; /* SQL engine type index */
1078 * Some functions exported by sql.c for use within the
1081 void list_result(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
1082 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
1083 int get_sql_record_max(JCR *jcr, B_DB *mdb);
1084 bool check_tables_version(JCR *jcr, B_DB *mdb);
1085 bool db_check_max_connections(JCR *jcr, B_DB *mdb, uint32_t nb);
1086 void _db_unlock(const char *file, int line, B_DB *mdb);
1087 void _db_lock(const char *file, int line, B_DB *mdb);
1088 const char *db_get_type(void);
1090 void print_dashes(B_DB *mdb);
1091 void print_result(B_DB *mdb);
1092 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
1093 int InsertDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
1094 int DeleteDB(const char *file, int line, JCR *jcr, B_DB *db, char *delete_cmd);
1095 int UpdateDB(const char *file, int line, JCR *jcr, B_DB *db, char *update_cmd);
1096 void split_path_and_file(JCR *jcr, B_DB *mdb, const char *fname);
1097 #endif /* __SQL_H_ */