From e6a5d31ff279096536ee71e0b1d846b9a6bd4003 Mon Sep 17 00:00:00 2001 From: "Nicole C. Engard" Date: Wed, 28 Sep 2011 06:19:33 -0400 Subject: [PATCH] [SIGNED-OFF] bug6716: documenting reserves and old_reserves tables This patch documents the reserves and the old_reserves table. Note that a few fields are marked unused: notificationdate and reminderdate. Also two fields are left undocumented: lowestPriority which never seems to be anything other than 0 and constrainttype which is either 'a' or 0, but there doesn't appear to be any explanation as to what each stands for. Signed-off-by: Katrin Fischer --- installer/data/mysql/kohastructure.sql | 60 ++++++++++++++++---------------- 1 files changed, 30 insertions(+), 30 deletions(-) diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql index 452173d..60ac345 100644 --- a/installer/data/mysql/kohastructure.sql +++ b/installer/data/mysql/kohastructure.sql @@ -1382,22 +1382,22 @@ CREATE TABLE `old_issues` ( -- lists items that were checked out and have been r -- Table structure for table `old_reserves` -- DROP TABLE IF EXISTS `old_reserves`; -CREATE TABLE `old_reserves` ( - `borrowernumber` int(11) default NULL, - `reservedate` date default NULL, - `biblionumber` int(11) default NULL, +CREATE TABLE `old_reserves` ( -- this table holds all holds/reserves that have been completed (either filled or cancelled) + `borrowernumber` int(11) default NULL, -- foreign key from the borrowers table defining which patron this hold is for + `reservedate` date default NULL, -- the date the hold was places + `biblionumber` int(11) default NULL, -- foreign key from the biblio table defining which bib record this hold is on `constrainttype` varchar(1) default NULL, - `branchcode` varchar(10) default NULL, - `notificationdate` date default NULL, - `reminderdate` date default NULL, - `cancellationdate` date default NULL, - `reservenotes` mediumtext, - `priority` smallint(6) default NULL, - `found` varchar(1) default NULL, - `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, - `itemnumber` int(11) default NULL, - `waitingdate` date default NULL, - `expirationdate` DATE DEFAULT NULL, + `branchcode` varchar(10) default NULL, -- foreign key from the branches table defining which branch the patron wishes to pick this hold up at + `notificationdate` date default NULL, -- currently unused + `reminderdate` date default NULL, -- currently unused + `cancellationdate` date default NULL, -- the date this hold was cancelled + `reservenotes` mediumtext, -- notes related to this hold + `priority` smallint(6) default NULL, -- where in the queue the patron sits + `found` varchar(1) default NULL, -- a one letter code defining what the the status is of the hold is after it has been confirmed + `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this hold was last updated + `itemnumber` int(11) default NULL, -- foreign key from the items table defining the specific item the patron has placed on hold or the item this hold was filled with + `waitingdate` date default NULL, -- the date the item was marked as waiting for the patron at the library + `expirationdate` DATE DEFAULT NULL, -- the date the hold expires (usually the date entered by the patron to say they don't need the hold after a certain date) `lowestPriority` tinyint(1) NOT NULL, KEY `old_reserves_borrowernumber` (`borrowernumber`), KEY `old_reserves_biblionumber` (`biblionumber`), @@ -1557,22 +1557,22 @@ CREATE TABLE `reserveconstraints` ( -- DROP TABLE IF EXISTS `reserves`; -CREATE TABLE `reserves` ( - `borrowernumber` int(11) NOT NULL default 0, - `reservedate` date default NULL, - `biblionumber` int(11) NOT NULL default 0, +CREATE TABLE `reserves` ( -- information related to holds/reserves in Koha + `borrowernumber` int(11) NOT NULL default 0, -- foreign key from the borrowers table defining which patron this hold is for + `reservedate` date default NULL, -- the date the hold was places + `biblionumber` int(11) NOT NULL default 0, -- foreign key from the biblio table defining which bib record this hold is on `constrainttype` varchar(1) default NULL, - `branchcode` varchar(10) default NULL, - `notificationdate` date default NULL, - `reminderdate` date default NULL, - `cancellationdate` date default NULL, - `reservenotes` mediumtext, - `priority` smallint(6) default NULL, - `found` varchar(1) default NULL, - `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, - `itemnumber` int(11) default NULL, - `waitingdate` date default NULL, - `expirationdate` DATE DEFAULT NULL, + `branchcode` varchar(10) default NULL, -- foreign key from the branches table defining which branch the patron wishes to pick this hold up at + `notificationdate` date default NULL, -- currently unused + `reminderdate` date default NULL, -- currently unused + `cancellationdate` date default NULL, -- the date this hold was cancelled + `reservenotes` mediumtext, -- notes related to this hold + `priority` smallint(6) default NULL, -- where in the queue the patron sits + `found` varchar(1) default NULL, -- a one letter code defining what the the status is of the hold is after it has been confirmed + `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this hold was last updated + `itemnumber` int(11) default NULL, -- foreign key from the items table defining the specific item the patron has placed on hold or the item this hold was filled with + `waitingdate` date default NULL, -- the date the item was marked as waiting for the patron at the library + `expirationdate` DATE DEFAULT NULL, -- the date the hold expires (usually the date entered by the patron to say they don't need the hold after a certain date) `lowestPriority` tinyint(1) NOT NULL, KEY priorityfoundidx (priority,found), KEY `borrowernumber` (`borrowernumber`), -- 1.7.5.4