2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2010 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
44 Here is how database versions work.
46 While I am working on a new release with database changes, the
47 update scripts are in the src/cats directory under the names
48 update_xxx_tables.in. Most of the time, I make database updates
49 in one go and immediately update the version, but not always. If
50 there are going to be several updates as is the case with version
51 1.37, then I will often forgo changing the version until the last
52 update otherwise I will end up with too many versions and a lot
55 When I am pretty sure there will be no more updates, I will
56 change the version from 8 to 9 (in the present case), and when I
57 am 100% sure there will be no more changes, the update script
58 will be copied to the updatedb directory with the correct name
59 (in the present case 8 to 9).
61 Now, in principle, each of the different DB implementations
62 can have a different version, but in practice they are all
63 the same (simplifies things). The exception is the internal
64 database, which is no longer used, and hence, no longer changes.
73 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 12
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 dlink link; /* 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 fields_defined; /* set when fields defined */
139 char *sqlite_errmsg; /* error message returned by sqlite */
140 POOLMEM *errmsg; /* nicely edited error message */
141 POOLMEM *cmd; /* SQL command string */
142 POOLMEM *cached_path; /* cached path name */
143 int cached_path_len; /* length of cached path */
144 uint32_t cached_path_id; /* cached path id */
145 bool allow_transactions; /* transactions allowed */
146 bool transaction; /* transaction started */
147 int changes; /* changes during transaction */
148 POOLMEM *fname; /* Filename only */
149 POOLMEM *path; /* Path only */
150 POOLMEM *esc_name; /* Escaped file name */
151 POOLMEM *esc_path; /* Escaped path name */
152 int fnl; /* file name length */
153 int pnl; /* path name length */
158 * "Generic" names for easier conversion
162 #define sql_store_result(x) (x)->result
163 #define sql_free_result(x) my_sqlite_free_table(x)
164 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
165 #define sql_query(x, y) my_sqlite_query((x), (y))
166 #define sql_insert_id(x, y, z) my_sqlite_sql_insert_id((x), (y), (z))
168 #define sql_close(x) sqlite3_close((x)->db)
169 #define sql_affected_rows(x) sqlite3_changes((x)->db)
171 #define sql_close(x) sqlite_close((x)->db)
172 #define sql_affected_rows(x) 1
174 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
175 #define sql_num_rows(x) (x)->nrow
176 #define sql_data_seek(x, i) (x)->row = (i)
177 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
178 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
179 #define sql_num_fields(x) ((x)->ncolumn)
180 #define SQL_ROW char**
181 #define SQL_MATCH "MATCH"
183 #define sql_batch_start(x,y) my_batch_start(x,y)
184 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
185 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
186 #define sql_batch_lock_path_query my_sqlite_batch_lock_query
187 #define sql_batch_lock_filename_query my_sqlite_batch_lock_query
188 #define sql_batch_unlock_tables_query my_sqlite_batch_unlock_query
189 #define sql_batch_fill_filename_query my_sqlite_batch_fill_filename_query
190 #define sql_batch_fill_path_query my_sqlite_batch_fill_path_query
192 /* In cats/sqlite.c */
193 void my_sqlite_free_table(B_DB *mdb);
194 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
195 int my_sqlite_query(B_DB *mdb, const char *cmd);
196 void my_sqlite_field_seek(B_DB *mdb, int field);
197 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
198 int my_sqlite_sql_insert_id(B_DB *mdb, const char *query, const char *table_name);
199 extern const char* my_sqlite_batch_lock_query;
200 extern const char* my_sqlite_batch_unlock_query;
201 extern const char* my_sqlite_batch_fill_filename_query;
202 extern const char* my_sqlite_batch_fill_path_query;
213 #define BDB_VERSION 12
217 /* Define opaque structure for sqlite */
222 #define IS_NUM(x) ((x) == 1)
223 #define IS_NOT_NULL(x) ((x) == 1)
225 typedef struct s_sql_field {
226 char *name; /* name of column */
227 int length; /* length */
228 int max_length; /* max length */
229 uint32_t type; /* type */
230 uint32_t flags; /* flags */
234 * This is the "real" definition that should only be
235 * used inside sql.c and associated database interface
240 dlink link; /* queue control */
241 brwlock_t lock; /* transaction lock */
245 int nrow; /* nrow returned from sqlite */
246 int ncolumn; /* ncolum returned from sqlite */
247 int num_rows; /* used by code */
248 int row; /* seek row */
249 int field; /* seek field */
250 SQL_FIELD **fields; /* defined fields */
254 char *db_address; /* host name address */
255 char *db_socket; /* socket for local access */
257 int db_port; /* port for host name address */
258 bool connected; /* connection made to db */
259 bool fields_defined; /* set when fields defined */
260 char *sqlite_errmsg; /* error message returned by sqlite */
261 POOLMEM *errmsg; /* nicely edited error message */
262 POOLMEM *cmd; /* SQL command string */
263 POOLMEM *cached_path; /* cached path name */
264 int cached_path_len; /* length of cached path */
265 uint32_t cached_path_id; /* cached path id */
266 bool allow_transactions; /* transactions allowed */
267 bool transaction; /* transaction started */
268 int changes; /* changes during transaction */
269 POOLMEM *fname; /* Filename only */
270 POOLMEM *path; /* Path only */
271 POOLMEM *esc_name; /* Escaped file name */
272 POOLMEM *esc_path; /* Escaped path name */
273 int fnl; /* file name length */
274 int pnl; /* path name length */
278 * Conversion of sqlite 2 names to sqlite3
280 #define sqlite_last_insert_rowid sqlite3_last_insert_rowid
281 #define sqlite_open sqlite3_open
282 #define sqlite_close sqlite3_close
283 #define sqlite_result sqlite3_result
284 #define sqlite_exec sqlite3_exec
285 #define sqlite_get_table sqlite3_get_table
286 #define sqlite_free_table sqlite3_free_table
290 * "Generic" names for easier conversion
294 #define sql_store_result(x) (x)->result
295 #define sql_free_result(x) my_sqlite_free_table(x)
296 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
297 #define sql_query(x, y) my_sqlite_query((x), (y))
298 #define sql_insert_id(x, y, z) my_sqlite_sql_insert_id((x), (y), (z))
300 #define sql_close(x) sqlite3_close((x)->db)
302 #define sql_close(x) sqlite_close((x)->db)
304 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
305 #define sql_num_rows(x) (x)->nrow
306 #define sql_data_seek(x, i) (x)->row = (i)
307 #define sql_affected_rows(x) sqlite3_changes((x)->db)
308 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
309 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
310 #define sql_num_fields(x) ((x)->ncolumn)
311 #define sql_batch_start(x,y) my_batch_start(x,y)
312 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
313 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
314 #define SQL_ROW char**
315 #define SQL_MATCH "MATCH"
316 #define sql_batch_lock_path_query my_sqlite_batch_lock_query
317 #define sql_batch_lock_filename_query my_sqlite_batch_lock_query
318 #define sql_batch_unlock_tables_query my_sqlite_batch_unlock_query
319 #define sql_batch_fill_filename_query my_sqlite_batch_fill_filename_query
320 #define sql_batch_fill_path_query my_sqlite_batch_fill_path_query
322 /* In cats/sqlite.c */
323 void my_sqlite_free_table(B_DB *mdb);
324 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
325 int my_sqlite_query(B_DB *mdb, const char *cmd);
326 void my_sqlite_field_seek(B_DB *mdb, int field);
327 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
328 int my_sqlite_sql_insert_id(B_DB *mdb, const char *query, const char *table_name);
329 extern const char* my_sqlite_batch_lock_query;
330 extern const char* my_sqlite_batch_unlock_query;
331 extern const char* my_sqlite_batch_fill_filename_query;
332 extern const char* my_sqlite_batch_fill_path_query;
339 #define BDB_VERSION 12
344 * This is the "real" definition that should only be
345 * used inside sql.c and associated database interface
351 dlink link; /* queue control */
352 brwlock_t lock; /* transaction lock */
357 my_ulonglong num_rows;
362 char *db_address; /* host address */
363 char *db_socket; /* socket for local access */
364 int db_port; /* port of host address */
366 POOLMEM *errmsg; /* nicely edited error message */
367 POOLMEM *cmd; /* SQL command string */
368 POOLMEM *cached_path;
369 int cached_path_len; /* length of cached path */
370 uint32_t cached_path_id;
371 bool allow_transactions; /* transactions allowed */
372 int changes; /* changes made to db */
373 POOLMEM *fname; /* Filename only */
374 POOLMEM *path; /* Path only */
375 POOLMEM *esc_name; /* Escaped file name */
376 POOLMEM *esc_path; /* Escaped path name */
377 int fnl; /* file name length */
378 int pnl; /* path name length */
381 #define DB_STATUS int
383 /* "Generic" names for easier conversion */
384 #define sql_store_result(x) mysql_store_result((x)->db)
385 #define sql_use_result(x) mysql_use_result((x)->db)
386 #define sql_free_result(x) my_mysql_free_result(x)
387 #define sql_fetch_row(x) mysql_fetch_row((x)->result)
388 #define sql_query(x, y) mysql_query((x)->db, (y))
389 #define sql_strerror(x) mysql_error((x)->db)
390 #define sql_num_rows(x) mysql_num_rows((x)->result)
391 #define sql_data_seek(x, i) mysql_data_seek((x)->result, (i))
392 #define sql_affected_rows(x) mysql_affected_rows((x)->db)
393 #define sql_insert_id(x, y, z) my_mysql_sql_insert_id((x), (y), (z))
394 #define sql_field_seek(x, y) mysql_field_seek((x)->result, (y))
395 #define sql_fetch_field(x) mysql_fetch_field((x)->result)
396 #define sql_num_fields(x) (int)mysql_num_fields((x)->result)
397 #define SQL_ROW MYSQL_ROW
398 #define SQL_FIELD MYSQL_FIELD
399 #define SQL_MATCH "MATCH"
401 #define sql_batch_start(x,y) my_batch_start(x,y)
402 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
403 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
404 #define sql_batch_lock_path_query my_mysql_batch_lock_path_query
405 #define sql_batch_lock_filename_query my_mysql_batch_lock_filename_query
406 #define sql_batch_unlock_tables_query my_mysql_batch_unlock_tables_query
407 #define sql_batch_fill_filename_query my_mysql_batch_fill_filename_query
408 #define sql_batch_fill_path_query my_mysql_batch_fill_path_query
411 extern const char* my_mysql_batch_lock_path_query;
412 extern const char* my_mysql_batch_lock_filename_query;
413 extern const char* my_mysql_batch_unlock_tables_query;
414 extern const char* my_mysql_batch_fill_filename_query;
415 extern const char* my_mysql_batch_fill_path_query;
416 extern void my_mysql_free_result(B_DB *mdb);
417 extern int my_mysql_sql_insert_id(B_DB *mdb, const char *query, const char *table_name);
421 #ifdef HAVE_POSTGRESQL
423 #define BDB_VERSION 12
425 #include <libpq-fe.h>
427 /* TEMP: the following is taken from select OID, typname from pg_type; */
428 #define IS_NUM(x) ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
429 #define IS_NOT_NULL(x) ((x) == 1)
431 typedef char **POSTGRESQL_ROW;
432 typedef struct pg_field {
436 unsigned int flags; // 1 == not null
441 * This is the "real" definition that should only be
442 * used inside sql.c and associated database interface
445 * P O S T G R E S Q L
448 dlink link; /* queue control */
449 brwlock_t lock; /* transaction lock */
454 POSTGRESQL_FIELD *fields;
456 int row_size; /* size of malloced rows */
458 int fields_size; /* size of malloced fields */
459 int row_number; /* row number from my_postgresql_data_seek */
460 int field_number; /* field number from my_postgresql_field_seek */
465 char *db_address; /* host address */
466 char *db_socket; /* socket for local access */
467 int db_port; /* port of host address */
469 POOLMEM *errmsg; /* nicely edited error message */
470 POOLMEM *cmd; /* SQL command string */
471 POOLMEM *cached_path;
472 int cached_path_len; /* length of cached path */
473 uint32_t cached_path_id;
474 bool allow_transactions; /* transactions allowed */
475 bool transaction; /* transaction started */
476 int changes; /* changes made to db */
477 POOLMEM *fname; /* Filename only */
478 POOLMEM *path; /* Path only */
479 POOLMEM *esc_name; /* Escaped file name */
480 POOLMEM *esc_path; /* Escaped path name */
481 int fnl; /* file name length */
482 int pnl; /* path name length */
485 void my_postgresql_free_result(B_DB *mdb);
486 POSTGRESQL_ROW my_postgresql_fetch_row (B_DB *mdb);
487 int my_postgresql_query (B_DB *mdb, const char *query);
488 void my_postgresql_data_seek (B_DB *mdb, int row);
489 int my_postgresql_insert_id (B_DB *mdb, const char *query, const char *table_name);
490 void my_postgresql_field_seek (B_DB *mdb, int row);
491 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
493 int my_postgresql_batch_start(JCR *jcr, B_DB *mdb);
494 int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error);
495 typedef struct ATTR_DBR ATTR_DBR;
496 int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
497 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
499 extern const char* my_pg_batch_lock_path_query;
500 extern const char* my_pg_batch_lock_filename_query;
501 extern const char* my_pg_batch_unlock_tables_query;
502 extern const char* my_pg_batch_fill_filename_query;
503 extern const char* my_pg_batch_fill_path_query;
505 /* "Generic" names for easier conversion */
506 #define sql_store_result(x) ((x)->result)
507 #define sql_free_result(x) my_postgresql_free_result(x)
508 #define sql_fetch_row(x) my_postgresql_fetch_row(x)
509 #define sql_query(x, y) my_postgresql_query((x), (y))
510 #define sql_close(x) PQfinish((x)->db)
511 #define sql_strerror(x) PQerrorMessage((x)->db)
512 #define sql_num_rows(x) ((unsigned) PQntuples((x)->result))
513 #define sql_data_seek(x, i) my_postgresql_data_seek((x), (i))
514 #define sql_affected_rows(x) ((unsigned) atoi(PQcmdTuples((x)->result)))
515 #define sql_insert_id(x, y, z) my_postgresql_insert_id((x), (y), (z))
516 #define sql_field_seek(x, y) my_postgresql_field_seek((x), (y))
517 #define sql_fetch_field(x) my_postgresql_fetch_field(x)
518 #define sql_num_fields(x) ((x)->num_fields)
520 #define sql_batch_start(x,y) my_postgresql_batch_start(x,y)
521 #define sql_batch_end(x,y,z) my_postgresql_batch_end(x,y,z)
522 #define sql_batch_insert(x,y,z) my_postgresql_batch_insert(x,y,z)
523 #define sql_batch_lock_path_query my_pg_batch_lock_path_query
524 #define sql_batch_lock_filename_query my_pg_batch_lock_filename_query
525 #define sql_batch_unlock_tables_query my_pg_batch_unlock_tables_query
526 #define sql_batch_fill_filename_query my_pg_batch_fill_filename_query
527 #define sql_batch_fill_path_query my_pg_batch_fill_path_query
529 #define SQL_ROW POSTGRESQL_ROW
530 #define SQL_FIELD POSTGRESQL_FIELD
531 #define SQL_MATCH "~"
537 #include "myingres.h"
538 #include "lib/breg.h"
540 #define BDB_VERSION 12
542 /* TEMP: the following is taken from select OID, typname from pg_type; */ /*SRE: huh? */
543 #define IS_NUM(x) ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
544 #define IS_NOT_NULL(x) ((x) == 1)
546 typedef char **INGRES_ROW;
549 * This is the "real" definition that should only be
550 * used inside sql.c and associated database interface
556 dlink link; /* queue control */
557 brwlock_t lock; /* transaction lock */
562 INGRES_FIELD *fields;
564 int row_size; /* size of malloced rows */
566 int fields_size; /* size of malloced fields */
567 int row_number; /* row number from my_ingres_data_seek */
568 int field_number; /* field number from my_ingres_field_seek */
573 char *db_address; /* host address */
574 char *db_socket; /* socket for local access */
575 int db_port; /* port of host address */
576 int session_id; /* unique session id */
578 POOLMEM *errmsg; /* nicely edited error message */
579 POOLMEM *cmd; /* SQL command string */
580 POOLMEM *cached_path;
581 int cached_path_len; /* length of cached path */
582 uint32_t cached_path_id;
583 bool allow_transactions; /* transactions allowed */
584 bool transaction; /* transaction started */
585 int changes; /* changes made to db */
586 POOLMEM *fname; /* Filename only */
587 POOLMEM *path; /* Path only */
588 POOLMEM *esc_name; /* Escaped file name */
589 POOLMEM *esc_path; /* Escaped path name */
590 BREGEXP *limit_filter; /* Filter LIMIT function in queries into supported SQL */
591 int fnl; /* file name length */
592 int pnl; /* path name length */
595 void my_ingres_free_result(B_DB *mdb);
596 INGRES_ROW my_ingres_fetch_row (B_DB *mdb);
597 int my_ingres_query (B_DB *mdb, const char *query);
598 void my_ingres_data_seek (B_DB *mdb, int row);
599 void my_ingres_field_seek (B_DB *mdb, int row);
600 INGRES_FIELD * my_ingres_fetch_field(B_DB *mdb);
601 void my_ingres_close (B_DB *mdb);
602 int my_ingres_insert_id (B_DB *mdb, const char *query, const char *table_name);
604 bool my_ingres_batch_start(JCR *jcr, B_DB *mdb);
605 bool my_ingres_batch_end(JCR *jcr, B_DB *mdb, const char *error);
606 typedef struct ATTR_DBR ATTR_DBR;
607 bool my_ingres_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
608 char *my_ingres_copy_escape(char *dest, char *src, size_t len);
610 extern const char* my_ingres_batch_lock_path_query;
611 extern const char* my_ingres_batch_lock_filename_query;
612 extern const char* my_ingres_batch_unlock_tables_query;
613 extern const char* my_ingres_batch_fill_filename_query;
614 extern const char* my_ingres_batch_fill_path_query;
616 /* "Generic" names for easier conversion */
617 #define sql_store_result(x) ((x)->result)
618 #define sql_free_result(x) my_ingres_free_result(x)
619 #define sql_fetch_row(x) my_ingres_fetch_row(x)
620 #define sql_query(x, y) my_ingres_query((x), (y))
621 #define sql_close(x) my_ingres_close(x)
622 #define sql_strerror(x) INGerrorMessage((x)->db)
623 #define sql_num_rows(x) ((unsigned) INGntuples((x)->result))
624 #define sql_data_seek(x, i) my_ingres_data_seek((x), (i))
625 #define sql_affected_rows(x) ((x)->num_rows)
626 #define sql_insert_id(x, y, z) my_ingres_insert_id((x), (y), (z))
627 #define sql_field_seek(x, y) my_ingres_field_seek((x), (y))
628 #define sql_fetch_field(x) my_ingres_fetch_field(x)
629 #define sql_num_fields(x) ((x)->num_fields)
631 #define sql_batch_start(x,y) my_ingres_batch_start(x,y)
632 #define sql_batch_end(x,y,z) my_ingres_batch_end(x,y,z)
633 #define sql_batch_insert(x,y,z) my_ingres_batch_insert(x,y,z)
634 #define sql_batch_lock_path_query my_ingres_batch_lock_path_query
635 #define sql_batch_lock_filename_query my_ingres_batch_lock_filename_query
636 #define sql_batch_unlock_tables_query my_ingres_batch_unlock_tables_query
637 #define sql_batch_fill_filename_query my_ingres_batch_fill_filename_query
638 #define sql_batch_fill_path_query my_ingres_batch_fill_path_query
640 #define SQL_ROW INGRES_ROW
641 #define SQL_FIELD INGRES_FIELD
642 #define SQL_MATCH "~"
648 #define BDB_VERSION 12
652 #ifdef HAVE_BATCH_FILE_INSERT
653 #include <dbi/dbi-dev.h>
654 #endif //HAVE_BATCH_FILE_INSERT
656 #define IS_NUM(x) ((x) == 1 || (x) == 2 )
657 #define IS_NOT_NULL(x) ((x) == (1 << 0))
659 typedef char **DBI_ROW;
660 typedef struct dbi_field {
664 unsigned int flags; // 1 == not null
667 typedef struct dbi_field_get {
673 * This is the "real" definition that should only be
674 * used inside sql.c and associated database interface
680 dlink link; /* queue control */
681 brwlock_t lock; /* transaction lock */
685 dbi_error_flag status;
688 DBI_FIELD_GET *field_get;
690 int row_size; /* size of malloced rows */
692 int fields_size; /* size of malloced fields */
693 int row_number; /* row number from my_postgresql_data_seek */
694 int field_number; /* field number from my_postgresql_field_seek */
696 int db_type; /* DBI driver defined */
697 char *db_driverdir ; /* DBI driver dir */
698 char *db_driver; /* DBI type database */
702 char *db_address; /* host address */
703 char *db_socket; /* socket for local access */
704 int db_port; /* port of host address */
706 POOLMEM *errmsg; /* nicely edited error message */
707 POOLMEM *cmd; /* SQL command string */
708 POOLMEM *cached_path;
709 int cached_path_len; /* length of cached path */
710 uint32_t cached_path_id;
711 bool allow_transactions; /* transactions allowed */
712 bool transaction; /* transaction started */
713 int changes; /* changes made to db */
714 POOLMEM *fname; /* Filename only */
715 POOLMEM *path; /* Path only */
716 POOLMEM *esc_name; /* Escaped file name */
717 POOLMEM *esc_path; /* Escaped path name */
718 int fnl; /* file name length */
719 int pnl; /* path name length */
722 void my_dbi_free_result(B_DB *mdb);
723 DBI_ROW my_dbi_fetch_row (B_DB *mdb);
724 int my_dbi_query (B_DB *mdb, const char *query);
725 void my_dbi_data_seek (B_DB *mdb, int row);
726 void my_dbi_field_seek (B_DB *mdb, int row);
727 DBI_FIELD * my_dbi_fetch_field(B_DB *mdb);
728 const char * my_dbi_strerror (B_DB *mdb);
729 int my_dbi_getisnull (dbi_result *result, int row_number, int column_number);
730 char * my_dbi_getvalue (dbi_result *result, int row_number, unsigned int column_number);
731 //int my_dbi_getvalue (dbi_result *result, int row_number, unsigned int column_number, char *value);
732 int my_dbi_sql_insert_id(B_DB *mdb, const char *query, const char *table_name);
734 int my_dbi_batch_start(JCR *jcr, B_DB *mdb);
735 int my_dbi_batch_end(JCR *jcr, B_DB *mdb, const char *error);
736 typedef struct ATTR_DBR ATTR_DBR;
737 int my_dbi_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
738 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
739 // typedefs for libdbi work with postgresql copy insert
740 typedef int (*custom_function_insert_t)(void*, const char*, int);
741 typedef char* (*custom_function_error_t)(void*);
742 typedef int (*custom_function_end_t)(void*, const char*);
744 extern const char* my_dbi_batch_lock_path_query[5];
745 extern const char* my_dbi_batch_lock_filename_query[5];
746 extern const char* my_dbi_batch_unlock_tables_query[5];
747 extern const char* my_dbi_batch_fill_filename_query[5];
748 extern const char* my_dbi_batch_fill_path_query[5];
749 extern const char* my_dbi_match[5];
751 /* "Generic" names for easier conversion */
752 #define sql_store_result(x) (x)->result
753 #define sql_free_result(x) my_dbi_free_result(x)
754 #define sql_fetch_row(x) my_dbi_fetch_row(x)
755 #define sql_query(x, y) my_dbi_query((x), (y))
756 #define sql_close(x) dbi_conn_close((x)->db)
757 #define sql_strerror(x) my_dbi_strerror(x)
758 #define sql_num_rows(x) dbi_result_get_numrows((x)->result)
759 #define sql_data_seek(x, i) my_dbi_data_seek((x), (i))
760 #define SQL_MATCH my_dbi_match[db_type]
761 /* #define sql_affected_rows(x) dbi_result_get_numrows_affected((x)->result) */
762 #define sql_affected_rows(x) 1
763 #define sql_insert_id(x, y, z) my_dbi_sql_insert_id((x), (y), (z))
764 #define sql_field_seek(x, y) my_dbi_field_seek((x), (y))
765 #define sql_fetch_field(x) my_dbi_fetch_field(x)
766 #define sql_num_fields(x) ((x)->num_fields)
767 #define sql_batch_start(x,y) my_dbi_batch_start(x,y)
768 #define sql_batch_end(x,y,z) my_dbi_batch_end(x,y,z)
769 #define sql_batch_insert(x,y,z) my_dbi_batch_insert(x,y,z)
770 #define sql_batch_lock_path_query my_dbi_batch_lock_path_query[db_type]
771 #define sql_batch_lock_filename_query my_dbi_batch_lock_filename_query[db_type]
772 #define sql_batch_unlock_tables_query my_dbi_batch_unlock_tables_query[db_type]
773 #define sql_batch_fill_filename_query my_dbi_batch_fill_filename_query[db_type]
774 #define sql_batch_fill_path_query my_dbi_batch_fill_path_query[db_type]
776 #define SQL_ROW DBI_ROW
777 #define SQL_FIELD DBI_FIELD
779 #endif /* HAVE_SQLITE3 */
780 #endif /* HAVE_MYSQL */
781 #endif /* HAVE_SQLITE */
782 #endif /* HAVE_POSTGRESQL */
783 #endif /* HAVE_INGRES */
784 #endif /* HAVE_DBI */
787 /* Use for better error location printing */
788 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
789 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
790 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
791 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
794 #else /* not __SQL_C */
796 /* This is a "dummy" definition for use outside of sql.c
799 int dummy; /* for SunOS compiler */
804 /* ==============================================================
806 * What follows are definitions that are used "globally" for all
807 * the different SQL engines and both inside and external to the
811 extern uint32_t bacula_db_version;
816 * Structure used when calling db_get_query_ids()
817 * allows the subroutine to return a list of ids.
819 class dbid_list : public SMARTALLOC {
821 DBId_t *DBId; /* array of DBIds */
822 char *PurgedFiles; /* Array of PurgedFile flags */
823 int num_ids; /* num of ids actually stored */
824 int max_ids; /* size of id array */
825 int num_seen; /* number of ids processed */
826 int tot_ids; /* total to process */
828 dbid_list(); /* in sql.c */
829 ~dbid_list(); /* in sql.c */
835 /* Job information passed to create job record and update
836 * job record at end of job. Note, although this record
837 * contains all the fields found in the Job database record,
838 * it also contains fields found in the JobMedia record.
843 char Job[MAX_NAME_LENGTH]; /* Job unique name */
844 char Name[MAX_NAME_LENGTH]; /* Job base name */
845 int JobType; /* actually char(1) */
846 int JobLevel; /* actually char(1) */
847 int JobStatus; /* actually char(1) */
848 DBId_t ClientId; /* Id of client */
849 DBId_t PoolId; /* Id of pool */
850 DBId_t FileSetId; /* Id of FileSet */
851 DBId_t PriorJobId; /* Id of migrated (prior) job */
852 time_t SchedTime; /* Time job scheduled */
853 time_t StartTime; /* Job start time */
854 time_t EndTime; /* Job termination time of orig job */
855 time_t RealEndTime; /* Job termination time of this job */
856 utime_t JobTDate; /* Backup time/date in seconds */
857 uint32_t VolSessionId;
858 uint32_t VolSessionTime;
861 uint32_t JobMissingFiles;
867 /* Note, FirstIndex, LastIndex, Start/End File and Block
868 * are only used in the JobMedia record.
870 uint32_t FirstIndex; /* First index this Volume */
871 uint32_t LastIndex; /* Last index this Volume */
877 char cSchedTime[MAX_TIME_LENGTH];
878 char cStartTime[MAX_TIME_LENGTH];
879 char cEndTime[MAX_TIME_LENGTH];
880 char cRealEndTime[MAX_TIME_LENGTH];
881 /* Extra stuff not in DB */
882 int limit; /* limit records to display */
884 uint32_t FileIndex; /* added during Verify */
887 /* Job Media information used to create the media records
888 * for each Volume used for the job.
890 /* JobMedia record */
891 struct JOBMEDIA_DBR {
892 DBId_t JobMediaId; /* record id */
893 JobId_t JobId; /* JobId */
894 DBId_t MediaId; /* MediaId */
895 uint32_t FirstIndex; /* First index this Volume */
896 uint32_t LastIndex; /* Last index this Volume */
897 uint32_t StartFile; /* File for start of data */
898 uint32_t EndFile; /* End file on Volume */
899 uint32_t StartBlock; /* start block on tape */
900 uint32_t EndBlock; /* last block */
901 // uint32_t Copy; /* identical copy */
905 /* Volume Parameter structure */
907 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
908 char MediaType[MAX_NAME_LENGTH]; /* Media Type */
909 char Storage[MAX_NAME_LENGTH]; /* Storage name */
910 uint32_t VolIndex; /* Volume seqence no. */
911 uint32_t FirstIndex; /* First index this Volume */
912 uint32_t LastIndex; /* Last index this Volume */
913 int32_t Slot; /* Slot */
914 uint64_t StartAddr; /* Start address */
915 uint64_t EndAddr; /* End address */
916 int32_t InChanger; /* InChanger flag */
917 // uint32_t Copy; /* identical copy */
918 // uint32_t Stripe; /* RAIT strip number */
922 /* Attributes record -- NOT same as in database because
923 * in general, this "record" creates multiple database
924 * records (e.g. pathname, filename, fileattributes).
927 char *fname; /* full path & filename */
928 char *link; /* link if any */
929 char *attr; /* attributes statp */
943 /* File record -- same format as database */
952 char Digest[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
953 int DigestType; /* NO_SIG/MD5_SIG/SHA1_SIG */
956 /* Pool record -- same format as database */
959 char Name[MAX_NAME_LENGTH]; /* Pool name */
960 uint32_t NumVols; /* total number of volumes */
961 uint32_t MaxVols; /* max allowed volumes */
962 int32_t LabelType; /* Bacula/ANSI/IBM */
963 int32_t UseOnce; /* set to use once only */
964 int32_t UseCatalog; /* set to use catalog */
965 int32_t AcceptAnyVolume; /* set to accept any volume sequence */
966 int32_t AutoPrune; /* set to prune automatically */
967 int32_t Recycle; /* default Vol recycle flag */
968 uint32_t ActionOnPurge; /* action on purge, e.g. truncate the disk volume */
969 utime_t VolRetention; /* retention period in seconds */
970 utime_t VolUseDuration; /* time in secs volume can be used */
971 uint32_t MaxVolJobs; /* Max Jobs on Volume */
972 uint32_t MaxVolFiles; /* Max files on Volume */
973 uint64_t MaxVolBytes; /* Max bytes on Volume */
974 DBId_t RecyclePoolId; /* RecyclePool destination when media is purged */
975 DBId_t ScratchPoolId; /* ScratchPool source when media is needed */
976 char PoolType[MAX_NAME_LENGTH];
977 char LabelFormat[MAX_NAME_LENGTH];
978 /* Extra stuff not in DB */
985 char Name[MAX_NAME_LENGTH]; /* Device name */
986 DBId_t MediaTypeId; /* MediaType */
987 DBId_t StorageId; /* Storage id if autochanger */
988 uint32_t DevMounts; /* Number of times mounted */
989 uint32_t DevErrors; /* Number of read/write errors */
990 uint64_t DevReadBytes; /* Number of bytes read */
991 uint64_t DevWriteBytes; /* Number of bytew written */
992 uint64_t DevReadTime; /* time spent reading volume */
993 uint64_t DevWriteTime; /* time spent writing volume */
994 uint64_t DevReadTimeSincCleaning; /* read time since cleaning */
995 uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
996 time_t CleaningDate; /* time last cleaned */
997 utime_t CleaningPeriod; /* time between cleanings */
1003 char Name[MAX_NAME_LENGTH]; /* Device name */
1004 int AutoChanger; /* Set if autochanger */
1006 /* Not in database */
1007 bool created; /* set if created by db_create ... */
1010 class MEDIATYPE_DBR {
1013 char MediaType[MAX_NAME_LENGTH]; /* MediaType string */
1014 int ReadOnly; /* Set if read-only */
1018 /* Media record -- same as the database */
1020 DBId_t MediaId; /* Unique volume id */
1021 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
1022 char MediaType[MAX_NAME_LENGTH]; /* Media type */
1023 DBId_t PoolId; /* Pool id */
1024 time_t FirstWritten; /* Time Volume first written this usage */
1025 time_t LastWritten; /* Time Volume last written */
1026 time_t LabelDate; /* Date/Time Volume labeled */
1027 time_t InitialWrite; /* Date/Time Volume first written */
1028 int32_t LabelType; /* Label (Bacula/ANSI/IBM) */
1029 uint32_t VolJobs; /* number of jobs on this medium */
1030 uint32_t VolFiles; /* Number of files */
1031 uint32_t VolBlocks; /* Number of blocks */
1032 uint32_t VolMounts; /* Number of times mounted */
1033 uint32_t VolErrors; /* Number of read/write errors */
1034 uint32_t VolWrites; /* Number of writes */
1035 uint32_t VolReads; /* Number of reads */
1036 uint64_t VolBytes; /* Number of bytes written */
1037 uint32_t VolParts; /* Number of parts written */
1038 uint64_t MaxVolBytes; /* Max bytes to write to Volume */
1039 uint64_t VolCapacityBytes; /* capacity estimate */
1040 uint64_t VolReadTime; /* time spent reading volume */
1041 uint64_t VolWriteTime; /* time spent writing volume */
1042 utime_t VolRetention; /* Volume retention in seconds */
1043 utime_t VolUseDuration; /* time in secs volume can be used */
1044 uint32_t ActionOnPurge; /* action on purge, e.g. truncate the disk volume */
1045 uint32_t MaxVolJobs; /* Max Jobs on Volume */
1046 uint32_t MaxVolFiles; /* Max files on Volume */
1047 int32_t Recycle; /* recycle yes/no */
1048 int32_t Slot; /* slot in changer */
1049 int32_t Enabled; /* 0=disabled, 1=enabled, 2=archived */
1050 int32_t InChanger; /* Volume currently in changer */
1051 DBId_t StorageId; /* Storage record Id */
1052 uint32_t EndFile; /* Last file on volume */
1053 uint32_t EndBlock; /* Last block on volume */
1054 uint32_t RecycleCount; /* Number of times recycled */
1055 char VolStatus[20]; /* Volume status */
1056 DBId_t DeviceId; /* Device where Vol last written */
1057 DBId_t LocationId; /* Where Volume is -- user defined */
1058 DBId_t ScratchPoolId; /* Where to move if scratch */
1059 DBId_t RecyclePoolId; /* Where to move when recycled */
1060 /* Extra stuff not in DB */
1061 faddr_t rec_addr; /* found record address */
1062 /* Since the database returns times as strings, this is how we pass
1065 char cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
1066 char cLastWritten[MAX_TIME_LENGTH]; /* LastWritten returned from DB */
1067 char cLabelDate[MAX_TIME_LENGTH]; /* LabelData returned from DB */
1068 char cInitialWrite[MAX_TIME_LENGTH]; /* InitialWrite returned from DB */
1069 bool set_first_written;
1070 bool set_label_date;
1073 /* Client record -- same as the database */
1075 DBId_t ClientId; /* Unique Client id */
1077 utime_t FileRetention;
1078 utime_t JobRetention;
1079 char Name[MAX_NAME_LENGTH]; /* Client name */
1080 char Uname[256]; /* Uname for client */
1083 /* Counter record as in database */
1084 struct COUNTER_DBR {
1085 char Counter[MAX_NAME_LENGTH];
1088 int32_t CurrentValue;
1089 char WrapCounter[MAX_NAME_LENGTH];
1093 /* FileSet record -- same as the database */
1094 struct FILESET_DBR {
1095 DBId_t FileSetId; /* Unique FileSet id */
1096 char FileSet[MAX_NAME_LENGTH]; /* FileSet name */
1097 char MD5[50]; /* MD5 signature of include/exclude */
1098 time_t CreateTime; /* date created */
1100 * This is where we return CreateTime
1102 char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
1103 /* Not in DB but returned by db_create_fileset() */
1104 bool created; /* set when record newly created */
1107 /* Call back context for getting a 32/64 bit value from the database */
1108 struct db_int64_ctx {
1109 int64_t value; /* value returned */
1110 int count; /* number of values seen */
1113 /* Call back context for getting a list of comma separated strings from the
1118 POOLMEM *list; /* list */
1119 int count; /* number of values seen */
1121 db_list_ctx() { list = get_pool_memory(PM_FNAME); *list = 0; count = 0; }
1122 ~db_list_ctx() { free_pool_memory(list); list = NULL; }
1125 db_list_ctx(const db_list_ctx&); /* prohibit pass by value */
1126 db_list_ctx &operator=(const db_list_ctx&); /* prohibit class assignment */
1132 #include "sql_cmds.h"
1135 * Exported globals from sql.c
1137 extern int CATS_IMP_EXP db_type; /* SQL engine type index */
1140 * Some functions exported by sql.c for use within the
1143 void list_result(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
1144 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
1145 int get_sql_record_max(JCR *jcr, B_DB *mdb);
1146 bool check_tables_version(JCR *jcr, B_DB *mdb);
1147 bool db_check_max_connections(JCR *jcr, B_DB *mdb, uint32_t nb);
1148 void _db_unlock(const char *file, int line, B_DB *mdb);
1149 void _db_lock(const char *file, int line, B_DB *mdb);
1150 const char *db_get_type(void);
1152 void print_dashes(B_DB *mdb);
1153 void print_result(B_DB *mdb);
1154 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
1155 int InsertDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
1156 int DeleteDB(const char *file, int line, JCR *jcr, B_DB *db, char *delete_cmd);
1157 int UpdateDB(const char *file, int line, JCR *jcr, B_DB *db, char *update_cmd);
1158 void split_path_and_file(JCR *jcr, B_DB *mdb, const char *fname);
1159 #endif /* __SQL_H_ */