Bug 6716 - MySQL Table Documentation - Biblio Table

This patch documents the biblio table, with the exception of the
seriestitle field which I could not find an example of.

Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>

diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql
index ea31677..ba2f766 100644 (file)
--- a/installer/data/mysql/kohastructure.sql
+++ b/installer/data/mysql/kohastructure.sql
@@ -113,19 +113,19 @@ CREATE TABLE `authorised_values` ( -- stores values for authorized values catego
 --
 
 DROP TABLE IF EXISTS `biblio`;
-CREATE TABLE `biblio` (
-  `biblionumber` int(11) NOT NULL auto_increment,
-  `frameworkcode` varchar(4) NOT NULL default '',
-  `author` mediumtext,
-  `title` mediumtext,
-  `unititle` mediumtext,
-  `notes` mediumtext,
-  `serial` tinyint(1) default NULL,
+CREATE TABLE `biblio` ( -- table that stores bibliographic information
+  `biblionumber` int(11) NOT NULL auto_increment, -- unique identifier assigned to each bibliographic record
+  `frameworkcode` varchar(4) NOT NULL default '', -- foriegn key from the biblio_framework table to identify which framework was used in cataloging this record
+  `author` mediumtext, -- statement of responsibility from MARC record (100 in MARC21)
+  `title` mediumtext, -- title (without the subtitle) from the MARC record (245 in MARC21)
+  `unititle` mediumtext, -- uniform title (without the subtitle) from the MARC record (240 in MARC21)
+  `notes` mediumtext, -- values from the general notes field in the MARC record (500 in MARC21) split by bar (|)
+  `serial` tinyint(1) default NULL, -- foreign key, linking to the subscriptionid in the serial table
   `seriestitle` mediumtext,
-  `copyrightdate` smallint(6) default NULL,
-  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
-  `datecreated` DATE NOT NULL,
-  `abstract` mediumtext,
+  `copyrightdate` smallint(6) default NULL, -- publication or copyright date from the MARC record
+  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time this record was last touched
+  `datecreated` DATE NOT NULL, -- the date this record was added to Koha
+  `abstract` mediumtext, -- summary from the MARC record (520 in MARC21)
   PRIMARY KEY  (`biblionumber`),
   KEY `blbnoidx` (`biblionumber`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;