[Koha-patches] [PATCH] Bug 6716 Documenting two Branch Group tables

[Nicole C. Engard]

This patch documents the branchcategories table and the
branchrelations table. Both tables are used in the library/
branch groups administration.

Signed-off-by: Nicole C. Engard <nengard at bywatersolutions.com>
---
 installer/data/mysql/kohastructure.sql |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql
index e9edf25..9042210 100644
--- a/installer/data/mysql/kohastructure.sql
+++ b/installer/data/mysql/kohastructure.sql
@@ -324,11 +324,11 @@ CREATE TABLE `branch_item_rules` (
 --
 
 DROP TABLE IF EXISTS `branchcategories`;
-CREATE TABLE `branchcategories` (
-  `categorycode` varchar(10) NOT NULL default '',
-  `categoryname` varchar(32),
-  `codedescription` mediumtext,
-  `categorytype` varchar(16),
+CREATE TABLE `branchcategories` ( -- information related to library/branch groups 
+  `categorycode` varchar(10) NOT NULL default '', -- unique key, used to identify the group
+  `categoryname` varchar(32), -- name used to identify the group
+  `codedescription` mediumtext, -- description of the group
+  `categorytype` varchar(16), -- defines if this is a search or properties group
   PRIMARY KEY  (`categorycode`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
@@ -363,9 +363,9 @@ CREATE TABLE `branches` (
 --
 
 DROP TABLE IF EXISTS `branchrelations`;
-CREATE TABLE `branchrelations` (
-  `branchcode` varchar(10) NOT NULL default '',
-  `categorycode` varchar(10) NOT NULL default '',
+CREATE TABLE `branchrelations` ( -- tracks which libraries/branches are in each library/branch group
+  `branchcode` varchar(10) NOT NULL default '', -- foreign key linking to the branches table
+  `categorycode` varchar(10) NOT NULL default '', -- foreign key linking to the branchcategories table
   PRIMARY KEY  (`branchcode`,`categorycode`),
   KEY `branchcode` (`branchcode`),
   KEY `categorycode` (`categorycode`),
-- 
1.7.2.3