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 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 {JobTDate } & {bigint } & {Start day in Unix format but 64 bits; used for
314 Retention period. } \\
316 {VolSessionId } & {integer } & {Unique Volume Session ID } \\
318 {VolSessionTime } & {integer } & {Unique Volume Session Time } \\
320 {JobFiles } & {integer } & {Number of files saved in Job } \\
322 {JobBytes } & {bigint } & {Number of bytes saved in Job } \\
324 {JobErrors } & {integer } & {Number of errors during Job } \\
326 {JobMissingFiles } & {integer } & {Number of files not saved (not yet used) }
329 {PoolId } & {integer } & {Link to Pool Record } \\
331 {FileSetId } & {integer } & {Link to FileSet Record } \\
333 {PurgedFiles } & {tiny integer } & {Set when all File records purged } \\
335 {HasBase } & {tiny integer } & {Set when Base Job run }
340 The {\bf Job} table contains one record for each Job run by Bacula. Thus
341 normally, there will be one per day per machine added to the database. Note,
342 the JobId is used to index Job records in the database, and it often is shown
343 to the user in the Console program. However, care must be taken with its use
344 as it is not unique from database to database. For example, the user may have
345 a database for Client data saved on machine Rufus and another database for
346 Client data saved on machine Roxie. In this case, the two database will each
347 have JobIds that match those in another database. For a unique reference to a
350 The Name field of the Job record corresponds to the Name resource record given
351 in the Director's configuration file. Thus it is a generic name, and it will
352 be normal to find many Jobs (or even all Jobs) with the same Name.
354 The Job field contains a combination of the Name and the schedule time of the
355 Job by the Director. Thus for a given Director, even with multiple Catalog
356 databases, the Job will contain a unique name that represents the Job.
358 For a given Storage daemon, the VolSessionId and VolSessionTime form a unique
359 identification of the Job. This will be the case even if multiple Directors
360 are using the same Storage daemon.
362 The Job Type (or simply Type) can have one of the following values:
364 \addcontentsline{lot}{table}{Job Types}
365 \begin{longtable}{|l|l|}
367 \multicolumn{1}{|c| }{\bf Value } & \multicolumn{1}{c| }{\bf Meaning } \\
369 {B } & {Backup Job } \\
371 {V } & {Verify Job } \\
373 {R } & {Restore Job } \\
375 {C } & {Console program (not in database) } \\
377 {D } & {Admin Job } \\
379 {A } & {Archive Job (not implemented) }
384 The JobStatus field specifies how the job terminated, and can be one of the
387 \addcontentsline{lot}{table}{Job Statuses}
388 \begin{longtable}{|l|l|}
390 \multicolumn{1}{|c| }{\bf Value } & \multicolumn{1}{c| }{\bf Meaning } \\
392 {C } & {Created but not yet running } \\
398 {T } & {Terminated normally } \\
400 {E } & {Terminated in Error } \\
402 {e } & {Non-fatal error } \\
404 {f } & {Fatal error } \\
406 {D } & {Verify Differences } \\
408 {A } & {Canceled by the user } \\
410 {F } & {Waiting on the File daemon } \\
412 {S } & {Waiting on the Storage daemon } \\
414 {m } & {Waiting for a new Volume to be mounted } \\
416 {M } & {Waiting for a Mount } \\
418 {s } & {Waiting for Storage resource } \\
420 {j } & {Waiting for Job resource } \\
422 {c } & {Waiting for Client resource } \\
424 {d } & {Wating for Maximum jobs } \\
426 {t } & {Waiting for Start Time } \\
428 {p } & {Waiting for higher priority job to finish }
435 \addcontentsline{lot}{table}{File Sets Table Layout}
436 \begin{longtable}{|l|l|l|}
438 \multicolumn{3}{|l| }{\bf FileSet } \\
440 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
441 \ \ } & \multicolumn{1}{c| }{\bf Remark } \\
443 {FileSetId } & {integer } & {Primary Key } \\
445 {FileSet } & {tinyblob } & {FileSet name } \\
447 {MD5 } & {tinyblob } & {MD5 checksum of FileSet } \\
449 {CreateTime } & {datetime } & {Time and date Fileset created }
454 The {\bf FileSet} table contains one entry for each FileSet that is used. The
455 MD5 signature is kept to ensure that if the user changes anything inside the
456 FileSet, it will be detected and the new FileSet will be used. This is
457 particularly important when doing an incremental update. If the user deletes a
458 file or adds a file, we need to ensure that a Full backup is done prior to the
463 \addcontentsline{lot}{table}{JobMedia Table Layout}
464 \begin{longtable}{|l|l|p{2.5in}|}
466 \multicolumn{3}{|l| }{\bf JobMedia } \\
468 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
469 \ \ } & \multicolumn{1}{c| }{\bf Remark } \\
471 {JobMediaId } & {integer } & {Primary Key } \\
473 {JobId } & {integer } & {Link to Job Record } \\
475 {MediaId } & {integer } & {Link to Media Record } \\
477 {FirstIndex } & {integer } & {The index (sequence number) of the first file
478 written for this Job to the Media } \\
480 {LastIndex } & {integer } & {The index of the last file written for this
481 Job to the Media } \\
483 {StartFile } & {integer } & {The physical media (tape) file number of the
484 first block written for this Job } \\
486 {EndFile } & {integer } & {The physical media (tape) file number of the
487 last block written for this Job } \\
489 {StartBlock } & {integer } & {The number of the first block written for
492 {EndBlock } & {integer } & {The number of the last block written for this
495 {VolIndex } & {integer } & {The Volume use sequence number within the Job }
500 The {\bf JobMedia} table contains one entry at the following: start of
501 the job, start of each new tape file, start of each new tape, end of the
502 job. Since by default, a new tape file is written every 2GB, in general,
503 you will have more than 2 JobMedia records per Job. The number can be
504 varied by changing the "Maximum File Size" specified in the Device
505 resource. This record allows Bacula to efficiently position close to
506 (within 2GB) any given file in a backup. For restoring a full Job,
507 these records are not very important, but if you want to retrieve
508 a single file that was written near the end of a 100GB backup, the
509 JobMedia records can speed it up by orders of magnitude by permitting
510 forward spacing files and blocks rather than reading the whole 100GB
517 \addcontentsline{lot}{table}{Media Table Layout}
518 \begin{longtable}{|l|l|p{2.4in}|}
520 \multicolumn{3}{|l| }{\bf Media } \\
522 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
523 \ \ } & \multicolumn{1}{c| }{\bf Remark } \\
525 {MediaId } & {integer } & {Primary Key } \\
527 {VolumeName } & {tinyblob } & {Volume name } \\
529 {Slot } & {integer } & {Autochanger Slot number or zero } \\
531 {PoolId } & {integer } & {Link to Pool Record } \\
533 {MediaType } & {tinyblob } & {The MediaType supplied by the user } \\
535 {FirstWritten } & {datetime } & {Time/date when first written } \\
537 {LastWritten } & {datetime } & {Time/date when last written } \\
539 {LabelDate } & {datetime } & {Time/date when tape labeled } \\
541 {VolJobs } & {integer } & {Number of jobs written to this media } \\
543 {VolFiles } & {integer } & {Number of files written to this media } \\
545 {VolBlocks } & {integer } & {Number of blocks written to this media } \\
547 {VolMounts } & {integer } & {Number of time media mounted } \\
549 {VolBytes } & {bigint } & {Number of bytes saved in Job } \\
551 {VolErrors } & {integer } & {Number of errors during Job } \\
553 {VolWrites } & {integer } & {Number of writes to media } \\
555 {MaxVolBytes } & {bigint } & {Maximum bytes to put on this media } \\
557 {VolCapacityBytes } & {bigint } & {Capacity estimate for this volume } \\
559 {VolStatus } & {enum } & {Status of media: Full, Archive, Append, Recycle,
560 Read-Only, Disabled, Error, Busy } \\
562 {Recycle } & {tinyint } & {Whether or not Bacula can recycle the Volumes:
565 {VolRetention } & {bigint } & {64 bit seconds until expiration } \\
567 {VolUseDuration } & {bigint } & {64 bit seconds volume can be used } \\
569 {MaxVolJobs } & {integer } & {maximum jobs to put on Volume } \\
571 {MaxVolFiles } & {integer } & {maximume EOF marks to put on Volume }
576 The {\bf Volume} table (internally referred to as the Media table) contains
577 one entry for each volume, that is each tape, cassette (8mm, DLT, DAT, ...),
578 or file on which information is or was backed up. There is one Volume record
579 created for each of the NumVols specified in the Pool resource record.
583 \addcontentsline{lot}{table}{Pool Table Layout}
584 \begin{longtable}{|l|l|p{2.4in}|}
586 \multicolumn{3}{|l| }{\bf Pool } \\
588 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
589 } & \multicolumn{1}{c| }{\bf Remark } \\
591 {PoolId } & {integer } & {Primary Key } \\
593 {Name } & {Tinyblob } & {Pool Name } \\
595 {NumVols } & {Integer } & {Number of Volumes in the Pool } \\
597 {MaxVols } & {Integer } & {Maximum Volumes in the Pool } \\
599 {UseOnce } & {tinyint } & {Use volume once } \\
601 {UseCatalog } & {tinyint } & {Set to use catalog } \\
603 {AcceptAnyVolume } & {tinyint } & {Accept any volume from Pool } \\
605 {VolRetention } & {bigint } & {64 bit seconds to retain volume } \\
607 {VolUseDuration } & {bigint } & {64 bit seconds volume can be used } \\
609 {MaxVolJobs } & {integer } & {max jobs on volume } \\
611 {MaxVolFiles } & {integer } & {max EOF marks to put on Volume } \\
613 {MaxVolBytes } & {bigint } & {max bytes to write on Volume } \\
615 {AutoPrune } & {tinyint } & {yes|no for autopruning } \\
617 {Recycle } & {tinyint } & {yes|no for allowing auto recycling of Volume }
620 {PoolType } & {enum } & {Backup, Copy, Cloned, Archive, Migration } \\
622 {LabelFormat } & {Tinyblob } & {Label format }
627 The {\bf Pool} table contains one entry for each media pool controlled by
628 Bacula in this database. One media record exists for each of the NumVols
629 contained in the Pool. The PoolType is a Bacula defined keyword. The MediaType
630 is defined by the administrator, and corresponds to the MediaType specified in
631 the Director's Storage definition record. The CurrentVol is the sequence
632 number of the Media record for the current volume.
636 \addcontentsline{lot}{table}{Client Table Layout}
637 \begin{longtable}{|l|l|l|}
639 \multicolumn{3}{|l| }{\bf Client } \\
641 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
642 } & \multicolumn{1}{c| }{\bf Remark } \\
644 {ClientId } & {integer } & {Primary Key } \\
646 {Name } & {TinyBlob } & {File Services Name } \\
648 {UName } & {TinyBlob } & {uname -a from Client (not yet used) } \\
650 {AutoPrune } & {tinyint } & {yes|no for autopruning } \\
652 {FileRetention } & {bigint } & {64 bit seconds to retain Files } \\
654 {JobRetention } & {bigint } & {64 bit seconds to retain Job }
659 The {\bf Client} table contains one entry for each machine backed up by Bacula
660 in this database. Normally the Name is a fully qualified domain name.
664 \addcontentsline{lot}{table}{Unsaved Files Table Layout}
665 \begin{longtable}{|l|l|l|}
667 \multicolumn{3}{|l| }{\bf UnsavedFiles } \\
669 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
670 } & \multicolumn{1}{c| }{\bf Remark } \\
672 {UnsavedId } & {integer } & {Primary Key } \\
674 {JobId } & {integer } & {JobId corresponding to this record } \\
676 {PathId } & {integer } & {Id of path } \\
678 {FilenameId } & {integer } & {Id of filename }
683 The {\bf UnsavedFiles} table contains one entry for each file that was not
684 saved. Note! This record is not yet implemented.
688 \addcontentsline{lot}{table}{Counter Table Layout}
689 \begin{longtable}{|l|l|l|}
691 \multicolumn{3}{|l| }{\bf Counter } \\
693 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
694 } & \multicolumn{1}{c| }{\bf Remark } \\
696 {Counter } & {tinyblob } & {Counter name } \\
698 {MinValue } & {integer } & {Start/Min value for counter } \\
700 {MaxValue } & {integer } & {Max value for counter } \\
702 {CurrentValue } & {integer } & {Current counter value } \\
704 {WrapCounter } & {tinyblob } & {Name of another counter }
709 The {\bf Counter} table contains one entry for each permanent counter defined
714 \addcontentsline{lot}{table}{Version Table Layout}
715 \begin{longtable}{|l|l|l|}
717 \multicolumn{3}{|l| }{\bf Version } \\
719 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
720 } & \multicolumn{1}{c| }{\bf Remark } \\
722 {VersionId } & {integer } & {Primary Key }
727 The {\bf Version} table defines the Bacula database version number. Bacula
728 checks this number before reading the database to ensure that it is compatible
729 with the Bacula binary file.
733 \addcontentsline{lot}{table}{Base Files Table Layout}
734 \begin{longtable}{|l|l|l|}
736 \multicolumn{3}{|l| }{\bf BaseFiles } \\
738 \multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
739 } & \multicolumn{1}{c| }{\bf Remark } \\
741 {BaseId } & {integer } & {Primary Key } \\
743 {BaseJobId } & {integer } & {JobId of Base Job } \\
745 {JobId } & {integer } & {Reference to Job } \\
747 {FileId } & {integer } & {Reference to File } \\
749 {FileIndex } & {integer } & {File Index number }
754 The {\bf BaseFiles} table contains all the File references for a particular
755 JobId that point to a Base file -- i.e. they were previously saved and hence
756 were not saved in the current JobId but in BaseJobId under FileId. FileIndex
757 is the index of the file, and is used for optimization of Restore jobs to
758 prevent the need to read the FileId record when creating the in memory tree.
759 This record is not yet implemented.
763 \subsection{MySQL Table Definition}
764 \index[general]{MySQL Table Definition }
765 \index[general]{Definition!MySQL Table }
766 \addcontentsline{toc}{subsubsection}{MySQL Table Definition}
768 The commands used to create the MySQL tables are as follows:
773 CREATE TABLE Filename (
774 FilenameId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
776 PRIMARY KEY(FilenameId),
780 PathId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
786 FileId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
787 FileIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
788 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
789 PathId INTEGER UNSIGNED NOT NULL REFERENCES Path,
790 FilenameId INTEGER UNSIGNED NOT NULL REFERENCES Filename,
791 MarkId INTEGER UNSIGNED NOT NULL DEFAULT 0,
792 LStat TINYBLOB NOT NULL,
793 MD5 TINYBLOB NOT NULL,
800 JobId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
801 Job TINYBLOB NOT NULL,
802 Name TINYBLOB NOT NULL,
803 Type BINARY(1) NOT NULL,
804 Level BINARY(1) NOT NULL,
805 ClientId INTEGER NOT NULL REFERENCES Client,
806 JobStatus BINARY(1) NOT NULL,
807 SchedTime DATETIME NOT NULL,
808 StartTime DATETIME NOT NULL,
809 EndTime DATETIME NOT NULL,
810 JobTDate BIGINT UNSIGNED NOT NULL,
811 VolSessionId INTEGER UNSIGNED NOT NULL DEFAULT 0,
812 VolSessionTime INTEGER UNSIGNED NOT NULL DEFAULT 0,
813 JobFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
814 JobBytes BIGINT UNSIGNED NOT NULL,
815 JobErrors INTEGER UNSIGNED NOT NULL DEFAULT 0,
816 JobMissingFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
817 PoolId INTEGER UNSIGNED NOT NULL REFERENCES Pool,
818 FileSetId INTEGER UNSIGNED NOT NULL REFERENCES FileSet,
819 PurgedFiles TINYINT NOT NULL DEFAULT 0,
820 HasBase TINYINT NOT NULL DEFAULT 0,
824 CREATE TABLE FileSet (
825 FileSetId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
826 FileSet TINYBLOB NOT NULL,
827 MD5 TINYBLOB NOT NULL,
828 CreateTime DATETIME NOT NULL,
829 PRIMARY KEY(FileSetId)
831 CREATE TABLE JobMedia (
832 JobMediaId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
833 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
834 MediaId INTEGER UNSIGNED NOT NULL REFERENCES Media,
835 FirstIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
836 LastIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
837 StartFile INTEGER UNSIGNED NOT NULL DEFAULT 0,
838 EndFile INTEGER UNSIGNED NOT NULL DEFAULT 0,
839 StartBlock INTEGER UNSIGNED NOT NULL DEFAULT 0,
840 EndBlock INTEGER UNSIGNED NOT NULL DEFAULT 0,
841 VolIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
842 PRIMARY KEY(JobMediaId),
843 INDEX (JobId, MediaId)
846 MediaId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
847 VolumeName TINYBLOB NOT NULL,
848 Slot INTEGER NOT NULL DEFAULT 0,
849 PoolId INTEGER UNSIGNED NOT NULL REFERENCES Pool,
850 MediaType TINYBLOB NOT NULL,
851 FirstWritten DATETIME NOT NULL,
852 LastWritten DATETIME NOT NULL,
853 LabelDate DATETIME NOT NULL,
854 VolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
855 VolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
856 VolBlocks INTEGER UNSIGNED NOT NULL DEFAULT 0,
857 VolMounts INTEGER UNSIGNED NOT NULL DEFAULT 0,
858 VolBytes BIGINT UNSIGNED NOT NULL DEFAULT 0,
859 VolErrors INTEGER UNSIGNED NOT NULL DEFAULT 0,
860 VolWrites INTEGER UNSIGNED NOT NULL DEFAULT 0,
861 VolCapacityBytes BIGINT UNSIGNED NOT NULL,
862 VolStatus ENUM('Full', 'Archive', 'Append', 'Recycle', 'Purged',
863 'Read-Only', 'Disabled', 'Error', 'Busy', 'Used', 'Cleaning') NOT NULL,
864 Recycle TINYINT NOT NULL DEFAULT 0,
865 VolRetention BIGINT UNSIGNED NOT NULL DEFAULT 0,
866 VolUseDuration BIGINT UNSIGNED NOT NULL DEFAULT 0,
867 MaxVolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
868 MaxVolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
869 MaxVolBytes BIGINT UNSIGNED NOT NULL DEFAULT 0,
870 InChanger TINYINT NOT NULL DEFAULT 0,
871 MediaAddressing TINYINT NOT NULL DEFAULT 0,
872 VolReadTime BIGINT UNSIGNED NOT NULL DEFAULT 0,
873 VolWriteTime BIGINT UNSIGNED NOT NULL DEFAULT 0,
874 PRIMARY KEY(MediaId),
878 PoolId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
879 Name TINYBLOB NOT NULL,
880 NumVols INTEGER UNSIGNED NOT NULL DEFAULT 0,
881 MaxVols INTEGER UNSIGNED NOT NULL DEFAULT 0,
882 UseOnce TINYINT NOT NULL,
883 UseCatalog TINYINT NOT NULL,
884 AcceptAnyVolume TINYINT DEFAULT 0,
885 VolRetention BIGINT UNSIGNED NOT NULL,
886 VolUseDuration BIGINT UNSIGNED NOT NULL,
887 MaxVolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
888 MaxVolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
889 MaxVolBytes BIGINT UNSIGNED NOT NULL,
890 AutoPrune TINYINT DEFAULT 0,
891 Recycle TINYINT DEFAULT 0,
892 PoolType ENUM('Backup', 'Copy', 'Cloned', 'Archive', 'Migration', 'Scratch') NOT NULL,
893 LabelFormat TINYBLOB,
894 Enabled TINYINT DEFAULT 1,
895 ScratchPoolId INTEGER UNSIGNED DEFAULT 0 REFERENCES Pool,
896 RecyclePoolId INTEGER UNSIGNED DEFAULT 0 REFERENCES Pool,
900 CREATE TABLE Client (
901 ClientId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
902 Name TINYBLOB NOT NULL,
903 Uname TINYBLOB NOT NULL, /* full uname -a of client */
904 AutoPrune TINYINT DEFAULT 0,
905 FileRetention BIGINT UNSIGNED NOT NULL,
906 JobRetention BIGINT UNSIGNED NOT NULL,
908 PRIMARY KEY(ClientId)
910 CREATE TABLE BaseFiles (
911 BaseId INTEGER UNSIGNED AUTO_INCREMENT,
912 BaseJobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
913 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
914 FileId INTEGER UNSIGNED NOT NULL REFERENCES File,
915 FileIndex INTEGER UNSIGNED,
918 CREATE TABLE UnsavedFiles (
919 UnsavedId INTEGER UNSIGNED AUTO_INCREMENT,
920 JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
921 PathId INTEGER UNSIGNED NOT NULL REFERENCES Path,
922 FilenameId INTEGER UNSIGNED NOT NULL REFERENCES Filename,
923 PRIMARY KEY (UnsavedId)
925 CREATE TABLE Version (
926 VersionId INTEGER UNSIGNED NOT NULL
928 -- Initialize Version
929 INSERT INTO Version (VersionId) VALUES (7);
930 CREATE TABLE Counters (
931 Counter TINYBLOB NOT NULL,
934 CurrentValue INTEGER,
935 WrapCounter TINYBLOB NOT NULL,
936 PRIMARY KEY (Counter(128))