4 \chapter{Catalog Services}
5 \label{_ChapterStart30}
6 \index[general]{Services!Catalog }
7 \index[general]{Catalog Services }
10 \index[general]{General }
11 \addcontentsline{toc}{subsection}{General}
13 This chapter is intended to be a technical discussion of the Catalog services
14 and as such is not targeted at end users but rather at developers and system
15 administrators that want or need to know more of the working details of {\bf
18 The {\bf Bacula Catalog} services consist of the programs that provide the SQL
19 database engine for storage and retrieval of all information concerning files
20 that were backed up and their locations on the storage media.
22 We have investigated the possibility of using the following SQL engines for
23 Bacula: Beagle, mSQL, GNU SQL, PostgreSQL, SQLite, Oracle, and MySQL. Each
24 presents certain problems with either licensing or maturity. At present, we
25 have chosen for development purposes to use MySQL, PostgreSQL and SQLite.
26 MySQL was chosen because it is fast, proven to be reliable, widely used, and
27 actively being developed. MySQL is released under the GNU GPL license.
28 PostgreSQL was chosen because it is a full-featured, very mature database, and
29 because Dan Langille did the Bacula driver for it. PostgreSQL is distributed
30 under the BSD license. SQLite was chosen because it is small, efficient, and
31 can be directly embedded in {\bf Bacula} thus requiring much less effort from
32 the system administrator or person building {\bf Bacula}. In our testing
33 SQLite has performed very well, and for the functions that we use, it has
34 never encountered any errors except that it does not appear to handle
35 databases larger than 2GBytes. That said, we would not recommend it for
36 serious production use.
38 The Bacula SQL code has been written in a manner that will allow it to be
39 easily modified to support any of the current SQL database systems on the
40 market (for example: mSQL, iODBC, unixODBC, Solid, OpenLink ODBC, EasySoft
41 ODBC, InterBase, Oracle8, Oracle7, and DB2).
43 If you do not specify either {\bf \verb{--{with-mysql} or {\bf \verb{--{with-postgresql} or
44 {\bf \verb{--{with-sqlite} on the ./configure line, Bacula will use its minimalist
45 internal database. This database is kept for build reasons but is no longer
46 supported. Bacula {\bf requires} one of the three databases (MySQL,
47 PostgreSQL, or SQLite) to run.
49 \subsection{Filenames and Maximum Filename Length}
50 \index[general]{Filenames and Maximum Filename Length }
51 \index[general]{Length!Filenames and Maximum Filename }
52 \addcontentsline{toc}{subsubsection}{Filenames and Maximum Filename Length}
54 In general, either MySQL, PostgreSQL or SQLite permit storing arbitrary long
55 path names and file names in the catalog database. In practice, there still
56 may be one or two places in the Catalog interface code that restrict the
57 maximum path length to 512 characters and the maximum file name length to 512
58 characters. These restrictions are believed to have been removed. Please note,
59 these restrictions apply only to the Catalog database and thus to your ability
60 to list online the files saved during any job. All information received and
61 stored by the Storage daemon (normally on tape) allows and handles arbitrarily
62 long path and filenames.
64 \subsection{Installing and Configuring MySQL}
65 \index[general]{MySQL!Installing and Configuring }
66 \index[general]{Installing and Configuring MySQL }
67 \addcontentsline{toc}{subsubsection}{Installing and Configuring MySQL}
69 For the details of installing and configuring MySQL, please see the
70 \ilink{Installing and Configuring MySQL}{_ChapterStart} chapter of
73 \subsection{Installing and Configuring PostgreSQL}
74 \index[general]{PostgreSQL!Installing and Configuring }
75 \index[general]{Installing and Configuring PostgreSQL }
76 \addcontentsline{toc}{subsubsection}{Installing and Configuring PostgreSQL}
78 For the details of installing and configuring PostgreSQL, please see the
79 \ilink{Installing and Configuring PostgreSQL}{_ChapterStart10}
80 chapter of this manual.
82 \subsection{Installing and Configuring SQLite}
83 \index[general]{Installing and Configuring SQLite }
84 \index[general]{SQLite!Installing and Configuring }
85 \addcontentsline{toc}{subsubsection}{Installing and Configuring SQLite}
87 For the details of installing and configuring SQLite, please see the
88 \ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
91 \subsection{Internal Bacula Catalog}
92 \index[general]{Catalog!Internal Bacula }
93 \index[general]{Internal Bacula Catalog }
94 \addcontentsline{toc}{subsubsection}{Internal Bacula Catalog}
97 \ilink{Internal Bacula Database}{_ChapterStart42} chapter of this
98 manual for more details.
100 \subsection{Database Table Design}
101 \index[general]{Design!Database Table }
102 \index[general]{Database Table Design }
103 \addcontentsline{toc}{subsubsection}{Database Table Design}
105 All discussions that follow pertain to the MySQL database. The details for the
106 PostgreSQL and SQLite databases are essentially identical except for that all
107 fields in the SQLite database are stored as ASCII text and some of the
108 database creation statements are a bit different. The details of the internal
109 Bacula catalog are not discussed here.
111 Because the Catalog database may contain very large amounts of data for large
112 sites, we have made a modest attempt to normalize the data tables to reduce
113 redundant information. While reducing the size of the database significantly,
114 it does, unfortunately, add some complications to the structures.
116 In simple terms, the Catalog database must contain a record of all Jobs run by
117 Bacula, and for each Job, it must maintain a list of all files saved, with
118 their File Attributes (permissions, create date, ...), and the location and
119 Media on which the file is stored. This is seemingly a simple task, but it
120 represents a huge amount interlinked data. Note: the list of files and their
121 attributes is not maintained when using the internal Bacula database. The data
122 stored in the File records, which allows the user or administrator to obtain a
123 list of all files backed up during a job, is by far the largest volume of
124 information put into the Catalog database.
126 Although the Catalog database has been designed to handle backup data for
127 multiple clients, some users may want to maintain multiple databases, one for
128 each machine to be backed up. This reduces the risk of confusion of accidental
129 restoring a file to the wrong machine as well as reducing the amount of data
130 in a single database, thus increasing efficiency and reducing the impact of a
131 lost or damaged database.
133 \section{Sequence of Creation of Records for a Save Job}
134 \index[general]{Sequence of Creation of Records for a Save Job }
135 \index[general]{Job!Sequence of Creation of Records for a Save }
136 \addcontentsline{toc}{subsection}{Sequence of Creation of Records for a Save
139 Start with StartDate, ClientName, Filename, Path, Attributes, MediaName,
140 MediaCoordinates. (PartNumber, NumParts). In the steps below, ``Create new''
141 means to create a new record whether or not it is unique. ``Create unique''
142 means each record in the database should be unique. Thus, one must first
143 search to see if the record exists, and only if not should a new one be
144 created, otherwise the existing RecordId should be used.
147 \item Create new Job record with StartDate; save JobId
148 \item Create unique Media record; save MediaId
149 \item Create unique Client record; save ClientId
150 \item Create unique Filename record; save FilenameId
151 \item Create unique Path record; save PathId
152 \item Create unique Attribute record; save AttributeId
153 store ClientId, FilenameId, PathId, and Attributes
154 \item Create new File record
155 store JobId, AttributeId, MediaCoordinates, etc
156 \item Repeat steps 4 through 8 for each file
157 \item Create a JobMedia record; save MediaId
158 \item Update Job record filling in EndDate and other Job statistics
161 \section{Database Tables}
162 \index[general]{Database Tables }
163 \index[general]{Tables!Database }
164 \addcontentsline{toc}{subsection}{Database Tables}
166 \addcontentsline{lot}{table}{Filename Table Layout}
167 \begin{longtable}{|l|l|l|}
169 \multicolumn{3}{|l| }{\bf Filename } \\
171 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{l| }{\bf Data Type }
172 & \multicolumn{1}{l| }{\bf Remark } \\
174 {FilenameId } & {integer } & {Primary Key } \\
176 {Name } & {Blob } & {Filename }
181 The {\bf Filename} table shown above contains the name of each file backed up
182 with the path removed. If different directories or machines contain the same
183 filename, only one copy will be saved in this table.
187 \addcontentsline{lot}{table}{Path Table Layout}
188 \begin{longtable}{|l|l|l|}
190 \multicolumn{3}{|l| }{\bf Path } \\
192 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
193 } & \multicolumn{1}{c| }{\bf Remark } \\
195 {PathId } & {integer } & {Primary Key } \\
197 {Path } & {Blob } & {Full Path }
202 The {\bf Path} table contains shown above the path or directory names of all
203 directories on the system or systems. The filename and any MSDOS disk name are
204 stripped off. As with the filename, only one copy of each directory name is
205 kept regardless of how many machines or drives have the same directory. These
206 path names should be stored in Unix path name format.
208 Some simple testing on a Linux file system indicates that separating the
209 filename and the path may be more complication than is warranted by the space
210 savings. For example, this system has a total of 89,097 files, 60,467 of which
211 have unique filenames, and there are 4,374 unique paths.
213 Finding all those files and doing two stats() per file takes an average wall
214 clock time of 1 min 35 seconds on a 400MHz machine running RedHat 6.1 Linux.
216 Finding all those files and putting them directly into a MySQL database with
217 the path and filename defined as TEXT, which is variable length up to 65,535
218 characters takes 19 mins 31 seconds and creates a 27.6 MByte database.
220 Doing the same thing, but inserting them into Blob fields with the filename
221 indexed on the first 30 characters and the path name indexed on the 255 (max)
222 characters takes 5 mins 18 seconds and creates a 5.24 MB database. Rerunning
223 the job (with the database already created) takes about 2 mins 50 seconds.
225 Running the same as the last one (Path and Filename Blob), but Filename
226 indexed on the first 30 characters and the Path on the first 50 characters
227 (linear search done there after) takes 5 mins on the average and creates a 3.4
228 MB database. Rerunning with the data already in the DB takes 3 mins 35
231 Finally, saving only the full path name rather than splitting the path and the
232 file, and indexing it on the first 50 characters takes 6 mins 43 seconds and
233 creates a 7.35 MB database.
237 \addcontentsline{lot}{table}{File Table Layout}
238 \begin{longtable}{|l|l|l|}
240 \multicolumn{3}{|l| }{\bf File } \\
242 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
243 } & \multicolumn{1}{c| }{\bf Remark } \\
245 {FileId } & {integer } & {Primary Key } \\
247 {FileIndex } & {integer } & {The sequential file number in the Job } \\
249 {JobId } & {integer } & {Link to Job Record } \\
251 {PathId } & {integer } & {Link to Path Record } \\
253 {FilenameId } & {integer } & {Link to Filename Record } \\
255 {MarkId } & {integer } & {Used to mark files during Verify Jobs } \\
257 {LStat } & {tinyblob } & {File attributes in base64 encoding } \\
259 {MD5 } & {tinyblob } & {MD5/SHA1 signature in base64 encoding }
264 The {\bf File} table shown above contains one entry for each file backed up by
265 Bacula. Thus a file that is backed up multiple times (as is normal) will have
266 multiple entries in the File table. This will probably be the table with the
267 most number of records. Consequently, it is essential to keep the size of this
268 record to an absolute minimum. At the same time, this table must contain all
269 the information (or pointers to the information) about the file and where it
270 is backed up. Since a file may be backed up many times without having changed,
271 the path and filename are stored in separate tables.
273 This table contains by far the largest amount of information in the Catalog
274 database, both from the stand point of number of records, and the stand point
275 of total database size. As a consequence, the user must take care to
276 periodically reduce the number of File records using the {\bf retention}
277 command in the Console program.
281 \addcontentsline{lot}{table}{Job Table Layout}
282 \begin{longtable}{|l|l|p{2.5in}|}
284 \multicolumn{3}{|l| }{\bf Job } \\
286 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
287 } & \multicolumn{1}{c| }{\bf Remark } \\
289 {JobId } & {integer } & {Primary Key } \\
291 {Job } & {tinyblob } & {Unique Job Name } \\
293 {Name } & {tinyblob } & {Job Name } \\
295 {PurgedFiles } & {tinyint } & {Used by Bacula for purging/retention periods
298 {Type } & {binary(1) } & {Job Type: Backup, Copy, Clone, Archive, Migration
301 {Level } & {binary(1) } & {Job Level } \\
303 {ClientId } & {integer } & {Client index } \\
305 {JobStatus } & {binary(1) } & {Job Termination Status } \\
307 {SchedTime } & {datetime } & {Time/date when Job scheduled } \\
309 {StartTime } & {datetime } & {Time/date when Job started } \\
311 {EndTime } & {datetime } & {Time/date when Job ended } \\
313 {RealEndTime } & {datetime } & {Time/date when original Job ended } \\
315 {JobTDate } & {bigint } & {Start day in Unix format but 64 bits; used for
316 Retention period. } \\
318 {VolSessionId } & {integer } & {Unique Volume Session ID } \\
320 {VolSessionTime } & {integer } & {Unique Volume Session Time } \\
322 {JobFiles } & {integer } & {Number of files saved in Job } \\
324 {JobBytes } & {bigint } & {Number of bytes saved in Job } \\
326 {JobErrors } & {integer } & {Number of errors during Job } \\
328 {JobMissingFiles } & {integer } & {Number of files not saved (not yet used) }
331 {PoolId } & {integer } & {Link to Pool Record } \\
333 {FileSetId } & {integer } & {Link to FileSet Record } \\
335 {PrioJobId } & {integer } & {Link to prior Job Record when migrated } \\
337 {PurgedFiles } & {tiny integer } & {Set when all File records purged } \\
339 {HasBase } & {tiny integer } & {Set when Base Job run }
344 The {\bf Job} table contains one record for each Job run by Bacula. Thus
345 normally, there will be one per day per machine added to the database. Note,
346 the JobId is used to index Job records in the database, and it often is shown
347 to the user in the Console program. However, care must be taken with its use
348 as it is not unique from database to database. For example, the user may have
349 a database for Client data saved on machine Rufus and another database for
350 Client data saved on machine Roxie. In this case, the two database will each
351 have JobIds that match those in another database. For a unique reference to a
354 The Name field of the Job record corresponds to the Name resource record given
355 in the Director's configuration file. Thus it is a generic name, and it will
356 be normal to find many Jobs (or even all Jobs) with the same Name.
358 The Job field contains a combination of the Name and the schedule time of the
359 Job by the Director. Thus for a given Director, even with multiple Catalog
360 databases, the Job will contain a unique name that represents the Job.
362 For a given Storage daemon, the VolSessionId and VolSessionTime form a unique
363 identification of the Job. This will be the case even if multiple Directors
364 are using the same Storage daemon.
366 The Job Type (or simply Type) can have one of the following values:
368 \addcontentsline{lot}{table}{Job Types}
369 \begin{longtable}{|l|l|}
371 \multicolumn{1}{|c| }{\bf Value } & \multicolumn{1}{c| }{\bf Meaning } \\
373 {B } & {Backup Job } \\
375 {M } & {Migrated Job } \\
377 {V } & {Verify Job } \\
379 {R } & {Restore Job } \\
381 {C } & {Console program (not in database) } \\
383 {I } & {Internal or system Job } \\
385 {D } & {Admin Job } \\
387 {A } & {Archive Job (not implemented) }
389 {C } & {Copy Job } \\
391 {M } & {Migration Job } \\
395 Note, the Job Type values noted above are not kept in an SQL table.
398 The JobStatus field specifies how the job terminated, and can be one of the
401 \addcontentsline{lot}{table}{Job Statuses}
402 \begin{longtable}{|l|l|}
404 \multicolumn{1}{|c| }{\bf Value } & \multicolumn{1}{c| }{\bf Meaning } \\
406 {C } & {Created but not yet running } \\
412 {T } & {Terminated normally } \\
414 {W } & {Terminated normally with warnings }
416 {E } & {Terminated in Error } \\
418 {e } & {Non-fatal error } \\
420 {f } & {Fatal error } \\
422 {D } & {Verify Differences } \\
424 {A } & {Canceled by the user } \\
426 {I } & {Incomplete Job }
428 {F } & {Waiting on the File daemon } \\
430 {S } & {Waiting on the Storage daemon } \\
432 {m } & {Waiting for a new Volume to be mounted } \\
434 {M } & {Waiting for a Mount } \\
436 {s } & {Waiting for Storage resource } \\
438 {j } & {Waiting for Job resource } \\
440 {c } & {Waiting for Client resource } \\
442 {d } & {Wating for Maximum jobs } \\
444 {t } & {Waiting for Start Time } \\
446 {p } & {Waiting for higher priority job to finish }
448 {i } & {Doing batch insert file records }
450 {a } & {SD despooling attributes }
452 {l } & {Doing data despooling }
454 {L } & {Committing data (last despool) }
461 \addcontentsline{lot}{table}{File Sets Table Layout}
462 \begin{longtable}{|l|l|l|}
464 \multicolumn{3}{|l| }{\bf FileSet } \\
466 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
467 \ \ } & \multicolumn{1}{c| }{\bf Remark } \\
469 {FileSetId } & {integer } & {Primary Key } \\
471 {FileSet } & {tinyblob } & {FileSet name } \\
473 {MD5 } & {tinyblob } & {MD5 checksum of FileSet } \\
475 {CreateTime } & {datetime } & {Time and date Fileset created }
480 The {\bf FileSet} table contains one entry for each FileSet that is used. The
481 MD5 signature is kept to ensure that if the user changes anything inside the
482 FileSet, it will be detected and the new FileSet will be used. This is
483 particularly important when doing an incremental update. If the user deletes a
484 file or adds a file, we need to ensure that a Full backup is done prior to the
488 \addcontentsline{lot}{table}{JobMedia Table Layout}
489 \begin{longtable}{|l|l|p{2.5in}|}
491 \multicolumn{3}{|l| }{\bf JobMedia } \\
493 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
494 \ \ } & \multicolumn{1}{c| }{\bf Remark } \\
496 {JobMediaId } & {integer } & {Primary Key } \\
498 {JobId } & {integer } & {Link to Job Record } \\
500 {MediaId } & {integer } & {Link to Media Record } \\
502 {FirstIndex } & {integer } & {The index (sequence number) of the first file
503 written for this Job to the Media } \\
505 {LastIndex } & {integer } & {The index of the last file written for this
506 Job to the Media } \\
508 {StartFile } & {integer } & {The physical media (tape) file number of the
509 first block written for this Job } \\
511 {EndFile } & {integer } & {The physical media (tape) file number of the
512 last block written for this Job } \\
514 {StartBlock } & {integer } & {The number of the first block written for
517 {EndBlock } & {integer } & {The number of the last block written for this
520 {VolIndex } & {integer } & {The Volume use sequence number within the Job }
525 The {\bf JobMedia} table contains one entry at the following: start of
526 the job, start of each new tape file, start of each new tape, end of the
527 job. Since by default, a new tape file is written every 2GB, in general,
528 you will have more than 2 JobMedia records per Job. The number can be
529 varied by changing the "Maximum File Size" specified in the Device
530 resource. This record allows Bacula to efficiently position close to
531 (within 2GB) any given file in a backup. For restoring a full Job,
532 these records are not very important, but if you want to retrieve
533 a single file that was written near the end of a 100GB backup, the
534 JobMedia records can speed it up by orders of magnitude by permitting
535 forward spacing files and blocks rather than reading the whole 100GB
541 \addcontentsline{lot}{table}{Media Table Layout}
542 \begin{longtable}{|l|l|p{2.4in}|}
544 \multicolumn{3}{|l| }{\bf Media } \\
546 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
547 \ \ } & \multicolumn{1}{c| }{\bf Remark } \\
549 {MediaId } & {integer } & {Primary Key } \\
551 {VolumeName } & {tinyblob } & {Volume name } \\
553 {Slot } & {integer } & {Autochanger Slot number or zero } \\
555 {PoolId } & {integer } & {Link to Pool Record } \\
557 {MediaType } & {tinyblob } & {The MediaType supplied by the user } \\
559 {MediaTypeId } & {integer } & {The MediaTypeId } \\
561 {LabelType } & {tinyint } & {The type of label on the Volume } \\
563 {FirstWritten } & {datetime } & {Time/date when first written } \\
565 {LastWritten } & {datetime } & {Time/date when last written } \\
567 {LabelDate } & {datetime } & {Time/date when tape labeled } \\
569 {VolJobs } & {integer } & {Number of jobs written to this media } \\
571 {VolFiles } & {integer } & {Number of files written to this media } \\
573 {VolBlocks } & {integer } & {Number of blocks written to this media } \\
575 {VolMounts } & {integer } & {Number of time media mounted } \\
577 {VolBytes } & {bigint } & {Number of bytes saved in Job } \\
579 {VolParts } & {integer } & {The number of parts for a Volume (DVD) } \\
581 {VolErrors } & {integer } & {Number of errors during Job } \\
583 {VolWrites } & {integer } & {Number of writes to media } \\
585 {MaxVolBytes } & {bigint } & {Maximum bytes to put on this media } \\
587 {VolCapacityBytes } & {bigint } & {Capacity estimate for this volume } \\
589 {VolStatus } & {enum } & {Status of media: Full, Archive, Append, Recycle,
590 Read-Only, Disabled, Error, Busy } \\
592 {Enabled } {tinyint } & {Whether or not Volume can be written } \\
594 {Recycle } & {tinyint } & {Whether or not Bacula can recycle the Volumes:
597 {ActionOnPurge } & {tinyint } & {What happens to a Volume after purging } \\
599 {VolRetention } & {bigint } & {64 bit seconds until expiration } \\
601 {VolUseDuration } & {bigint } & {64 bit seconds volume can be used } \\
603 {MaxVolJobs } & {integer } & {maximum jobs to put on Volume } \\
605 {MaxVolFiles } & {integer } & {maximume EOF marks to put on Volume }
607 {InChanger } & {tinyint } & {Whether or not Volume in autochanger } \\
609 {StorageId } & {integer } & {Storage record ID } \\
611 {DeviceId } & {integer } & {Device record ID } \\
613 {MediaAddressing } & {integer } & {Method of addressing media } \\
615 {VolReadTime } & {bigint } & {Time Reading Volume } \\
617 {VolWriteTime } & {bigint } & {Time Writing Volume } \\
619 {EndFile } & {integer } & {End File number of Volume } \\
621 {EndBlock } & {integer } & {End block number of Volume } \\
623 {LocationId } & {integer } & {Location record ID } \\
625 {RecycleCount } & {integer } & {Number of times recycled } \\
627 {InitialWrite } & {datetime } & {When Volume first written } \\
629 {ScratchPoolId } & {integer } & {Id of Scratch Pool } \\
631 {RecyclePoolId } & {integer } & {Pool ID where to recycle Volume } \\
633 {Comment } & {blob } & {User text field } \\
639 The {\bf Volume} table (internally referred to as the Media table) contains
640 one entry for each volume, that is each tape, cassette (8mm, DLT, DAT, ...),
641 or file on which information is or was backed up. There is one Volume record
642 created for each of the NumVols specified in the Pool resource record.
646 \addcontentsline{lot}{table}{Pool Table Layout}
647 \begin{longtable}{|l|l|p{2.4in}|}
649 \multicolumn{3}{|l| }{\bf Pool } \\
651 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
652 } & \multicolumn{1}{c| }{\bf Remark } \\
654 {PoolId } & {integer } & {Primary Key } \\
656 {Name } & {Tinyblob } & {Pool Name } \\
658 {NumVols } & {Integer } & {Number of Volumes in the Pool } \\
660 {MaxVols } & {Integer } & {Maximum Volumes in the Pool } \\
662 {UseOnce } & {tinyint } & {Use volume once } \\
664 {UseCatalog } & {tinyint } & {Set to use catalog } \\
666 {AcceptAnyVolume } & {tinyint } & {Accept any volume from Pool } \\
668 {VolRetention } & {bigint } & {64 bit seconds to retain volume } \\
670 {VolUseDuration } & {bigint } & {64 bit seconds volume can be used } \\
672 {MaxVolJobs } & {integer } & {max jobs on volume } \\
674 {MaxVolFiles } & {integer } & {max EOF marks to put on Volume } \\
676 {MaxVolBytes } & {bigint } & {max bytes to write on Volume } \\
678 {AutoPrune } & {tinyint } & {yes|no for autopruning } \\
680 {Recycle } & {tinyint } & {yes|no for allowing auto recycling of Volume } \\
682 {ActionOnPurge } & {tinyint } & {Default Volume ActionOnPurge } \\
684 {PoolType } & {enum } & {Backup, Copy, Cloned, Archive, Migration } \\
686 {LabelType } & {tinyint } & {Type of label ANSI/Bacula } \\
688 {LabelFormat } & {Tinyblob } & {Label format }
690 {Enabled } {tinyint } & {Whether or not Volume can be written } \\
692 {ScratchPoolId } & {integer } & {Id of Scratch Pool } \\
694 {RecyclePoolId } & {integer } & {Pool ID where to recycle Volume } \\
696 {NextPoolId } & {integer } & {Pool ID of next Pool } \\
698 {MigrationHighBytes } & {bigint } & {High water mark for migration } \\
700 {MigrationLowBytes } & {bigint } & {Low water mark for migration } \\
702 {MigrationTime } & {bigint } & {Time before migration } \\
709 The {\bf Pool} table contains one entry for each media pool controlled by
710 Bacula in this database. One media record exists for each of the NumVols
711 contained in the Pool. The PoolType is a Bacula defined keyword. The MediaType
712 is defined by the administrator, and corresponds to the MediaType specified in
713 the Director's Storage definition record. The CurrentVol is the sequence
714 number of the Media record for the current volume.
718 \addcontentsline{lot}{table}{Client Table Layout}
719 \begin{longtable}{|l|l|l|}
721 \multicolumn{3}{|l| }{\bf Client } \\
723 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
724 } & \multicolumn{1}{c| }{\bf Remark } \\
726 {ClientId } & {integer } & {Primary Key } \\
728 {Name } & {TinyBlob } & {File Services Name } \\
730 {UName } & {TinyBlob } & {uname -a from Client (not yet used) } \\
732 {AutoPrune } & {tinyint } & {yes|no for autopruning } \\
734 {FileRetention } & {bigint } & {64 bit seconds to retain Files } \\
736 {JobRetention } & {bigint } & {64 bit seconds to retain Job }
741 The {\bf Client} table contains one entry for each machine backed up by Bacula
742 in this database. Normally the Name is a fully qualified domain name.
745 \addcontentsline{lot}{table}{Storage Table Layout}
746 \begin{longtable}{|l|l|l|}
748 \multicolumn{3}{|l| }{\bf Storage } \\
750 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
751 } & \multicolumn{1}{c| }{\bf Remark } \\
753 {StorageId } & {integer } & {Unique Id } \\
755 {Name } & {tinyblob } & {Resource name of Storage device } \\
757 {AutoChanger } & {tinyint } & {Set if it is an autochanger } \\
762 The {\bf Storage} table contains one entry for each Storage used.
765 \addcontentsline{lot}{table}{Counter Table Layout}
766 \begin{longtable}{|l|l|l|}
768 \multicolumn{3}{|l| }{\bf Counter } \\
770 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
771 } & \multicolumn{1}{c| }{\bf Remark } \\
773 {Counter } & {tinyblob } & {Counter name } \\
775 {MinValue } & {integer } & {Start/Min value for counter } \\
777 {MaxValue } & {integer } & {Max value for counter } \\
779 {CurrentValue } & {integer } & {Current counter value } \\
781 {WrapCounter } & {tinyblob } & {Name of another counter }
786 The {\bf Counter} table contains one entry for each permanent counter defined
789 \addcontentsline{lot}{table}{Job History Table Layout}
790 \begin{longtable}{|l|l|p{2.5in}|}
792 \multicolumn{3}{|l| }{\bf JobHisto } \\
794 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
795 } & \multicolumn{1}{c| }{\bf Remark } \\
797 {JobId } & {integer } & {Primary Key } \\
799 {Job } & {tinyblob } & {Unique Job Name } \\
801 {Name } & {tinyblob } & {Job Name } \\
803 {Type } & {binary(1) } & {Job Type: Backup, Copy, Clone, Archive, Migration
806 {Level } & {binary(1) } & {Job Level } \\
808 {ClientId } & {integer } & {Client index } \\
810 {JobStatus } & {binary(1) } & {Job Termination Status } \\
812 {SchedTime } & {datetime } & {Time/date when Job scheduled } \\
814 {StartTime } & {datetime } & {Time/date when Job started } \\
816 {EndTime } & {datetime } & {Time/date when Job ended } \\
818 {RealEndTime } & {datetime } & {Time/date when original Job ended } \\
820 {JobTDate } & {bigint } & {Start day in Unix format but 64 bits; used for
821 Retention period. } \\
823 {VolSessionId } & {integer } & {Unique Volume Session ID } \\
825 {VolSessionTime } & {integer } & {Unique Volume Session Time } \\
827 {JobFiles } & {integer } & {Number of files saved in Job } \\
829 {JobBytes } & {bigint } & {Number of bytes saved in Job } \\
831 {JobErrors } & {integer } & {Number of errors during Job } \\
833 {JobMissingFiles } & {integer } & {Number of files not saved (not yet used) }
836 {PoolId } & {integer } & {Link to Pool Record } \\
838 {FileSetId } & {integer } & {Link to FileSet Record } \\
840 {PrioJobId } & {integer } & {Link to prior Job Record when migrated } \\
842 {PurgedFiles } & {tiny integer } & {Set when all File records purged } \\
844 {HasBase } & {tiny integer } & {Set when Base Job run }
849 The {bf JobHisto} table is the same as the Job table, but it keeps
850 long term statistics (i.e. it is not pruned with the Job).
853 \addcontentsline{lot}{table}{Log Table Layout}
854 \begin{longtable}{|l|l|l|}
856 \multicolumn{3}{|l| }{\bf Version } \\
858 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
859 } & \multicolumn{1}{c| }{\bf Remark } \\
861 {LogIdId } & {integer } & {Primary Key }
863 {JobId } & {integer } & {Points to Job record }
865 {Time } & {datetime } & {Time/date log record created }
867 {LogText } & {blob } & {Log text }
872 The {\bf Log} table contains a log of all Job output.
874 \addcontentsline{lot}{table}{Location Table Layout}
875 \begin{longtable}{|l|l|l|}
877 \multicolumn{3}{|l| }{\bf Location } \\
879 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
880 } & \multicolumn{1}{c| }{\bf Remark } \\
882 {LocationId } & {integer } & {Primary Key }
884 {Location } & {tinyblob } & {Text defining location }
886 {Cost } & {integer } & {Relative cost of obtaining Volume }
888 {Enabled } & {tinyint } & {Whether or not Volume is enabled }
893 The {\bf Location} table defines where a Volume is physically.
896 \addcontentsline{lot}{table}{Location Log Table Layout}
897 \begin{longtable}{|l|l|l|}
899 \multicolumn{3}{|l| }{\bf LocationLog } \\
901 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
902 } & \multicolumn{1}{c| }{\bf Remark } \\
904 {locLogIdId } & {integer } & {Primary Key }
906 {Date } & {datetime } & {Time/date log record created }
908 {MediaId } & {integer } & {Points to Media record }
910 {LocationId } & {integer } & {Points to Location record }
912 {NewVolStatus } & {integer } & {enum: Full, Archive, Append, Recycle, Purged
913 Read-only, Disabled, Error, Busy, Used, Cleaning }
915 {Enabled } & {tinyint } & {Whether or not Volume is enabled }
921 The {\bf Log} table contains a log of all Job output.
924 \addcontentsline{lot}{table}{Version Table Layout}
925 \begin{longtable}{|l|l|l|}
927 \multicolumn{3}{|l| }{\bf Version } \\
929 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
930 } & \multicolumn{1}{c| }{\bf Remark } \\
932 {VersionId } & {integer } & {Primary Key }
937 The {\bf Version} table defines the Bacula database version number. Bacula
938 checks this number before reading the database to ensure that it is compatible
939 with the Bacula binary file.
942 \addcontentsline{lot}{table}{Base Files Table Layout}
943 \begin{longtable}{|l|l|l|}
945 \multicolumn{3}{|l| }{\bf BaseFiles } \\
947 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
948 } & \multicolumn{1}{c| }{\bf Remark } \\
950 {BaseId } & {integer } & {Primary Key } \\
952 {BaseJobId } & {integer } & {JobId of Base Job } \\
954 {JobId } & {integer } & {Reference to Job } \\
956 {FileId } & {integer } & {Reference to File } \\
958 {FileIndex } & {integer } & {File Index number }
963 The {\bf BaseFiles} table contains all the File references for a particular
964 JobId that point to a Base file -- i.e. they were previously saved and hence
965 were not saved in the current JobId but in BaseJobId under FileId. FileIndex
966 is the index of the file, and is used for optimization of Restore jobs to
967 prevent the need to read the FileId record when creating the in memory tree.
968 This record is not yet implemented.
972 \subsection{MySQL Table Definition}
973 \index[general]{MySQL Table Definition }
974 \index[general]{Definition!MySQL Table }
975 \addcontentsline{toc}{subsubsection}{MySQL Table Definition}
977 The commands used to create the MySQL tables are as follows:
982 CREATE TABLE Filename (
983 FilenameId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
985 PRIMARY KEY(FilenameId),
989 PathId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
995 FileId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
996 FileIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
997 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
998 PathId INTEGER UNSIGNED NOT NULL REFERENCES Path,
999 FilenameId INTEGER UNSIGNED NOT NULL REFERENCES Filename,
1000 MarkId INTEGER UNSIGNED NOT NULL DEFAULT 0,
1001 LStat TINYBLOB NOT NULL,
1002 MD5 TINYBLOB NOT NULL,
1003 PRIMARY KEY(FileId),
1009 JobId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
1010 Job TINYBLOB NOT NULL,
1011 Name TINYBLOB NOT NULL,
1012 Type BINARY(1) NOT NULL,
1013 Level BINARY(1) NOT NULL,
1014 ClientId INTEGER NOT NULL REFERENCES Client,
1015 JobStatus BINARY(1) NOT NULL,
1016 SchedTime DATETIME NOT NULL,
1017 StartTime DATETIME NOT NULL,
1018 EndTime DATETIME NOT NULL,
1019 JobTDate BIGINT UNSIGNED NOT NULL,
1020 VolSessionId INTEGER UNSIGNED NOT NULL DEFAULT 0,
1021 VolSessionTime INTEGER UNSIGNED NOT NULL DEFAULT 0,
1022 JobFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
1023 JobBytes BIGINT UNSIGNED NOT NULL,
1024 JobErrors INTEGER UNSIGNED NOT NULL DEFAULT 0,
1025 JobMissingFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
1026 PoolId INTEGER UNSIGNED NOT NULL REFERENCES Pool,
1027 FileSetId INTEGER UNSIGNED NOT NULL REFERENCES FileSet,
1028 PurgedFiles TINYINT NOT NULL DEFAULT 0,
1029 HasBase TINYINT NOT NULL DEFAULT 0,
1033 CREATE TABLE FileSet (
1034 FileSetId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
1035 FileSet TINYBLOB NOT NULL,
1036 MD5 TINYBLOB NOT NULL,
1037 CreateTime DATETIME NOT NULL,
1038 PRIMARY KEY(FileSetId)
1040 CREATE TABLE JobMedia (
1041 JobMediaId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
1042 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
1043 MediaId INTEGER UNSIGNED NOT NULL REFERENCES Media,
1044 FirstIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
1045 LastIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
1046 StartFile INTEGER UNSIGNED NOT NULL DEFAULT 0,
1047 EndFile INTEGER UNSIGNED NOT NULL DEFAULT 0,
1048 StartBlock INTEGER UNSIGNED NOT NULL DEFAULT 0,
1049 EndBlock INTEGER UNSIGNED NOT NULL DEFAULT 0,
1050 VolIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
1051 PRIMARY KEY(JobMediaId),
1052 INDEX (JobId, MediaId)
1054 CREATE TABLE Media (
1055 MediaId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
1056 VolumeName TINYBLOB NOT NULL,
1057 Slot INTEGER NOT NULL DEFAULT 0,
1058 PoolId INTEGER UNSIGNED NOT NULL REFERENCES Pool,
1059 MediaType TINYBLOB NOT NULL,
1060 FirstWritten DATETIME NOT NULL,
1061 LastWritten DATETIME NOT NULL,
1062 LabelDate DATETIME NOT NULL,
1063 VolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
1064 VolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
1065 VolBlocks INTEGER UNSIGNED NOT NULL DEFAULT 0,
1066 VolMounts INTEGER UNSIGNED NOT NULL DEFAULT 0,
1067 VolBytes BIGINT UNSIGNED NOT NULL DEFAULT 0,
1068 VolErrors INTEGER UNSIGNED NOT NULL DEFAULT 0,
1069 VolWrites INTEGER UNSIGNED NOT NULL DEFAULT 0,
1070 VolCapacityBytes BIGINT UNSIGNED NOT NULL,
1071 VolStatus ENUM('Full', 'Archive', 'Append', 'Recycle', 'Purged',
1072 'Read-Only', 'Disabled', 'Error', 'Busy', 'Used', 'Cleaning') NOT NULL,
1073 Recycle TINYINT NOT NULL DEFAULT 0,
1074 VolRetention BIGINT UNSIGNED NOT NULL DEFAULT 0,
1075 VolUseDuration BIGINT UNSIGNED NOT NULL DEFAULT 0,
1076 MaxVolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
1077 MaxVolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
1078 MaxVolBytes BIGINT UNSIGNED NOT NULL DEFAULT 0,
1079 InChanger TINYINT NOT NULL DEFAULT 0,
1080 MediaAddressing TINYINT NOT NULL DEFAULT 0,
1081 VolReadTime BIGINT UNSIGNED NOT NULL DEFAULT 0,
1082 VolWriteTime BIGINT UNSIGNED NOT NULL DEFAULT 0,
1083 PRIMARY KEY(MediaId),
1087 PoolId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
1088 Name TINYBLOB NOT NULL,
1089 NumVols INTEGER UNSIGNED NOT NULL DEFAULT 0,
1090 MaxVols INTEGER UNSIGNED NOT NULL DEFAULT 0,
1091 UseOnce TINYINT NOT NULL,
1092 UseCatalog TINYINT NOT NULL,
1093 AcceptAnyVolume TINYINT DEFAULT 0,
1094 VolRetention BIGINT UNSIGNED NOT NULL,
1095 VolUseDuration BIGINT UNSIGNED NOT NULL,
1096 MaxVolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
1097 MaxVolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
1098 MaxVolBytes BIGINT UNSIGNED NOT NULL,
1099 AutoPrune TINYINT DEFAULT 0,
1100 Recycle TINYINT DEFAULT 0,
1101 PoolType ENUM('Backup', 'Copy', 'Cloned', 'Archive', 'Migration', 'Scratch') NOT NULL,
1102 LabelFormat TINYBLOB,
1103 Enabled TINYINT DEFAULT 1,
1104 ScratchPoolId INTEGER UNSIGNED DEFAULT 0 REFERENCES Pool,
1105 RecyclePoolId INTEGER UNSIGNED DEFAULT 0 REFERENCES Pool,
1107 PRIMARY KEY (PoolId)
1109 CREATE TABLE Client (
1110 ClientId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
1111 Name TINYBLOB NOT NULL,
1112 Uname TINYBLOB NOT NULL, /* full uname -a of client */
1113 AutoPrune TINYINT DEFAULT 0,
1114 FileRetention BIGINT UNSIGNED NOT NULL,
1115 JobRetention BIGINT UNSIGNED NOT NULL,
1117 PRIMARY KEY(ClientId)
1119 CREATE TABLE BaseFiles (
1120 BaseId INTEGER UNSIGNED AUTO_INCREMENT,
1121 BaseJobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
1122 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
1123 FileId INTEGER UNSIGNED NOT NULL REFERENCES File,
1124 FileIndex INTEGER UNSIGNED,
1127 CREATE TABLE UnsavedFiles (
1128 UnsavedId INTEGER UNSIGNED AUTO_INCREMENT,
1129 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
1130 PathId INTEGER UNSIGNED NOT NULL REFERENCES Path,
1131 FilenameId INTEGER UNSIGNED NOT NULL REFERENCES Filename,
1132 PRIMARY KEY (UnsavedId)
1134 CREATE TABLE Version (
1135 VersionId INTEGER UNSIGNED NOT NULL
1137 -- Initialize Version
1138 INSERT INTO Version (VersionId) VALUES (7);
1139 CREATE TABLE Counters (
1140 Counter TINYBLOB NOT NULL,
1143 CurrentValue INTEGER,
1144 WrapCounter TINYBLOB NOT NULL,
1145 PRIMARY KEY (Counter(128))