[Koha-patches] [PATCH] Bug 6716: Document search_history table

[Nicole C. Engard]

---
 installer/data/mysql/kohastructure.sql |   22 +++++++++++-----------
 1 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql
index 3b9827a..cc65b3c 100644
--- a/installer/data/mysql/kohastructure.sql
+++ b/installer/data/mysql/kohastructure.sql
@@ -899,10 +899,10 @@ CREATE TABLE `import_records` (
 -- Table structure for `import_record_matches`
 --
 DROP TABLE IF EXISTS `import_record_matches`;
-CREATE TABLE `import_record_matches` (
-  `import_record_id` int(11) NOT NULL,
-  `candidate_match_id` int(11) NOT NULL,
-  `score` int(11) NOT NULL default 0,
+CREATE TABLE `import_record_matches` ( -- matches found when importing a batch of records
+  `import_record_id` int(11) NOT NULL, -- the id given to the imported bib record (import_records.import_record_id)
+  `candidate_match_id` int(11) NOT NULL, -- the biblio the imported record matches (biblio.biblionumber)
+  `score` int(11) NOT NULL default 0, -- the match score
   CONSTRAINT `import_record_matches_ibfk_1` FOREIGN KEY (`import_record_id`)
              REFERENCES `import_records` (`import_record_id`) ON DELETE CASCADE ON UPDATE CASCADE,
   KEY `record_score` (`import_record_id`, `score`)
@@ -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';
-- 
1.7.2.3