Bug 6716: Document search_history table

diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql
index ac35443..a26b149 100644 (file)
--- a/installer/data/mysql/kohastructure.sql
+++ b/installer/data/mysql/kohastructure.sql
@@ -1746,13 +1746,13 @@ CREATE TABLE saved_reports (
 --
 
 DROP TABLE IF EXISTS `search_history`;
-CREATE TABLE IF NOT EXISTS `search_history` (
-  `userid` int(11) NOT NULL,
-  `sessionid` varchar(32) NOT NULL,
-  `query_desc` varchar(255) NOT NULL,
-  `query_cgi` text NOT NULL,
-  `total` int(11) NOT NULL,
-  `time` timestamp NOT NULL default CURRENT_TIMESTAMP,
+CREATE TABLE IF NOT EXISTS `search_history` ( -- patron's opac search history
+  `userid` int(11) NOT NULL, -- the patron who performed the search (borrowers.borrowernumber)
+  `sessionid` varchar(32) NOT NULL, -- a system generated session id
+  `query_desc` varchar(255) NOT NULL, -- the search that was performed
+  `query_cgi` text NOT NULL, -- the string to append to the search url to rerun the search
+  `total` int(11) NOT NULL, -- the total of results found
+  `time` timestamp NOT NULL default CURRENT_TIMESTAMP, -- the date and time the search was run
   KEY `userid` (`userid`),
   KEY `sessionid` (`sessionid`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Opac search history results';