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 */
82 int nrow; /* nrow returned from sqlite */
83 int ncolumn; /* ncolum returned from sqlite */
84 int num_rows; /* used by code */
85 int row; /* seek row */
86 int have_insert_id; /* do not have insert id */
87 int fields_defined; /* set when fields defined */
88 int field; /* seek field */
89 SQL_FIELD **fields; /* defined fields */
95 char *sqlite_errmsg; /* error message returned by sqlite */
96 POOLMEM *errmsg; /* nicely edited error message */
97 POOLMEM *cmd; /* SQL command string */
98 POOLMEM *cached_path; /* cached path name */
99 int cached_path_len; /* length of cached path */
100 uint32_t cached_path_id; /* cached path id */
101 int transaction; /* transaction started */
102 int changes; /* changes during transaction */
103 POOLMEM *fname; /* Filename only */
104 POOLMEM *path; /* Path only */
105 POOLMEM *esc_name; /* Escaped file/path name */
106 int fnl; /* file name length */
107 int pnl; /* path name length */
112 * "Generic" names for easier conversion
116 #define sql_store_result(x) x->result
117 #define sql_free_result(x) my_sqlite_free_table(x)
118 #define sql_fetch_row(x) my_sqlite_fetch_row(x)
119 #define sql_query(x, y) my_sqlite_query(x, y)
120 #define sql_close(x) sqlite_close(x->db)
121 #define sql_strerror(x) x->sqlite_errmsg?x->sqlite_errmsg:"unknown"
122 #define sql_num_rows(x) x->nrow
123 #define sql_data_seek(x, i) x->row = i
124 #define sql_affected_rows(x) 1
125 #define sql_insert_id(x) sqlite_last_insert_rowid(x->db)
126 #define sql_field_seek(x, y) my_sqlite_field_seek(x, y)
127 #define sql_fetch_field(x) my_sqlite_fetch_field(x)
128 #define sql_num_fields(x) (unsigned)((x)->ncolumn)
129 #define SQL_ROW char**
133 /* In cats/sqlite.c */
134 extern int my_sqlite_query(B_DB *mdb, char *cmd);
135 extern SQL_ROW my_sqlite_fetch_row(B_DB *mdb);
136 extern void my_sqlite_free_table(B_DB *mdb);
142 #define BDB_VERSION 5
147 * This is the "real" definition that should only be
148 * used inside sql.c and associated database interface
153 typedef struct s_db {
154 BQUEUE bq; /* queue control */
155 brwlock_t lock; /* transaction lock */
159 my_ulonglong num_rows;
164 int have_insert_id; /* do have insert_id() */
166 POOLMEM *errmsg; /* nicely edited error message */
167 POOLMEM *cmd; /* SQL command string */
168 POOLMEM *cached_path;
169 int cached_path_len; /* length of cached path */
170 uint32_t cached_path_id;
171 int changes; /* changes made to db */
172 POOLMEM *fname; /* Filename only */
173 POOLMEM *path; /* Path only */
174 POOLMEM *esc_name; /* Escaped file/path name */
175 int fnl; /* file name length */
176 int pnl; /* path name length */
180 /* "Generic" names for easier conversion */
181 #define sql_store_result(x) mysql_store_result(x->db)
182 #define sql_free_result(x) mysql_free_result(x->result)
183 #define sql_fetch_row(x) mysql_fetch_row(x->result)
184 #define sql_query(x, y) mysql_query(x->db, y)
185 #define sql_close(x) mysql_close(x->db)
186 #define sql_strerror(x) mysql_error(x->db)
187 #define sql_num_rows(x) mysql_num_rows(x->result)
188 #define sql_data_seek(x, i) mysql_data_seek(x->result, i)
189 #define sql_affected_rows(x) mysql_affected_rows(x->db)
190 #define sql_insert_id(x) mysql_insert_id(x->db)
191 #define sql_field_seek(x, y) mysql_field_seek(x->result, y)
192 #define sql_fetch_field(x) mysql_fetch_field(x->result)
193 #define sql_num_fields(x) mysql_num_fields(x->result)
194 #define SQL_ROW MYSQL_ROW
195 #define SQL_FIELD MYSQL_FIELD
197 #else /* USE BACULA DB routines */
199 #define HAVE_BACULA_DB 1
201 /* Change this each time there is some incompatible
202 * file format change!!!!
204 #define BDB_VERSION 11 /* file version number */
207 int bdb_version; /* Version number */
208 uint32_t JobId; /* next Job Id */
209 uint32_t PoolId; /* next Pool Id */
210 uint32_t MediaId; /* next Media Id */
211 uint32_t JobMediaId; /* next JobMedia Id */
212 uint32_t ClientId; /* next Client Id */
213 uint32_t FileSetId; /* nest FileSet Id */
214 time_t time; /* time file written */
218 /* This is the REAL definition for using the
221 typedef struct s_db {
222 BQUEUE bq; /* queue control */
223 /* pthread_mutex_t mutex; */ /* single thread lock */
224 brwlock_t lock; /* transaction lock */
225 int ref_count; /* number of times opened */
226 struct s_control control; /* control file structure */
227 int cfd; /* control file device */
228 FILE *jobfd; /* Jobs records file descriptor */
229 FILE *poolfd; /* Pool records fd */
230 FILE *mediafd; /* Media records fd */
231 FILE *jobmediafd; /* JobMedia records fd */
232 FILE *clientfd; /* Client records fd */
233 FILE *filesetfd; /* FileSet records fd */
234 char *db_name; /* name of database */
235 POOLMEM *errmsg; /* nicely edited error message */
236 POOLMEM *cmd; /* Command string */
237 POOLMEM *cached_path;
238 int cached_path_len; /* length of cached path */
239 uint32_t cached_path_id;
242 #endif /* HAVE_MYSQL */
243 #endif /* HAVE_SQLITE */
245 /* Use for better error location printing */
246 #define UPDATE_DB(jcr, db, cmd) UpdateDB(__FILE__, __LINE__, jcr, db, cmd)
247 #define INSERT_DB(jcr, db, cmd) InsertDB(__FILE__, __LINE__, jcr, db, cmd)
248 #define QUERY_DB(jcr, db, cmd) QueryDB(__FILE__, __LINE__, jcr, db, cmd)
249 #define DELETE_DB(jcr, db, cmd) DeleteDB(__FILE__, __LINE__, jcr, db, cmd)
252 #else /* not __SQL_C */
254 /* This is a "dummy" definition for use outside of sql.c
256 typedef struct s_db {
257 int dummy; /* for SunOS compiler */
262 /* ***FIXME*** FileId_t should be uint64_t */
263 typedef uint32_t FileId_t;
264 typedef uint32_t DBId_t; /* general DB id type */
265 typedef uint32_t JobId_t;
268 /* Job information passed to create job record and update
269 * job record at end of job. Note, although this record
270 * contains all the fields found in the Job database record,
271 * it also contains fields found in the JobMedia record.
276 char Job[MAX_NAME_LENGTH]; /* Job unique name */
277 char Name[MAX_NAME_LENGTH]; /* Job base name */
278 int Type; /* actually char(1) */
279 int Level; /* actually char(1) */
280 int JobStatus; /* actually char(1) */
281 uint32_t ClientId; /* Id of client */
282 uint32_t PoolId; /* Id of pool */
283 uint32_t FileSetId; /* Id of FileSet */
284 time_t SchedTime; /* Time job scheduled */
285 time_t StartTime; /* Job start time */
286 time_t EndTime; /* Job termination time */
287 utime_t JobTDate; /* Backup time/date in seconds */
288 uint32_t VolSessionId;
289 uint32_t VolSessionTime;
292 uint32_t JobMissingFiles;
295 /* Note, FirstIndex, LastIndex, Start/End File and Block
296 * are only used in the JobMedia record.
298 uint32_t FirstIndex; /* First index this Volume */
299 uint32_t LastIndex; /* Last index this Volume */
305 char cSchedTime[MAX_TIME_LENGTH];
306 char cStartTime[MAX_TIME_LENGTH];
307 char cEndTime[MAX_TIME_LENGTH];
308 /* Extra stuff not in DB */
312 /* Job Media information used to create the media records
313 * for each Volume used for the job.
315 /* JobMedia record */
317 uint32_t JobMediaId; /* record id */
318 JobId_t JobId; /* JobId */
319 uint32_t MediaId; /* MediaId */
320 uint32_t FirstIndex; /* First index this Volume */
321 uint32_t LastIndex; /* Last index this Volume */
322 uint32_t StartFile; /* File for start of data */
323 uint32_t EndFile; /* End file on Volume */
324 uint32_t StartBlock; /* start block on tape */
325 uint32_t EndBlock; /* last block */
328 /* Volume Parameter structure */
330 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
331 uint32_t FirstIndex; /* First index this Volume */
332 uint32_t LastIndex; /* Last index this Volume */
333 uint32_t StartFile; /* File for start of data */
334 uint32_t EndFile; /* End file on Volume */
335 uint32_t StartBlock; /* start block on tape */
336 uint32_t EndBlock; /* last block */
340 /* Attributes record -- NOT same as in database because
341 * in general, this "record" creates multiple database
342 * records (e.g. pathname, filename, fileattributes).
345 char *fname; /* full path & filename */
346 char *link; /* link if any */
347 char *attr; /* attributes statp */
358 /* File record -- same format as database */
369 int SigType; /* NO_SIG/MD5_SIG/SHA1_SIG */
372 /* Pool record -- same format as database */
375 char Name[MAX_NAME_LENGTH]; /* Pool name */
376 uint32_t NumVols; /* total number of volumes */
377 uint32_t MaxVols; /* max allowed volumes */
378 int UseOnce; /* set to use once only */
379 int UseCatalog; /* set to use catalog */
380 int AcceptAnyVolume; /* set to accept any volume sequence */
381 int AutoPrune; /* set to prune automatically */
382 int Recycle; /* default Vol recycle flag */
383 utime_t VolRetention; /* retention period in seconds */
384 utime_t VolUseDuration; /* time in secs volume can be used */
385 uint32_t MaxVolJobs; /* Max Jobs on Volume */
386 uint32_t MaxVolFiles; /* Max files on Volume */
387 uint64_t MaxVolBytes; /* Max bytes on Volume */
388 char PoolType[MAX_NAME_LENGTH];
389 char LabelFormat[MAX_NAME_LENGTH];
390 /* Extra stuff not in DB */
394 /* Media record -- same as the database */
396 uint32_t MediaId; /* Unique volume id */
397 char VolumeName[MAX_NAME_LENGTH]; /* Volume name */
398 char MediaType[MAX_NAME_LENGTH]; /* Media type */
399 uint32_t PoolId; /* Pool id */
400 time_t FirstWritten; /* Time Volume first written */
401 time_t LastWritten; /* Time Volume last written */
402 time_t LabelDate; /* Date/Time Volume labeled */
403 uint32_t VolJobs; /* number of jobs on this medium */
404 uint32_t VolFiles; /* Number of files */
405 uint32_t VolBlocks; /* Number of blocks */
406 uint32_t VolMounts; /* Number of times mounted */
407 uint32_t VolErrors; /* Number of read/write errors */
408 uint32_t VolWrites; /* Number of writes */
409 uint32_t VolReads; /* Number of reads */
410 uint64_t VolBytes; /* Number of bytes written */
411 uint64_t MaxVolBytes; /* Max bytes to write to Volume */
412 uint64_t VolCapacityBytes; /* capacity estimate */
413 utime_t VolRetention; /* Volume retention in seconds */
414 utime_t VolUseDuration; /* time in secs volume can be used */
415 uint32_t MaxVolJobs; /* Max Jobs on Volume */
416 uint32_t MaxVolFiles; /* Max files on Volume */
417 int Recycle; /* recycle yes/no */
418 int32_t Slot; /* slot in changer */
419 char VolStatus[20]; /* Volume status */
420 /* Extra stuff not in DB */
421 faddr_t rec_addr; /* found record address */
422 /* Since the database returns times as strings, this is how we pass
425 char cFirstWritten[MAX_TIME_LENGTH]; /* FirstWritten returned from DB */
426 char cLastWritten[MAX_TIME_LENGTH]; /* LastWritten returned from DB */
427 char cLabelData[MAX_TIME_LENGTH]; /* LabelData returned from DB */
430 /* Client record -- same as the database */
432 uint32_t ClientId; /* Unique Client id */
434 utime_t FileRetention;
435 utime_t JobRetention;
436 char Name[MAX_NAME_LENGTH]; /* Client name */
437 char Uname[256]; /* Uname for client */
440 /* FileSet record -- same as the database */
442 uint32_t FileSetId; /* Unique FileSet id */
443 char FileSet[MAX_NAME_LENGTH]; /* FileSet name */
444 char MD5[50]; /* MD5 signature of include/exclude */
451 #endif /* __SQL_H_ */