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 uint32_t length; /* length */
66 uint32_t 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) (unsigned)((x)->ncolumn)
133 #define SQL_ROW char**
137 /* In cats/sqlite.c */
138 extern int my_sqlite_query(B_DB *mdb, char *cmd);
139 extern SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
140 extern void my_sqlite_free_table(B_DB *mdb);
146 #define BDB_VERSION 7
151 * This is the "real" definition that should only be
152 * used inside sql.c and associated database interface
157 typedef struct s_db {
158 BQUEUE bq; /* queue control */
159 brwlock_t lock; /* transaction lock */
164 my_ulonglong num_rows;
169 char *db_address; /* host address */
170 char *db_socket; /* socket for local access */
171 int db_port; /* port of host address */
172 int have_insert_id; /* do have insert_id() */
174 POOLMEM *errmsg; /* nicely edited error message */
175 POOLMEM *cmd; /* SQL command string */
176 POOLMEM *cached_path;
177 int cached_path_len; /* length of cached path */
178 uint32_t cached_path_id;
179 int changes; /* changes made to db */
180 POOLMEM *fname; /* Filename only */
181 POOLMEM *path; /* Path only */
182 POOLMEM *esc_name; /* Escaped file/path name */
183 int fnl; /* file name length */
184 int pnl; /* path name length */
187 #define DB_STATUS int
189 /* "Generic" names for easier conversion */
190 #define sql_store_result(x) mysql_store_result((x)->db)
191 #define sql_free_result(x) mysql_free_result((x)->result)
192 #define sql_fetch_row(x) mysql_fetch_row((x)->result)
193 #define sql_query(x, y) mysql_query((x)->db, (y))
194 #define sql_close(x) mysql_close((x)->db)
195 #define sql_strerror(x) mysql_error((x)->db)
196 #define sql_num_rows(x) mysql_num_rows((x)->result)
197 #define sql_data_seek(x, i) mysql_data_seek((x)->result, (i))
198 #define sql_affected_rows(x) mysql_affected_rows((x)->db)
199 #define sql_insert_id(x,y) mysql_insert_id((x)->db)
200 #define sql_field_seek(x, y) mysql_field_seek((x)->result, (y))
201 #define sql_fetch_field(x) mysql_fetch_field((x)->result)
202 #define sql_num_fields(x) mysql_num_fields((x)->result)
203 #define SQL_ROW MYSQL_ROW
204 #define SQL_FIELD MYSQL_FIELD
208 #ifdef HAVE_POSTGRESQL
210 #define BDB_VERSION 7
212 #include <libpq-fe.h>
214 /* TEMP: the following is taken from select OID, typname from pg_type; */
215 #define IS_NUM(x) ((x) == 20 || (x) == 21 || (x) == 23 || (x) == 700 || (x) == 701 )
216 #define IS_NOT_NULL(x) ((x) == 1)
218 typedef char **POSTGRESQL_ROW;
219 typedef struct pg_field {
221 unsigned int max_length;
222 unsigned int type; // 1 = number
223 unsigned int flags; // 1 == not null
228 * This is the "real" definition that should only be
229 * used inside sql.c and associated database interface
232 * P O S T G R E S Q L
234 typedef struct s_db {
235 BQUEUE bq; /* queue control */
236 brwlock_t lock; /* transaction lock */
241 POSTGRESQL_FIELD field;
244 int row_number; /* what row number did we get via my_postgresql_data_seek? */
245 int field_number; /* what field number did we get via my_postgresql_field_seek? */
250 char *db_address; /* host address */
251 char *db_socket; /* socket for local access */
252 int db_port; /* port of host address */
253 int have_insert_id; /* do have insert_id() */
255 POOLMEM *errmsg; /* nicely edited error message */
256 POOLMEM *cmd; /* SQL command string */
257 POOLMEM *cached_path;
258 int cached_path_len; /* length of cached path */
259 uint32_t cached_path_id;
260 int changes; /* changes made to db */
261 POOLMEM *fname; /* Filename only */
262 POOLMEM *path; /* Path only */
263 POOLMEM *esc_name; /* Escaped file/path name */
264 int fnl; /* file name length */
265 int pnl; /* path name length */
268 POSTGRESQL_ROW my_postgresql_fetch_row (B_DB *mdb);
269 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb);
271 void my_postgresql_data_seek (B_DB *mdb, int row);
272 void my_postgresql_field_seek (B_DB *mdb, int row);
273 int my_postgresql_query (B_DB *mdb, char *query);
274 void my_postgresql_free_result(B_DB *mdb);
275 int my_postgresql_currval (B_DB *mdb, char *table_name);
278 /* "Generic" names for easier conversion */
279 #define sql_store_result(x) ((x)->result)
280 #define sql_free_result(x) my_postgresql_free_result(x)
281 #define sql_fetch_row(x) my_postgresql_fetch_row(x)
282 #define sql_query(x, y) my_postgresql_query((x), (y))
283 #define sql_close(x) PQfinish((x)->db)
284 #define sql_strerror(x) PQresultErrorMessage((x)->result)
285 #define sql_num_rows(x) ((unsigned) PQntuples((x)->result))
286 #define sql_data_seek(x, i) my_postgresql_data_seek((x), (i))
287 #define sql_affected_rows(x) ((unsigned) atoi(PQcmdTuples((x)->result)))
288 #define sql_insert_id(x,y) my_postgresql_currval((x), (y))
289 #define sql_field_seek(x, y) my_postgresql_field_seek((x), (y))
290 #define sql_fetch_field(x) my_postgresql_fetch_field(x)
291 #define sql_num_fields(x) (unsigned) (x)->num_fields
292 #define SQL_ROW POSTGRESQL_ROW
293 #define SQL_FIELD POSTGRESQL_FIELD
295 #else /* USE BACULA DB routines */
297 #define HAVE_BACULA_DB 1
299 /* Change this each time there is some incompatible
300 * file format change!!!!
302 #define BDB_VERSION 12 /* file version number */
305 int bdb_version; /* Version number */
306 uint32_t JobId; /* next Job Id */
307 uint32_t PoolId; /* next Pool Id */
308 uint32_t MediaId; /* next Media Id */
309 uint32_t JobMediaId; /* next JobMedia Id */
310 uint32_t ClientId; /* next Client Id */
311 uint32_t FileSetId; /* nest FileSet Id */
312 time_t time; /* time file written */
316 /* This is the REAL definition for using the
319 typedef struct s_db {
320 BQUEUE bq; /* queue control */
321 /* pthread_mutex_t mutex; */ /* single thread lock */
322 brwlock_t lock; /* transaction lock */
323 int ref_count; /* number of times opened */
324 struct s_control control; /* control file structure */
325 int cfd; /* control file device */
326 FILE *jobfd; /* Jobs records file descriptor */
327 FILE *poolfd; /* Pool records fd */
328 FILE *mediafd; /* Media records fd */
329 FILE *jobmediafd; /* JobMedia records fd */
330 FILE *clientfd; /* Client records fd */
331 FILE *filesetfd; /* FileSet records fd */
332 char *db_name; /* name of database */
333 POOLMEM *errmsg; /* nicely edited error message */
334 POOLMEM *cmd; /* Command string */
335 POOLMEM *cached_path;
336 int cached_path_len; /* length of cached path */
337 uint32_t cached_path_id;
340 #endif /* HAVE_MYSQL */
341 #endif /* HAVE_SQLITE */
342 #endif /* HAVE_POSTGRESQL */
344 /* Use for better error location printing */
345 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
346 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
347 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
348 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
351 #else /* not __SQL_C */
353 /* This is a "dummy" definition for use outside of sql.c
355 typedef struct s_db {
356 int dummy; /* for SunOS compiler */
361 extern uint32_t bacula_db_version;
363 /* ***FIXME*** FileId_t should be uint64_t */
364 typedef uint32_t FileId_t;
365 typedef uint32_t DBId_t; /* general DB id type */
366 typedef uint32_t JobId_t;
371 /* Job information passed to create job record and update
372 * job record at end of job. Note, although this record
373 * contains all the fields found in the Job database record,
374 * it also contains fields found in the JobMedia record.
379 char Job[MAX_NAME_LENGTH]; /* Job unique name */
380 char Name[MAX_NAME_LENGTH]; /* Job base name */
381 int Type; /* actually char(1) */
382 int Level; /* actually char(1) */
383 int JobStatus; /* actually char(1) */
384 uint32_t ClientId; /* Id of client */
385 uint32_t PoolId; /* Id of pool */
386 uint32_t FileSetId; /* Id of FileSet */
387 time_t SchedTime; /* Time job scheduled */
388 time_t StartTime; /* Job start time */
389 time_t EndTime; /* Job termination time */
390 utime_t JobTDate; /* Backup time/date in seconds */
391 uint32_t VolSessionId;
392 uint32_t VolSessionTime;
395 uint32_t JobMissingFiles;
398 /* Note, FirstIndex, LastIndex, Start/End File and Block
399 * are only used in the JobMedia record.
401 uint32_t FirstIndex; /* First index this Volume */
402 uint32_t LastIndex; /* Last index this Volume */
408 char cSchedTime[MAX_TIME_LENGTH];
409 char cStartTime[MAX_TIME_LENGTH];
410 char cEndTime[MAX_TIME_LENGTH];
411 /* Extra stuff not in DB */
415 /* Job Media information used to create the media records
416 * for each Volume used for the job.
418 /* JobMedia record */
419 struct JOBMEDIA_DBR {
420 uint32_t JobMediaId; /* record id */
421 JobId_t JobId; /* JobId */
422 uint32_t MediaId; /* MediaId */
423 uint32_t FirstIndex; /* First index this Volume */
424 uint32_t LastIndex; /* Last index this Volume */
425 uint32_t StartFile; /* File for start of data */
426 uint32_t EndFile; /* End file on Volume */
427 uint32_t StartBlock; /* start block on tape */
428 uint32_t EndBlock; /* last block */
432 /* Volume Parameter structure */
434 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
435 uint32_t VolIndex; /* Volume seqence no. */
436 uint32_t FirstIndex; /* First index this Volume */
437 uint32_t LastIndex; /* Last index this Volume */
438 uint32_t StartFile; /* File for start of data */
439 uint32_t EndFile; /* End file on Volume */
440 uint32_t StartBlock; /* start block on tape */
441 uint32_t EndBlock; /* last block */
445 /* Attributes record -- NOT same as in database because
446 * in general, this "record" creates multiple database
447 * records (e.g. pathname, filename, fileattributes).
450 char *fname; /* full path & filename */
451 char *link; /* link if any */
452 char *attr; /* attributes statp */
463 /* File record -- same format as database */
474 int SigType; /* NO_SIG/MD5_SIG/SHA1_SIG */
477 /* Pool record -- same format as database */
480 char Name[MAX_NAME_LENGTH]; /* Pool name */
481 uint32_t NumVols; /* total number of volumes */
482 uint32_t MaxVols; /* max allowed volumes */
483 int32_t UseOnce; /* set to use once only */
484 int32_t UseCatalog; /* set to use catalog */
485 int32_t AcceptAnyVolume; /* set to accept any volume sequence */
486 int32_t AutoPrune; /* set to prune automatically */
487 int32_t Recycle; /* default Vol recycle flag */
488 utime_t VolRetention; /* retention period in seconds */
489 utime_t VolUseDuration; /* time in secs volume can be used */
490 uint32_t MaxVolJobs; /* Max Jobs on Volume */
491 uint32_t MaxVolFiles; /* Max files on Volume */
492 uint64_t MaxVolBytes; /* Max bytes on Volume */
493 char PoolType[MAX_NAME_LENGTH];
494 char LabelFormat[MAX_NAME_LENGTH];
495 /* Extra stuff not in DB */
499 /* Media record -- same as the database */
501 uint32_t MediaId; /* Unique volume id */
502 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
503 char MediaType[MAX_NAME_LENGTH]; /* Media type */
504 uint32_t PoolId; /* Pool id */
505 time_t FirstWritten; /* Time Volume first written */
506 time_t LastWritten; /* Time Volume last written */
507 time_t LabelDate; /* Date/Time Volume labeled */
508 uint32_t VolJobs; /* number of jobs on this medium */
509 uint32_t VolFiles; /* Number of files */
510 uint32_t VolBlocks; /* Number of blocks */
511 uint32_t VolMounts; /* Number of times mounted */
512 uint32_t VolErrors; /* Number of read/write errors */
513 uint32_t VolWrites; /* Number of writes */
514 uint32_t VolReads; /* Number of reads */
515 uint64_t VolBytes; /* Number of bytes written */
516 uint64_t MaxVolBytes; /* Max bytes to write to Volume */
517 uint64_t VolCapacityBytes; /* capacity estimate */
518 utime_t VolRetention; /* Volume retention in seconds */
519 utime_t VolUseDuration; /* time in secs volume can be used */
520 uint32_t MaxVolJobs; /* Max Jobs on Volume */
521 uint32_t MaxVolFiles; /* Max files on Volume */
522 int32_t Recycle; /* recycle yes/no */
523 int32_t Slot; /* slot in changer */
524 int32_t Drive; /* drive in changer */
525 int32_t InChanger; /* Volume currently in changer */
526 char VolStatus[20]; /* Volume status */
527 /* Extra stuff not in DB */
528 faddr_t rec_addr; /* found record address */
529 /* Since the database returns times as strings, this is how we pass
532 char cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
533 char cLastWritten[MAX_TIME_LENGTH]; /* LastWritten returned from DB */
534 char cLabelData[MAX_TIME_LENGTH]; /* LabelData returned from DB */
537 /* Client record -- same as the database */
539 uint32_t ClientId; /* Unique Client id */
541 utime_t FileRetention;
542 utime_t JobRetention;
543 char Name[MAX_NAME_LENGTH]; /* Client name */
544 char Uname[256]; /* Uname for client */
547 /* Counter record as in database */
549 char Counter[MAX_NAME_LENGTH];
552 int32_t CurrentValue;
553 char WrapCounter[MAX_NAME_LENGTH];
557 /* FileSet record -- same as the database */
559 uint32_t FileSetId; /* Unique FileSet id */
560 char FileSet[MAX_NAME_LENGTH]; /* FileSet name */
561 char MD5[50]; /* MD5 signature of include/exclude */
562 time_t CreateTime; /* date created */
564 * This is where we return CreateTime
566 char cCreateTime[MAX_TIME_LENGTH]; /* CreateTime as returned from DB */
567 /* Not in DB but returned by db_create_fileset() */
568 bool created; /* set when record newly created */
575 #endif /* __SQL_H_ */