2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 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 John Walker.
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.
73 typedef void (DB_LIST_HANDLER)(void *, const char *);
74 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
76 #define db_lock(mdb) _db_lock(__FILE__, __LINE__, mdb)
77 #define db_unlock(mdb) _db_unlock(__FILE__, __LINE__, mdb)
81 #if defined(BUILDING_CATS)
84 #define BDB_VERSION 10
88 /* Define opaque structure for sqlite */
93 #define IS_NUM(x) ((x) == 1)
94 #define IS_NOT_NULL(x) ((x) == 1)
96 typedef struct s_sql_field {
97 char *name; /* name of column */
98 int length; /* length */
99 int max_length; /* max length */
100 uint32_t type; /* type */
101 uint32_t flags; /* flags */
105 * This is the "real" definition that should only be
106 * used inside sql.c and associated database interface
111 BQUEUE bq; /* queue control */
112 brwlock_t lock; /* transaction lock */
116 int nrow; /* nrow returned from sqlite */
117 int ncolumn; /* ncolum returned from sqlite */
118 int num_rows; /* used by code */
119 int row; /* seek row */
120 int field; /* seek field */
121 SQL_FIELD **fields; /* defined fields */
125 char *db_address; /* host name address */
126 char *db_socket; /* socket for local access */
128 int db_port; /* port for host name address */
129 bool connected; /* connection made to db */
130 bool have_insert_id; /* do not have insert id */
131 bool fields_defined; /* set when fields defined */
132 char *sqlite_errmsg; /* error message returned by sqlite */
133 POOLMEM *errmsg; /* nicely edited error message */
134 POOLMEM *cmd; /* SQL command string */
135 POOLMEM *cached_path; /* cached path name */
136 int cached_path_len; /* length of cached path */
137 uint32_t cached_path_id; /* cached path id */
138 bool allow_transactions; /* transactions allowed */
139 bool transaction; /* transaction started */
140 int changes; /* changes during transaction */
141 POOLMEM *fname; /* Filename only */
142 POOLMEM *path; /* Path only */
143 POOLMEM *esc_name; /* Escaped file name */
144 POOLMEM *esc_path; /* Escaped path name */
145 int fnl; /* file name length */
146 int pnl; /* path name length */
151 * "Generic" names for easier conversion
155 #define sql_store_result(x) (x)->result
156 #define sql_free_result(x) my_sqlite_free_table(x)
157 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
158 #define sql_query(x, y) my_sqlite_query((x), (y))
160 #define sql_insert_id(x,y) sqlite3_last_insert_rowid((x)->db)
161 #define sql_close(x) sqlite3_close((x)->db)
163 #define sql_insert_id(x,y) sqlite_last_insert_rowid((x)->db)
164 #define sql_close(x) sqlite_close((x)->db)
166 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
167 #define sql_num_rows(x) (x)->nrow
168 #define sql_data_seek(x, i) (x)->row = (i)
169 #define sql_affected_rows(x) 1
170 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
171 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
172 #define sql_num_fields(x) ((x)->ncolumn)
173 #define SQL_ROW char**
175 #define sql_batch_start(x,y) my_batch_start(x,y)
176 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
177 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
178 #define sql_batch_lock_path_query my_sqlite_batch_lock_query
179 #define sql_batch_lock_filename_query my_sqlite_batch_lock_query
180 #define sql_batch_unlock_tables_query my_sqlite_batch_unlock_query
181 #define sql_batch_fill_filename_query my_sqlite_batch_fill_filename_query
182 #define sql_batch_fill_path_query my_sqlite_batch_fill_path_query
184 /* In cats/sqlite.c */
185 void my_sqlite_free_table(B_DB *mdb);
186 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
187 int my_sqlite_query(B_DB *mdb, const char *cmd);
188 void my_sqlite_field_seek(B_DB *mdb, int field);
189 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
190 extern const char* my_sqlite_batch_lock_query;
191 extern const char* my_sqlite_batch_unlock_query;
192 extern const char* my_sqlite_batch_fill_filename_query;
193 extern const char* my_sqlite_batch_fill_path_query;
204 #define BDB_VERSION 10
208 /* Define opaque structure for sqlite */
213 #define IS_NUM(x) ((x) == 1)
214 #define IS_NOT_NULL(x) ((x) == 1)
216 typedef struct s_sql_field {
217 char *name; /* name of column */
218 int length; /* length */
219 int max_length; /* max length */
220 uint32_t type; /* type */
221 uint32_t flags; /* flags */
225 * This is the "real" definition that should only be
226 * used inside sql.c and associated database interface
231 BQUEUE bq; /* queue control */
232 brwlock_t lock; /* transaction lock */
236 int nrow; /* nrow returned from sqlite */
237 int ncolumn; /* ncolum returned from sqlite */
238 int num_rows; /* used by code */
239 int row; /* seek row */
240 int field; /* seek field */
241 SQL_FIELD **fields; /* defined fields */
245 char *db_address; /* host name address */
246 char *db_socket; /* socket for local access */
248 int db_port; /* port for host name address */
249 bool connected; /* connection made to db */
250 bool have_insert_id; /* do not have insert id */
251 bool fields_defined; /* set when fields defined */
252 char *sqlite_errmsg; /* error message returned by sqlite */
253 POOLMEM *errmsg; /* nicely edited error message */
254 POOLMEM *cmd; /* SQL command string */
255 POOLMEM *cached_path; /* cached path name */
256 int cached_path_len; /* length of cached path */
257 uint32_t cached_path_id; /* cached path id */
258 bool allow_transactions; /* transactions allowed */
259 bool transaction; /* transaction started */
260 int changes; /* changes during transaction */
261 POOLMEM *fname; /* Filename only */
262 POOLMEM *path; /* Path only */
263 POOLMEM *esc_name; /* Escaped file name */
264 POOLMEM *esc_path; /* Escaped path name */
265 int fnl; /* file name length */
266 int pnl; /* path name length */
270 * Conversion of sqlite 2 names to sqlite3
272 #define sqlite_last_insert_rowid sqlite3_last_insert_rowid
273 #define sqlite_open sqlite3_open
274 #define sqlite_close sqlite3_close
275 #define sqlite_result sqlite3_result
276 #define sqlite_exec sqlite3_exec
277 #define sqlite_get_table sqlite3_get_table
278 #define sqlite_free_table sqlite3_free_table
282 * "Generic" names for easier conversion
286 #define sql_store_result(x) (x)->result
287 #define sql_free_result(x) my_sqlite_free_table(x)
288 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
289 #define sql_query(x, y) my_sqlite_query((x), (y))
291 #define sql_insert_id(x,y) sqlite3_last_insert_rowid((x)->db)
292 #define sql_close(x) sqlite3_close((x)->db)
294 #define sql_insert_id(x,y) sqlite_last_insert_rowid((x)->db)
295 #define sql_close(x) sqlite_close((x)->db)
297 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
298 #define sql_num_rows(x) (x)->nrow
299 #define sql_data_seek(x, i) (x)->row = (i)
300 #define sql_affected_rows(x) 1
301 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
302 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
303 #define sql_num_fields(x) ((x)->ncolumn)
304 #define sql_batch_start(x,y) my_batch_start(x,y)
305 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
306 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
307 #define SQL_ROW char**
308 #define sql_batch_lock_path_query my_sqlite_batch_lock_query
309 #define sql_batch_lock_filename_query my_sqlite_batch_lock_query
310 #define sql_batch_unlock_tables_query my_sqlite_batch_unlock_query
311 #define sql_batch_fill_filename_query my_sqlite_batch_fill_filename_query
312 #define sql_batch_fill_path_query my_sqlite_batch_fill_path_query
314 /* In cats/sqlite.c */
315 void my_sqlite_free_table(B_DB *mdb);
316 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
317 int my_sqlite_query(B_DB *mdb, const char *cmd);
318 void my_sqlite_field_seek(B_DB *mdb, int field);
319 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
320 extern const char* my_sqlite_batch_lock_query;
321 extern const char* my_sqlite_batch_unlock_query;
322 extern const char* my_sqlite_batch_fill_filename_query;
323 extern const char* my_sqlite_batch_fill_path_query;
330 #define BDB_VERSION 10
335 * This is the "real" definition that should only be
336 * used inside sql.c and associated database interface
342 BQUEUE bq; /* queue control */
343 brwlock_t lock; /* transaction lock */
348 my_ulonglong num_rows;
353 char *db_address; /* host address */
354 char *db_socket; /* socket for local access */
355 int db_port; /* port of host address */
356 int have_insert_id; /* do have insert_id() */
358 POOLMEM *errmsg; /* nicely edited error message */
359 POOLMEM *cmd; /* SQL command string */
360 POOLMEM *cached_path;
361 int cached_path_len; /* length of cached path */
362 uint32_t cached_path_id;
363 int changes; /* changes made to db */
364 POOLMEM *fname; /* Filename only */
365 POOLMEM *path; /* Path only */
366 POOLMEM *esc_name; /* Escaped file name */
367 POOLMEM *esc_path; /* Escaped path name */
368 int fnl; /* file name length */
369 int pnl; /* path name length */
372 #define DB_STATUS int
374 /* "Generic" names for easier conversion */
375 #define sql_store_result(x) mysql_store_result((x)->db)
376 #define sql_use_result(x) mysql_use_result((x)->db)
377 #define sql_free_result(x) my_mysql_free_result(x)
378 #define sql_fetch_row(x) mysql_fetch_row((x)->result)
379 #define sql_query(x, y) mysql_query((x)->db, (y))
380 #define sql_strerror(x) mysql_error((x)->db)
381 #define sql_num_rows(x) mysql_num_rows((x)->result)
382 #define sql_data_seek(x, i) mysql_data_seek((x)->result, (i))
383 #define sql_affected_rows(x) mysql_affected_rows((x)->db)
384 #define sql_insert_id(x,y) mysql_insert_id((x)->db)
385 #define sql_field_seek(x, y) mysql_field_seek((x)->result, (y))
386 #define sql_fetch_field(x) mysql_fetch_field((x)->result)
387 #define sql_num_fields(x) (int)mysql_num_fields((x)->result)
388 #define SQL_ROW MYSQL_ROW
389 #define SQL_FIELD MYSQL_FIELD
391 #define sql_batch_start(x,y) my_batch_start(x,y)
392 #define sql_batch_end(x,y,z) my_batch_end(x,y,z)
393 #define sql_batch_insert(x,y,z) my_batch_insert(x,y,z)
394 #define sql_batch_lock_path_query my_mysql_batch_lock_path_query
395 #define sql_batch_lock_filename_query my_mysql_batch_lock_filename_query
396 #define sql_batch_unlock_tables_query my_mysql_batch_unlock_tables_query
397 #define sql_batch_fill_filename_query my_mysql_batch_fill_filename_query
398 #define sql_batch_fill_path_query my_mysql_batch_fill_path_query
401 extern const char* my_mysql_batch_lock_path_query;
402 extern const char* my_mysql_batch_lock_filename_query;
403 extern const char* my_mysql_batch_unlock_tables_query;
404 extern const char* my_mysql_batch_fill_filename_query;
405 extern const char* my_mysql_batch_fill_path_query;
406 extern void my_mysql_free_result(B_DB *mdb);
410 #ifdef HAVE_POSTGRESQL
412 #define BDB_VERSION 10
414 #include <libpq-fe.h>
416 /* TEMP: the following is taken from select OID, typname from pg_type; */
417 #define IS_NUM(x) ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
418 #define IS_NOT_NULL(x) ((x) == 1)
420 typedef char **POSTGRESQL_ROW;
421 typedef struct pg_field {
425 unsigned int flags; // 1 == not null
430 * This is the "real" definition that should only be
431 * used inside sql.c and associated database interface
434 * P O S T G R E S Q L
437 BQUEUE bq; /* queue control */
438 brwlock_t lock; /* transaction lock */
443 POSTGRESQL_FIELD *fields;
445 int row_size; /* size of malloced rows */
447 int fields_size; /* size of malloced fields */
448 int row_number; /* row number from my_postgresql_data_seek */
449 int field_number; /* field number from my_postgresql_field_seek */
454 char *db_address; /* host address */
455 char *db_socket; /* socket for local access */
456 int db_port; /* port of host address */
457 int have_insert_id; /* do have insert_id() */
459 POOLMEM *errmsg; /* nicely edited error message */
460 POOLMEM *cmd; /* SQL command string */
461 POOLMEM *cached_path;
462 int cached_path_len; /* length of cached path */
463 uint32_t cached_path_id;
464 bool allow_transactions; /* transactions allowed */
465 bool transaction; /* transaction started */
466 int changes; /* changes made to db */
467 POOLMEM *fname; /* Filename only */
468 POOLMEM *path; /* Path only */
469 POOLMEM *esc_name; /* Escaped file name */
470 POOLMEM *esc_path; /* Escaped path name */
471 int fnl; /* file name length */
472 int pnl; /* path name length */
475 void my_postgresql_free_result(B_DB *mdb);
476 POSTGRESQL_ROW my_postgresql_fetch_row (B_DB *mdb);
477 int my_postgresql_query (B_DB *mdb, const char *query);
478 void my_postgresql_data_seek (B_DB *mdb, int row);
479 int my_postgresql_currval (B_DB *mdb, char *table_name);
480 void my_postgresql_field_seek (B_DB *mdb, int row);
481 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
483 int my_postgresql_batch_start(JCR *jcr, B_DB *mdb);
484 int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error);
485 typedef struct ATTR_DBR ATTR_DBR;
486 int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
487 char *my_postgresql_copy_escape(char *dest, char *src, size_t len);
489 extern const char* my_pg_batch_lock_path_query;
490 extern const char* my_pg_batch_lock_filename_query;
491 extern const char* my_pg_batch_unlock_tables_query;
492 extern const char* my_pg_batch_fill_filename_query;
493 extern const char* my_pg_batch_fill_path_query;
495 /* "Generic" names for easier conversion */
496 #define sql_store_result(x) ((x)->result)
497 #define sql_free_result(x) my_postgresql_free_result(x)
498 #define sql_fetch_row(x) my_postgresql_fetch_row(x)
499 #define sql_query(x, y) my_postgresql_query((x), (y))
500 #define sql_close(x) PQfinish((x)->db)
501 #define sql_strerror(x) PQerrorMessage((x)->db)
502 #define sql_num_rows(x) ((unsigned) PQntuples((x)->result))
503 #define sql_data_seek(x, i) my_postgresql_data_seek((x), (i))
504 #define sql_affected_rows(x) ((unsigned) atoi(PQcmdTuples((x)->result)))
505 #define sql_insert_id(x,y) my_postgresql_currval((x), (y))
506 #define sql_field_seek(x, y) my_postgresql_field_seek((x), (y))
507 #define sql_fetch_field(x) my_postgresql_fetch_field(x)
508 #define sql_num_fields(x) ((x)->num_fields)
510 #define sql_batch_start(x,y) my_postgresql_batch_start(x,y)
511 #define sql_batch_end(x,y,z) my_postgresql_batch_end(x,y,z)
512 #define sql_batch_insert(x,y,z) my_postgresql_batch_insert(x,y,z)
513 #define sql_batch_lock_path_query my_pg_batch_lock_path_query
514 #define sql_batch_lock_filename_query my_pg_batch_lock_filename_query
515 #define sql_batch_unlock_tables_query my_pg_batch_unlock_tables_query
516 #define sql_batch_fill_filename_query my_pg_batch_fill_filename_query
517 #define sql_batch_fill_path_query my_pg_batch_fill_path_query
519 #define SQL_ROW POSTGRESQL_ROW
520 #define SQL_FIELD POSTGRESQL_FIELD
522 #else /* USE BACULA DB routines */
524 #define HAVE_BACULA_DB 1
526 /* Change this each time there is some incompatible
527 * file format change!!!!
529 #define BDB_VERSION 13 /* file version number */
532 int bdb_version; /* Version number */
533 uint32_t JobId; /* next Job Id */
534 uint32_t PoolId; /* next Pool Id */
535 uint32_t MediaId; /* next Media Id */
536 uint32_t JobMediaId; /* next JobMedia Id */
537 uint32_t ClientId; /* next Client Id */
538 uint32_t FileSetId; /* nest FileSet Id */
539 time_t time; /* time file written */
543 /* This is the REAL definition for using the
547 BQUEUE bq; /* queue control */
548 /* pthread_mutex_t mutex; */ /* single thread lock */
549 brwlock_t lock; /* transaction lock */
550 int ref_count; /* number of times opened */
551 struct s_control control; /* control file structure */
552 int cfd; /* control file device */
553 FILE *jobfd; /* Jobs records file descriptor */
554 FILE *poolfd; /* Pool records fd */
555 FILE *mediafd; /* Media records fd */
556 FILE *jobmediafd; /* JobMedia records fd */
557 FILE *clientfd; /* Client records fd */
558 FILE *filesetfd; /* FileSet records fd */
559 char *db_name; /* name of database */
560 POOLMEM *errmsg; /* nicely edited error message */
561 POOLMEM *cmd; /* Command string */
562 POOLMEM *cached_path;
563 int cached_path_len; /* length of cached path */
564 uint32_t cached_path_id;
567 #endif /* HAVE_SQLITE3 */
568 #endif /* HAVE_MYSQL */
569 #endif /* HAVE_SQLITE */
570 #endif /* HAVE_POSTGRESQL */
573 /* Use for better error location printing */
574 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
575 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
576 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
577 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
580 #else /* not __SQL_C */
582 /* This is a "dummy" definition for use outside of sql.c
585 int dummy; /* for SunOS compiler */
590 /* ==============================================================
592 * What follows are definitions that are used "globally" for all
593 * the different SQL engines and both inside and external to the
597 extern uint32_t bacula_db_version;
600 * These are the sizes of the current definitions of database
601 * Ids. In general, FileId_t can be set to uint64_t and it
602 * *should* work. Users have reported back that it does work
603 * for PostgreSQL. For the other types, all places in Bacula
604 * have been converted, but no one has actually tested it.
605 * In principle, the only field that really should need to be
606 * 64 bits is the FileId_t
608 typedef uint32_t FileId_t;
609 typedef uint32_t DBId_t; /* general DB id type */
610 typedef uint32_t JobId_t;
615 * Structure used when calling db_get_query_ids()
616 * allows the subroutine to return a list of ids.
618 class dbid_list : public SMARTALLOC {
620 DBId_t *DBId; /* array of DBIds */
621 char *PurgedFiles; /* Array of PurgedFile flags */
622 int num_ids; /* num of ids actually stored */
623 int max_ids; /* size of id array */
624 int num_seen; /* number of ids processed */
625 int tot_ids; /* total to process */
627 dbid_list(); /* in sql.c */
628 ~dbid_list(); /* in sql.c */
634 /* Job information passed to create job record and update
635 * job record at end of job. Note, although this record
636 * contains all the fields found in the Job database record,
637 * it also contains fields found in the JobMedia record.
642 char Job[MAX_NAME_LENGTH]; /* Job unique name */
643 char Name[MAX_NAME_LENGTH]; /* Job base name */
644 int JobType; /* actually char(1) */
645 int JobLevel; /* actually char(1) */
646 int JobStatus; /* actually char(1) */
647 DBId_t ClientId; /* Id of client */
648 DBId_t PoolId; /* Id of pool */
649 DBId_t FileSetId; /* Id of FileSet */
650 DBId_t PriorJobId; /* Id of migrated (prior) job */
651 time_t SchedTime; /* Time job scheduled */
652 time_t StartTime; /* Job start time */
653 time_t EndTime; /* Job termination time of orig job */
654 time_t RealEndTime; /* Job termination time of this job */
655 utime_t JobTDate; /* Backup time/date in seconds */
656 uint32_t VolSessionId;
657 uint32_t VolSessionTime;
660 uint32_t JobMissingFiles;
665 /* Note, FirstIndex, LastIndex, Start/End File and Block
666 * are only used in the JobMedia record.
668 uint32_t FirstIndex; /* First index this Volume */
669 uint32_t LastIndex; /* Last index this Volume */
675 char cSchedTime[MAX_TIME_LENGTH];
676 char cStartTime[MAX_TIME_LENGTH];
677 char cEndTime[MAX_TIME_LENGTH];
678 char cRealEndTime[MAX_TIME_LENGTH];
679 /* Extra stuff not in DB */
680 int limit; /* limit records to display */
684 /* Job Media information used to create the media records
685 * for each Volume used for the job.
687 /* JobMedia record */
688 struct JOBMEDIA_DBR {
689 DBId_t JobMediaId; /* record id */
690 JobId_t JobId; /* JobId */
691 DBId_t MediaId; /* MediaId */
692 uint32_t FirstIndex; /* First index this Volume */
693 uint32_t LastIndex; /* Last index this Volume */
694 uint32_t StartFile; /* File for start of data */
695 uint32_t EndFile; /* End file on Volume */
696 uint32_t StartBlock; /* start block on tape */
697 uint32_t EndBlock; /* last block */
698 uint32_t Copy; /* identical copy */
702 /* Volume Parameter structure */
704 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
705 char MediaType[MAX_NAME_LENGTH]; /* Media Type */
706 char Storage[MAX_NAME_LENGTH]; /* Storage name */
707 uint32_t VolIndex; /* Volume seqence no. */
708 uint32_t FirstIndex; /* First index this Volume */
709 uint32_t LastIndex; /* Last index this Volume */
710 uint32_t StartFile; /* File for start of data */
711 uint32_t EndFile; /* End file on Volume */
712 uint32_t StartBlock; /* start block on tape */
713 uint32_t EndBlock; /* last block */
714 int32_t Slot; /* Slot */
715 // uint32_t Copy; /* identical copy */
716 // uint32_t Stripe; /* RAIT strip number */
720 /* Attributes record -- NOT same as in database because
721 * in general, this "record" creates multiple database
722 * records (e.g. pathname, filename, fileattributes).
725 char *fname; /* full path & filename */
726 char *link; /* link if any */
727 char *attr; /* attributes statp */
740 /* File record -- same format as database */
749 char Digest[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
750 int DigestType; /* NO_SIG/MD5_SIG/SHA1_SIG */
753 /* Pool record -- same format as database */
756 char Name[MAX_NAME_LENGTH]; /* Pool name */
757 uint32_t NumVols; /* total number of volumes */
758 uint32_t MaxVols; /* max allowed volumes */
759 int32_t LabelType; /* Bacula/ANSI/IBM */
760 int32_t UseOnce; /* set to use once only */
761 int32_t UseCatalog; /* set to use catalog */
762 int32_t AcceptAnyVolume; /* set to accept any volume sequence */
763 int32_t AutoPrune; /* set to prune automatically */
764 int32_t Recycle; /* default Vol recycle flag */
765 utime_t VolRetention; /* retention period in seconds */
766 utime_t VolUseDuration; /* time in secs volume can be used */
767 uint32_t MaxVolJobs; /* Max Jobs on Volume */
768 uint32_t MaxVolFiles; /* Max files on Volume */
769 uint64_t MaxVolBytes; /* Max bytes on Volume */
770 DBId_t RecyclePoolId; /* RecyclePool destination when media is purged */
771 char PoolType[MAX_NAME_LENGTH];
772 char LabelFormat[MAX_NAME_LENGTH];
773 /* Extra stuff not in DB */
780 char Name[MAX_NAME_LENGTH]; /* Device name */
781 DBId_t MediaTypeId; /* MediaType */
782 DBId_t StorageId; /* Storage id if autochanger */
783 uint32_t DevMounts; /* Number of times mounted */
784 uint32_t DevErrors; /* Number of read/write errors */
785 uint64_t DevReadBytes; /* Number of bytes read */
786 uint64_t DevWriteBytes; /* Number of bytew written */
787 uint64_t DevReadTime; /* time spent reading volume */
788 uint64_t DevWriteTime; /* time spent writing volume */
789 uint64_t DevReadTimeSincCleaning; /* read time since cleaning */
790 uint64_t DevWriteTimeSincCleaning; /* write time since cleaning */
791 time_t CleaningDate; /* time last cleaned */
792 utime_t CleaningPeriod; /* time between cleanings */
798 char Name[MAX_NAME_LENGTH]; /* Device name */
799 int AutoChanger; /* Set if autochanger */
801 /* Not in database */
802 bool created; /* set if created by db_create ... */
805 class MEDIATYPE_DBR {
808 char MediaType[MAX_NAME_LENGTH]; /* MediaType string */
809 int ReadOnly; /* Set if read-only */
813 /* Media record -- same as the database */
815 DBId_t MediaId; /* Unique volume id */
816 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
817 char MediaType[MAX_NAME_LENGTH]; /* Media type */
818 DBId_t PoolId; /* Pool id */
819 time_t FirstWritten; /* Time Volume first written this usage */
820 time_t LastWritten; /* Time Volume last written */
821 time_t LabelDate; /* Date/Time Volume labeled */
822 time_t InitialWrite; /* Date/Time Volume first written */
823 int32_t LabelType; /* Label (Bacula/ANSI/IBM) */
824 uint32_t VolJobs; /* number of jobs on this medium */
825 uint32_t VolFiles; /* Number of files */
826 uint32_t VolBlocks; /* Number of blocks */
827 uint32_t VolMounts; /* Number of times mounted */
828 uint32_t VolErrors; /* Number of read/write errors */
829 uint32_t VolWrites; /* Number of writes */
830 uint32_t VolReads; /* Number of reads */
831 uint64_t VolBytes; /* Number of bytes written */
832 uint32_t VolParts; /* Number of parts written */
833 uint64_t MaxVolBytes; /* Max bytes to write to Volume */
834 uint64_t VolCapacityBytes; /* capacity estimate */
835 uint64_t VolReadTime; /* time spent reading volume */
836 uint64_t VolWriteTime; /* time spent writing volume */
837 utime_t VolRetention; /* Volume retention in seconds */
838 utime_t VolUseDuration; /* time in secs volume can be used */
839 uint32_t MaxVolJobs; /* Max Jobs on Volume */
840 uint32_t MaxVolFiles; /* Max files on Volume */
841 int32_t Recycle; /* recycle yes/no */
842 int32_t Slot; /* slot in changer */
843 int32_t Enabled; /* 0=disabled, 1=enabled, 2=archived */
844 int32_t InChanger; /* Volume currently in changer */
845 DBId_t StorageId; /* Storage record Id */
846 uint32_t EndFile; /* Last file on volume */
847 uint32_t EndBlock; /* Last block on volume */
848 uint32_t RecycleCount; /* Number of times recycled */
849 char VolStatus[20]; /* Volume status */
850 DBId_t DeviceId; /* Device where Vol last written */
851 DBId_t LocationId; /* Where Volume is -- user defined */
852 DBId_t ScratchPoolId; /* Where to move if scratch */
853 DBId_t RecyclePoolId; /* Where to move when recycled */
854 /* Extra stuff not in DB */
855 faddr_t rec_addr; /* found record address */
856 /* Since the database returns times as strings, this is how we pass
859 char cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
860 char cLastWritten[MAX_TIME_LENGTH]; /* LastWritten returned from DB */
861 char cLabelDate[MAX_TIME_LENGTH]; /* LabelData returned from DB */
862 char cInitialWrite[MAX_TIME_LENGTH]; /* InitialWrite returned from DB */
863 bool set_first_written;
867 /* Client record -- same as the database */
869 DBId_t ClientId; /* Unique Client id */
871 utime_t FileRetention;
872 utime_t JobRetention;
873 char Name[MAX_NAME_LENGTH]; /* Client name */
874 char Uname[256]; /* Uname for client */
877 /* Counter record as in database */
879 char Counter[MAX_NAME_LENGTH];
882 int32_t CurrentValue;
883 char WrapCounter[MAX_NAME_LENGTH];
887 /* FileSet record -- same as the database */
889 DBId_t FileSetId; /* Unique FileSet id */
890 char FileSet[MAX_NAME_LENGTH]; /* FileSet name */
891 char MD5[50]; /* MD5 signature of include/exclude */
892 time_t CreateTime; /* date created */
894 * This is where we return CreateTime
896 char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
897 /* Not in DB but returned by db_create_fileset() */
898 bool created; /* set when record newly created */
901 /* Call back context for getting a 32/64 bit value from the database */
902 struct db_int64_ctx {
903 int64_t value; /* value returned */
904 int count; /* number of values seen */
910 #include "sql_cmds.h"
913 * Some functions exported by sql.c for use within the
916 void list_result(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
917 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
918 int get_sql_record_max(JCR *jcr, B_DB *mdb);
919 bool check_tables_version(JCR *jcr, B_DB *mdb);
920 void _db_unlock(const char *file, int line, B_DB *mdb);
921 void _db_lock(const char *file, int line, B_DB *mdb);
922 const char *db_get_type(void);
924 void print_dashes(B_DB *mdb);
925 void print_result(B_DB *mdb);
926 int QueryDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
927 int InsertDB(const char *file, int line, JCR *jcr, B_DB *db, char *select_cmd);
928 int DeleteDB(const char *file, int line, JCR *jcr, B_DB *db, char *delete_cmd);
929 int UpdateDB(const char *file, int line, JCR *jcr, B_DB *db, char *update_cmd);
930 void split_path_and_file(JCR *jcr, B_DB *mdb, const char *fname);
931 #endif /* __SQL_H_ */