6 * Anyone who accesses the database will need to include
9 * This file contains definitions common to sql.c and
10 * the external world, and definitions destined only
11 * for the external world. This is control with
12 * the define __SQL_C, which is defined only in sql.c
18 Copyright (C) 2000-2003 Kern Sibbald and John Walker
20 This program is free software; you can redistribute it and/or
21 modify it under the terms of the GNU General Public License as
22 published by the Free Software Foundation; either version 2 of
23 the License, or (at your option) any later version.
25 This program is distributed in the hope that it will be useful,
26 but WITHOUT ANY WARRANTY; without even the implied warranty of
27 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
28 General Public License for more details.
30 You should have received a copy of the GNU General Public
31 License along with this program; if not, write to the Free
32 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
41 typedef void (DB_LIST_HANDLER)(void *, char *);
42 typedef int (DB_RESULT_HANDLER)(void *, int, char **);
44 #define db_lock(mdb) _db_lock(__FILE__, __LINE__, mdb)
45 #define db_unlock(mdb) _db_unlock(__FILE__, __LINE__, mdb)
55 /* Define opaque structure for sqlite */
60 #define IS_NUM(x) ((x) == 1)
61 #define IS_NOT_NULL(x) ((x) == 1)
63 typedef struct s_sql_field {
64 char *name; /* name of column */
65 int length; /* length */
66 int max_length; /* max length */
67 uint32_t type; /* type */
68 uint32_t flags; /* flags */
72 * This is the "real" definition that should only be
73 * used inside sql.c and associated database interface
78 BQUEUE bq; /* queue control */
79 brwlock_t lock; /* transaction lock */
83 int nrow; /* nrow returned from sqlite */
84 int ncolumn; /* ncolum returned from sqlite */
85 int num_rows; /* used by code */
86 int row; /* seek row */
87 int have_insert_id; /* do not have insert id */
88 int fields_defined; /* set when fields defined */
89 int field; /* seek field */
90 SQL_FIELD **fields; /* defined fields */
94 char *db_address; /* host name address */
95 char *db_socket; /* socket for local access */
97 int db_port; /* port for host name address */
99 char *sqlite_errmsg; /* error message returned by sqlite */
100 POOLMEM *errmsg; /* nicely edited error message */
101 POOLMEM *cmd; /* SQL command string */
102 POOLMEM *cached_path; /* cached path name */
103 int cached_path_len; /* length of cached path */
104 uint32_t cached_path_id; /* cached path id */
105 int transaction; /* transaction started */
106 int changes; /* changes during transaction */
107 POOLMEM *fname; /* Filename only */
108 POOLMEM *path; /* Path only */
109 POOLMEM *esc_name; /* Escaped file/path name */
110 int fnl; /* file name length */
111 int pnl; /* path name length */
116 * "Generic" names for easier conversion
120 #define sql_store_result(x) (x)->result
121 #define sql_free_result(x) my_sqlite_free_table(x)
122 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
123 #define sql_query(x, y) my_sqlite_query((x), (y))
124 #define sql_close(x) sqlite_close((x)->db)
125 #define sql_strerror(x) (x)->sqlite_errmsg?(x)->sqlite_errmsg:"unknown"
126 #define sql_num_rows(x) (x)->nrow
127 #define sql_data_seek(x, i) (x)->row = (i)
128 #define sql_affected_rows(x) 1
129 #define sql_insert_id(x,y) sqlite_last_insert_rowid((x)->db)
130 #define sql_field_seek(x, y) my_sqlite_field_seek((x), (y))
131 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
132 #define sql_num_fields(x) ((x)->ncolumn)
133 #define SQL_ROW char**
137 /* In cats/sqlite.c */
138 void my_sqlite_free_table(B_DB *mdb);
139 SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
140 int my_sqlite_query(B_DB *mdb, char *cmd);
141 void my_sqlite_field_seek(B_DB *mdb, int field);
142 SQL_FIELD *my_sqlite_fetch_field(B_DB *mdb);
149 #define BDB_VERSION 7
154 * This is the "real" definition that should only be
155 * used inside sql.c and associated database interface
160 typedef struct s_db {
161 BQUEUE bq; /* queue control */
162 brwlock_t lock; /* transaction lock */
167 my_ulonglong num_rows;
172 char *db_address; /* host address */
173 char *db_socket; /* socket for local access */
174 int db_port; /* port of host address */
175 int have_insert_id; /* do have insert_id() */
177 POOLMEM *errmsg; /* nicely edited error message */
178 POOLMEM *cmd; /* SQL command string */
179 POOLMEM *cached_path;
180 int cached_path_len; /* length of cached path */
181 uint32_t cached_path_id;
182 int changes; /* changes made to db */
183 POOLMEM *fname; /* Filename only */
184 POOLMEM *path; /* Path only */
185 POOLMEM *esc_name; /* Escaped file/path name */
186 int fnl; /* file name length */
187 int pnl; /* path name length */
190 #define DB_STATUS int
192 /* "Generic" names for easier conversion */
193 #define sql_store_result(x) mysql_store_result((x)->db)
194 #define sql_free_result(x) mysql_free_result((x)->result)
195 #define sql_fetch_row(x) mysql_fetch_row((x)->result)
196 #define sql_query(x, y) mysql_query((x)->db, (y))
197 #define sql_close(x) mysql_close((x)->db)
198 #define sql_strerror(x) mysql_error((x)->db)
199 #define sql_num_rows(x) mysql_num_rows((x)->result)
200 #define sql_data_seek(x, i) mysql_data_seek((x)->result, (i))
201 #define sql_affected_rows(x) mysql_affected_rows((x)->db)
202 #define sql_insert_id(x,y) mysql_insert_id((x)->db)
203 #define sql_field_seek(x, y) mysql_field_seek((x)->result, (y))
204 #define sql_fetch_field(x) mysql_fetch_field((x)->result)
205 #define sql_num_fields(x) (int)mysql_num_fields((x)->result)
206 #define SQL_ROW MYSQL_ROW
207 #define SQL_FIELD MYSQL_FIELD
211 #ifdef HAVE_POSTGRESQL
213 #define BDB_VERSION 7
215 #include <libpq-fe.h>
217 /* TEMP: the following is taken from select OID, typname from pg_type; */
218 #define IS_NUM(x) ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701)
219 #define IS_NOT_NULL(x) ((x) == 1)
221 typedef char **POSTGRESQL_ROW;
222 typedef struct pg_field {
226 unsigned int flags; // 1 == not null
231 * This is the "real" definition that should only be
232 * used inside sql.c and associated database interface
235 * P O S T G R E S Q L
237 typedef struct s_db {
238 BQUEUE bq; /* queue control */
239 brwlock_t lock; /* transaction lock */
244 POSTGRESQL_FIELD field;
247 int row_number; /* what row number did we get via my_postgresql_data_seek? */
248 int field_number; /* what field number did we get via my_postgresql_field_seek? */
253 char *db_address; /* host address */
254 char *db_socket; /* socket for local access */
255 int db_port; /* port of host address */
256 int have_insert_id; /* do have insert_id() */
258 POOLMEM *errmsg; /* nicely edited error message */
259 POOLMEM *cmd; /* SQL command string */
260 POOLMEM *cached_path;
261 int cached_path_len; /* length of cached path */
262 uint32_t cached_path_id;
263 int changes; /* changes made to db */
264 POOLMEM *fname; /* Filename only */
265 POOLMEM *path; /* Path only */
266 POOLMEM *esc_name; /* Escaped file/path name */
267 int fnl; /* file name length */
268 int pnl; /* path name length */
271 void my_postgresql_free_result(B_DB *mdb);
272 POSTGRESQL_ROW my_postgresql_fetch_row (B_DB *mdb);
273 int my_postgresql_query (B_DB *mdb, char *query);
274 void my_postgresql_data_seek (B_DB *mdb, int row);
275 int my_postgresql_currval (B_DB *mdb, char *table_name);
276 void my_postgresql_field_seek (B_DB *mdb, int row);
277 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
280 /* "Generic" names for easier conversion */
281 #define sql_store_result(x) ((x)->result)
282 #define sql_free_result(x) my_postgresql_free_result(x)
283 #define sql_fetch_row(x) my_postgresql_fetch_row(x)
284 #define sql_query(x, y) my_postgresql_query((x), (y))
285 #define sql_close(x) PQfinish((x)->db)
286 #define sql_strerror(x) PQresultErrorMessage((x)->result)
287 #define sql_num_rows(x) ((unsigned) PQntuples((x)->result))
288 #define sql_data_seek(x, i) my_postgresql_data_seek((x), (i))
289 #define sql_affected_rows(x) ((unsigned) atoi(PQcmdTuples((x)->result)))
290 #define sql_insert_id(x,y) my_postgresql_currval((x), (y))
291 #define sql_field_seek(x, y) my_postgresql_field_seek((x), (y))
292 #define sql_fetch_field(x) my_postgresql_fetch_field(x)
293 #define sql_num_fields(x) ((x)->num_fields)
294 #define SQL_ROW POSTGRESQL_ROW
295 #define SQL_FIELD POSTGRESQL_FIELD
297 #else /* USE BACULA DB routines */
299 #define HAVE_BACULA_DB 1
301 /* Change this each time there is some incompatible
302 * file format change!!!!
304 #define BDB_VERSION 12 /* file version number */
307 int bdb_version; /* Version number */
308 uint32_t JobId; /* next Job Id */
309 uint32_t PoolId; /* next Pool Id */
310 uint32_t MediaId; /* next Media Id */
311 uint32_t JobMediaId; /* next JobMedia Id */
312 uint32_t ClientId; /* next Client Id */
313 uint32_t FileSetId; /* nest FileSet Id */
314 time_t time; /* time file written */
318 /* This is the REAL definition for using the
321 typedef struct s_db {
322 BQUEUE bq; /* queue control */
323 /* pthread_mutex_t mutex; */ /* single thread lock */
324 brwlock_t lock; /* transaction lock */
325 int ref_count; /* number of times opened */
326 struct s_control control; /* control file structure */
327 int cfd; /* control file device */
328 FILE *jobfd; /* Jobs records file descriptor */
329 FILE *poolfd; /* Pool records fd */
330 FILE *mediafd; /* Media records fd */
331 FILE *jobmediafd; /* JobMedia records fd */
332 FILE *clientfd; /* Client records fd */
333 FILE *filesetfd; /* FileSet records fd */
334 char *db_name; /* name of database */
335 POOLMEM *errmsg; /* nicely edited error message */
336 POOLMEM *cmd; /* Command string */
337 POOLMEM *cached_path;
338 int cached_path_len; /* length of cached path */
339 uint32_t cached_path_id;
342 #endif /* HAVE_MYSQL */
343 #endif /* HAVE_SQLITE */
344 #endif /* HAVE_POSTGRESQL */
346 /* Use for better error location printing */
347 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
348 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
349 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
350 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
353 #else /* not __SQL_C */
355 /* This is a "dummy" definition for use outside of sql.c
357 typedef struct s_db {
358 int dummy; /* for SunOS compiler */
363 extern uint32_t bacula_db_version;
365 /* ***FIXME*** FileId_t should *really* be uint64_t
366 * but at the current time, this breaks MySQL.
368 typedef uint32_t FileId_t;
369 typedef uint32_t DBId_t; /* general DB id type */
370 typedef uint32_t JobId_t;
375 /* Job information passed to create job record and update
376 * job record at end of job. Note, although this record
377 * contains all the fields found in the Job database record,
378 * it also contains fields found in the JobMedia record.
383 char Job[MAX_NAME_LENGTH]; /* Job unique name */
384 char Name[MAX_NAME_LENGTH]; /* Job base name */
385 int Type; /* actually char(1) */
386 int Level; /* actually char(1) */
387 int JobStatus; /* actually char(1) */
388 uint32_t ClientId; /* Id of client */
389 uint32_t PoolId; /* Id of pool */
390 uint32_t FileSetId; /* Id of FileSet */
391 time_t SchedTime; /* Time job scheduled */
392 time_t StartTime; /* Job start time */
393 time_t EndTime; /* Job termination time */
394 utime_t JobTDate; /* Backup time/date in seconds */
395 uint32_t VolSessionId;
396 uint32_t VolSessionTime;
399 uint32_t JobMissingFiles;
402 /* Note, FirstIndex, LastIndex, Start/End File and Block
403 * are only used in the JobMedia record.
405 uint32_t FirstIndex; /* First index this Volume */
406 uint32_t LastIndex; /* Last index this Volume */
412 char cSchedTime[MAX_TIME_LENGTH];
413 char cStartTime[MAX_TIME_LENGTH];
414 char cEndTime[MAX_TIME_LENGTH];
415 /* Extra stuff not in DB */
419 /* Job Media information used to create the media records
420 * for each Volume used for the job.
422 /* JobMedia record */
423 struct JOBMEDIA_DBR {
424 uint32_t JobMediaId; /* record id */
425 JobId_t JobId; /* JobId */
426 uint32_t MediaId; /* MediaId */
427 uint32_t FirstIndex; /* First index this Volume */
428 uint32_t LastIndex; /* Last index this Volume */
429 uint32_t StartFile; /* File for start of data */
430 uint32_t EndFile; /* End file on Volume */
431 uint32_t StartBlock; /* start block on tape */
432 uint32_t EndBlock; /* last block */
436 /* Volume Parameter structure */
438 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
439 uint32_t VolIndex; /* Volume seqence no. */
440 uint32_t FirstIndex; /* First index this Volume */
441 uint32_t LastIndex; /* Last index this Volume */
442 uint32_t StartFile; /* File for start of data */
443 uint32_t EndFile; /* End file on Volume */
444 uint32_t StartBlock; /* start block on tape */
445 uint32_t EndBlock; /* last block */
449 /* Attributes record -- NOT same as in database because
450 * in general, this "record" creates multiple database
451 * records (e.g. pathname, filename, fileattributes).
454 char *fname; /* full path & filename */
455 char *link; /* link if any */
456 char *attr; /* attributes statp */
467 /* File record -- same format as database */
478 int SigType; /* NO_SIG/MD5_SIG/SHA1_SIG */
481 /* Pool record -- same format as database */
484 char Name[MAX_NAME_LENGTH]; /* Pool name */
485 uint32_t NumVols; /* total number of volumes */
486 uint32_t MaxVols; /* max allowed volumes */
487 int32_t UseOnce; /* set to use once only */
488 int32_t UseCatalog; /* set to use catalog */
489 int32_t AcceptAnyVolume; /* set to accept any volume sequence */
490 int32_t AutoPrune; /* set to prune automatically */
491 int32_t Recycle; /* default Vol recycle flag */
492 utime_t VolRetention; /* retention period in seconds */
493 utime_t VolUseDuration; /* time in secs volume can be used */
494 uint32_t MaxVolJobs; /* Max Jobs on Volume */
495 uint32_t MaxVolFiles; /* Max files on Volume */
496 uint64_t MaxVolBytes; /* Max bytes on Volume */
497 char PoolType[MAX_NAME_LENGTH];
498 char LabelFormat[MAX_NAME_LENGTH];
499 /* Extra stuff not in DB */
503 /* Media record -- same as the database */
505 uint32_t MediaId; /* Unique volume id */
506 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
507 char MediaType[MAX_NAME_LENGTH]; /* Media type */
508 uint32_t PoolId; /* Pool id */
509 time_t FirstWritten; /* Time Volume first written */
510 time_t LastWritten; /* Time Volume last written */
511 time_t LabelDate; /* Date/Time Volume labeled */
512 uint32_t VolJobs; /* number of jobs on this medium */
513 uint32_t VolFiles; /* Number of files */
514 uint32_t VolBlocks; /* Number of blocks */
515 uint32_t VolMounts; /* Number of times mounted */
516 uint32_t VolErrors; /* Number of read/write errors */
517 uint32_t VolWrites; /* Number of writes */
518 uint32_t VolReads; /* Number of reads */
519 uint64_t VolBytes; /* Number of bytes written */
520 uint64_t MaxVolBytes; /* Max bytes to write to Volume */
521 uint64_t VolCapacityBytes; /* capacity estimate */
522 uint64_t VolReadTime; /* time spent reading volume */
523 uint64_t VolWriteTime; /* time spent writing volume */
524 utime_t VolRetention; /* Volume retention in seconds */
525 utime_t VolUseDuration; /* time in secs volume can be used */
526 uint32_t MaxVolJobs; /* Max Jobs on Volume */
527 uint32_t MaxVolFiles; /* Max files on Volume */
528 int32_t Recycle; /* recycle yes/no */
529 int32_t Slot; /* slot in changer */
530 int32_t InChanger; /* Volume currently in changer */
531 char VolStatus[20]; /* Volume status */
532 /* Extra stuff not in DB */
533 faddr_t rec_addr; /* found record address */
534 /* Since the database returns times as strings, this is how we pass
537 char cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
538 char cLastWritten[MAX_TIME_LENGTH]; /* LastWritten returned from DB */
539 char cLabelData[MAX_TIME_LENGTH]; /* LabelData returned from DB */
542 /* Client record -- same as the database */
544 uint32_t ClientId; /* Unique Client id */
546 utime_t FileRetention;
547 utime_t JobRetention;
548 char Name[MAX_NAME_LENGTH]; /* Client name */
549 char Uname[256]; /* Uname for client */
552 /* Counter record as in database */
554 char Counter[MAX_NAME_LENGTH];
557 int32_t CurrentValue;
558 char WrapCounter[MAX_NAME_LENGTH];
562 /* FileSet record -- same as the database */
564 uint32_t FileSetId; /* Unique FileSet id */
565 char FileSet[MAX_NAME_LENGTH]; /* FileSet name */
566 char MD5[50]; /* MD5 signature of include/exclude */
567 time_t CreateTime; /* date created */
569 * This is where we return CreateTime
571 char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
572 /* Not in DB but returned by db_create_fileset() */
573 bool created; /* set when record newly created */
582 * Some functions exported by sql.c for use withing the
585 void list_result(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx, e_list_type type);
586 void list_dashes(B_DB *mdb, DB_LIST_HANDLER *send, void *ctx);
587 int get_sql_record_max(JCR *jcr, B_DB *mdb);
588 int check_tables_version(JCR *jcr, B_DB *mdb);
589 void _db_unlock(char *file, int line, B_DB *mdb);
590 void _db_lock(char *file, int line, B_DB *mdb);
592 #endif /* __SQL_H_ */