View | Details | Raw Unified | Return to bug 26947
Collapse All | Expand All

(-)a/installer/data/mysql/kohastructure.sql (-1140 / +1139 lines)
Lines 110-121 CREATE TABLE `authorised_value_categories` ( Link Here
110
110
111
DROP TABLE IF EXISTS `authorised_values`;
111
DROP TABLE IF EXISTS `authorised_values`;
112
CREATE TABLE `authorised_values` ( -- stores values for authorized values categories and values
112
CREATE TABLE `authorised_values` ( -- stores values for authorized values categories and values
113
  `id` int(11) NOT NULL auto_increment, -- unique key, used to identify the authorized value
113
  `id` int(11) NOT NULL auto_increment COMMENT "unique key, used to identify the authorized value",
114
  `category` varchar(32) NOT NULL default '', -- key used to identify the authorized value category
114
  `category` varchar(32) NOT NULL default '' COMMENT "key used to identify the authorized value category",
115
  `authorised_value` varchar(80) NOT NULL default '', -- code use to identify the authorized value
115
  `authorised_value` varchar(80) NOT NULL default '' COMMENT "code use to identify the authorized value",
116
  `lib` varchar(200) default NULL, -- authorized value description as printed in the staff interface
116
  `lib` varchar(200) default NULL COMMENT "authorized value description as printed in the staff interface",
117
  `lib_opac` varchar(200) default NULL, -- authorized value description as printed in the OPAC
117
  `lib_opac` varchar(200) default NULL COMMENT "authorized value description as printed in the OPAC",
118
  `imageurl` varchar(200) default NULL, -- authorized value URL
118
  `imageurl` varchar(200) default NULL COMMENT "authorized value URL",
119
  PRIMARY KEY  (`id`),
119
  PRIMARY KEY  (`id`),
120
  KEY `name` (`category`),
120
  KEY `name` (`category`),
121
  KEY `lib` (`lib` (191)),
121
  KEY `lib` (`lib` (191)),
Lines 130-151 CREATE TABLE `authorised_values` ( -- stores values for authorized values catego Link Here
130
130
131
DROP TABLE IF EXISTS `biblio`;
131
DROP TABLE IF EXISTS `biblio`;
132
CREATE TABLE `biblio` ( -- table that stores bibliographic information
132
CREATE TABLE `biblio` ( -- table that stores bibliographic information
133
  `biblionumber` int(11) NOT NULL auto_increment, -- unique identifier assigned to each bibliographic record
133
  `biblionumber` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned to each bibliographic record",
134
  `frameworkcode` varchar(4) NOT NULL default '', -- foreign key from the biblio_framework table to identify which framework was used in cataloging this record
134
  `frameworkcode` varchar(4) NOT NULL default '' COMMENT "foreign key from the biblio_framework table to identify which framework was used in cataloging this record",
135
  `author` LONGTEXT, -- statement of responsibility from MARC record (100$a in MARC21)
135
  `author` LONGTEXT COMMENT "statement of responsibility from MARC record (100$a in MARC21)",
136
  `title` LONGTEXT, -- title (without the subtitle) from the MARC record (245$a in MARC21)
136
  `title` LONGTEXT COMMENT "title (without the subtitle) from the MARC record (245$a in MARC21)",
137
  `medium` LONGTEXT, -- medium from the MARC record (245$h in MARC21)
137
  `medium` LONGTEXT COMMENT "medium from the MARC record (245$h in MARC21)",
138
  `subtitle` LONGTEXT, -- remainder of the title from the MARC record (245$b in MARC21)
138
  `subtitle` LONGTEXT COMMENT "remainder of the title from the MARC record (245$b in MARC21)",
139
  `part_number` LONGTEXT, -- part number from the MARC record (245$n in MARC21)
139
  `part_number` LONGTEXT COMMENT "part number from the MARC record (245$n in MARC21)",
140
  `part_name` LONGTEXT, -- part name from the MARC record (245$p in MARC21)
140
  `part_name` LONGTEXT COMMENT "part name from the MARC record (245$p in MARC21)",
141
  `unititle` LONGTEXT, -- uniform title (without the subtitle) from the MARC record (240$a in MARC21)
141
  `unititle` LONGTEXT COMMENT "uniform title (without the subtitle) from the MARC record (240$a in MARC21)",
142
  `notes` LONGTEXT, -- values from the general notes field in the MARC record (500$a in MARC21) split by bar (|)
142
  `notes` LONGTEXT COMMENT "values from the general notes field in the MARC record (500$a in MARC21) split by bar (|)",
143
  `serial` tinyint(1) default NULL, -- Boolean indicating whether biblio is for a serial
143
  `serial` tinyint(1) default NULL COMMENT "Boolean indicating whether biblio is for a serial",
144
  `seriestitle` LONGTEXT,
144
  `seriestitle` LONGTEXT,
145
  `copyrightdate` smallint(6) default NULL, -- publication or copyright date from the MARC record
145
  `copyrightdate` smallint(6) default NULL COMMENT "publication or copyright date from the MARC record",
146
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time this record was last touched
146
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time this record was last touched",
147
  `datecreated` DATE NOT NULL, -- the date this record was added to Koha
147
  `datecreated` DATE NOT NULL COMMENT "the date this record was added to Koha",
148
  `abstract` LONGTEXT, -- summary from the MARC record (520$a in MARC21)
148
  `abstract` LONGTEXT COMMENT "summary from the MARC record (520$a in MARC21)",
149
  PRIMARY KEY  (`biblionumber`),
149
  PRIMARY KEY  (`biblionumber`),
150
  KEY `blbnoidx` (`biblionumber`)
150
  KEY `blbnoidx` (`biblionumber`)
151
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
151
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 156-163 CREATE TABLE `biblio` ( -- table that stores bibliographic information Link Here
156
156
157
DROP TABLE IF EXISTS `biblio_framework`;
157
DROP TABLE IF EXISTS `biblio_framework`;
158
CREATE TABLE `biblio_framework` ( -- information about MARC frameworks
158
CREATE TABLE `biblio_framework` ( -- information about MARC frameworks
159
  `frameworkcode` varchar(4) NOT NULL default '', -- the unique code assigned to the framework
159
  `frameworkcode` varchar(4) NOT NULL default '' COMMENT "the unique code assigned to the framework",
160
  `frameworktext` varchar(255) NOT NULL default '', -- the description/name given to the framework
160
  `frameworktext` varchar(255) NOT NULL default '' COMMENT "the description/name given to the framework",
161
  PRIMARY KEY  (`frameworkcode`)
161
  PRIMARY KEY  (`frameworkcode`)
162
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
162
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
163
163
Lines 167-203 CREATE TABLE `biblio_framework` ( -- information about MARC frameworks Link Here
167
167
168
DROP TABLE IF EXISTS `biblioitems`;
168
DROP TABLE IF EXISTS `biblioitems`;
169
CREATE TABLE `biblioitems` ( -- information related to bibliographic records in Koha
169
CREATE TABLE `biblioitems` ( -- information related to bibliographic records in Koha
170
  `biblioitemnumber` int(11) NOT NULL auto_increment, -- primary key, unique identifier assigned by Koha
170
  `biblioitemnumber` int(11) NOT NULL auto_increment COMMENT "primary key, unique identifier assigned by Koha",
171
  `biblionumber` int(11) NOT NULL default 0, -- foreign key linking this table to the biblio table
171
  `biblionumber` int(11) NOT NULL default 0 COMMENT "foreign key linking this table to the biblio table",
172
  `volume` LONGTEXT,
172
  `volume` LONGTEXT,
173
  `number` LONGTEXT,
173
  `number` LONGTEXT,
174
  `itemtype` varchar(10) default NULL, -- biblio level item type (MARC21 942$c)
174
  `itemtype` varchar(10) default NULL COMMENT "biblio level item type (MARC21 942$c)",
175
  `isbn` LONGTEXT, -- ISBN (MARC21 020$a)
175
  `isbn` LONGTEXT COMMENT "ISBN (MARC21 020$a)",
176
  `issn` LONGTEXT, -- ISSN (MARC21 022$a)
176
  `issn` LONGTEXT COMMENT "ISSN (MARC21 022$a)",
177
  `ean` LONGTEXT default NULL,
177
  `ean` LONGTEXT default NULL,
178
  `publicationyear` MEDIUMTEXT,
178
  `publicationyear` MEDIUMTEXT,
179
  `publishercode` varchar(255) default NULL, -- publisher (MARC21 260$b)
179
  `publishercode` varchar(255) default NULL COMMENT "publisher (MARC21 260$b)",
180
  `volumedate` date default NULL,
180
  `volumedate` date default NULL,
181
  `volumedesc` MEDIUMTEXT, -- volume information (MARC21 362$a)
181
  `volumedesc` MEDIUMTEXT COMMENT "volume information (MARC21 362$a)",
182
  `collectiontitle` LONGTEXT default NULL,
182
  `collectiontitle` LONGTEXT default NULL,
183
  `collectionissn` MEDIUMTEXT default NULL,
183
  `collectionissn` MEDIUMTEXT default NULL,
184
  `collectionvolume` LONGTEXT default NULL,
184
  `collectionvolume` LONGTEXT default NULL,
185
  `editionstatement` MEDIUMTEXT default NULL,
185
  `editionstatement` MEDIUMTEXT default NULL,
186
  `editionresponsibility` MEDIUMTEXT default NULL,
186
  `editionresponsibility` MEDIUMTEXT default NULL,
187
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
187
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
188
  `illus` varchar(255) default NULL, -- illustrations (MARC21 300$b)
188
  `illus` varchar(255) default NULL COMMENT "illustrations (MARC21 300$b)",
189
  `pages` varchar(255) default NULL, -- number of pages (MARC21 300$c)
189
  `pages` varchar(255) default NULL COMMENT "number of pages (MARC21 300$c)",
190
  `notes` LONGTEXT,
190
  `notes` LONGTEXT,
191
  `size` varchar(255) default NULL, -- material size (MARC21 300$c)
191
  `size` varchar(255) default NULL COMMENT "material size (MARC21 300$c)",
192
  `place` varchar(255) default NULL, -- publication place (MARC21 260$a)
192
  `place` varchar(255) default NULL COMMENT "publication place (MARC21 260$a)",
193
  `lccn` varchar(25) default NULL, -- library of congress control number (MARC21 010$a)
193
  `lccn` varchar(25) default NULL COMMENT "library of congress control number (MARC21 010$a)",
194
  `url` MEDIUMTEXT default NULL, -- url (MARC21 856$u)
194
  `url` MEDIUMTEXT default NULL COMMENT "url (MARC21 856$u)",
195
  `cn_source` varchar(10) default NULL, -- classification source (MARC21 942$2)
195
  `cn_source` varchar(10) default NULL COMMENT "classification source (MARC21 942$2)",
196
  `cn_class` varchar(30) default NULL,
196
  `cn_class` varchar(30) default NULL,
197
  `cn_item` varchar(10) default NULL,
197
  `cn_item` varchar(10) default NULL,
198
  `cn_suffix` varchar(10) default NULL,
198
  `cn_suffix` varchar(10) default NULL,
199
  `cn_sort` varchar(255) default NULL, -- normalized version of the call number used for sorting
199
  `cn_sort` varchar(255) default NULL COMMENT "normalized version of the call number used for sorting",
200
  `agerestriction` varchar(255) default NULL, -- target audience/age restriction from the bib record (MARC21 521$a)
200
  `agerestriction` varchar(255) default NULL COMMENT "target audience/age restriction from the bib record (MARC21 521$a)",
201
  `totalissues` int(10),
201
  `totalissues` int(10),
202
  PRIMARY KEY  (`biblioitemnumber`),
202
  PRIMARY KEY  (`biblioitemnumber`),
203
  KEY `bibinoidx` (`biblioitemnumber`),
203
  KEY `bibinoidx` (`biblioitemnumber`),
Lines 217-235 CREATE TABLE `biblioitems` ( -- information related to bibliographic records in Link Here
217
217
218
DROP TABLE IF EXISTS `borrower_attribute_types`;
218
DROP TABLE IF EXISTS `borrower_attribute_types`;
219
CREATE TABLE `borrower_attribute_types` ( -- definitions for custom patron fields known as extended patron attributes
219
CREATE TABLE `borrower_attribute_types` ( -- definitions for custom patron fields known as extended patron attributes
220
  `code` varchar(10) NOT NULL, -- unique key used to identify each custom field
220
  `code` varchar(10) NOT NULL COMMENT "unique key used to identify each custom field",
221
  `description` varchar(255) NOT NULL, -- description for each custom field
221
  `description` varchar(255) NOT NULL COMMENT "description for each custom field",
222
  `repeatable` tinyint(1) NOT NULL default 0, -- defines whether one patron/borrower can have multiple values for this custom field  (1 for yes, 0 for no)
222
  `repeatable` tinyint(1) NOT NULL default 0 COMMENT "defines whether one patron/borrower can have multiple values for this custom field  (1 for yes, 0 for no)",
223
  `unique_id` tinyint(1) NOT NULL default 0, -- defines if this value needs to be unique (1 for yes, 0 for no)
223
  `unique_id` tinyint(1) NOT NULL default 0 COMMENT "defines if this value needs to be unique (1 for yes, 0 for no)",
224
  `opac_display` tinyint(1) NOT NULL default 0, -- defines if this field is visible to patrons on their account in the OPAC (1 for yes, 0 for no)
224
  `opac_display` tinyint(1) NOT NULL default 0 COMMENT "defines if this field is visible to patrons on their account in the OPAC (1 for yes, 0 for no)",
225
  `opac_editable` tinyint(1) NOT NULL default 0, -- defines if this field is editable by patrons on their account in the OPAC (1 for yes, 0 for no)
225
  `opac_editable` tinyint(1) NOT NULL default 0 COMMENT "defines if this field is editable by patrons on their account in the OPAC (1 for yes, 0 for no)",
226
  `staff_searchable` tinyint(1) NOT NULL default 0, -- defines if this field is searchable via the patron search in the staff interface (1 for yes, 0 for no)
226
  `staff_searchable` tinyint(1) NOT NULL default 0 COMMENT "defines if this field is searchable via the patron search in the staff interface (1 for yes, 0 for no)",
227
  `authorised_value_category` varchar(32) default NULL, -- foreign key from authorised_values that links this custom field to an authorized value category
227
  `authorised_value_category` varchar(32) default NULL COMMENT "foreign key from authorised_values that links this custom field to an authorized value category",
228
  `display_checkout` tinyint(1) NOT NULL default 0,-- defines if this field displays in checkout screens
228
  `display_checkout` tinyint(1) NOT NULL default 0 COMMENT "defines if this field displays in checkout screens",
229
  `category_code` VARCHAR(10) NULL DEFAULT NULL,-- defines a category for an attribute_type
229
  `category_code` VARCHAR(10) NULL DEFAULT NULL COMMENT "defines a category for an attribute_type",
230
  `class` VARCHAR(255) NOT NULL DEFAULT '',-- defines a class for an attribute_type
230
  `class` VARCHAR(255) NOT NULL DEFAULT '' COMMENT "defines a class for an attribute_type",
231
  `keep_for_pseudonymization` tinyint(1) NOT NULL default 0, -- defines if this field is copied to anonymized_borrower_attributes (1 for yes, 0 for no)
231
  `keep_for_pseudonymization` tinyint(1) NOT NULL default 0 COMMENT "defines if this field is copied to anonymized_borrower_attributes (1 for yes, 0 for no)",
232
  `mandatory` tinyint(1) NOT NULL DEFAULT 0, -- defines if the attribute is mandatory or not
232
  `mandatory` tinyint(1) NOT NULL DEFAULT 0 COMMENT "defines if the attribute is mandatory or not",
233
  PRIMARY KEY  (`code`),
233
  PRIMARY KEY  (`code`),
234
  KEY `auth_val_cat_idx` (`authorised_value_category`)
234
  KEY `auth_val_cat_idx` (`authorised_value_category`)
235
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
235
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 240-248 CREATE TABLE `borrower_attribute_types` ( -- definitions for custom patron field Link Here
240
240
241
DROP TABLE IF EXISTS `borrower_password_recovery`;
241
DROP TABLE IF EXISTS `borrower_password_recovery`;
242
CREATE TABLE IF NOT EXISTS `borrower_password_recovery` ( -- holds information about password recovery attempts
242
CREATE TABLE IF NOT EXISTS `borrower_password_recovery` ( -- holds information about password recovery attempts
243
  `borrowernumber` int(11) NOT NULL, -- the user asking a password recovery
243
  `borrowernumber` int(11) NOT NULL COMMENT "the user asking a password recovery",
244
  `uuid` varchar(128) NOT NULL, -- a unique string to identify a password recovery attempt
244
  `uuid` varchar(128) NOT NULL COMMENT "a unique string to identify a password recovery attempt",
245
  `valid_until` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, -- a time limit on the password recovery attempt
245
  `valid_until` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "a time limit on the password recovery attempt",
246
  PRIMARY KEY (`borrowernumber`),
246
  PRIMARY KEY (`borrowernumber`),
247
  KEY borrowernumber (borrowernumber)
247
  KEY borrowernumber (borrowernumber)
248
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
248
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 253-281 CREATE TABLE IF NOT EXISTS `borrower_password_recovery` ( -- holds information a Link Here
253
253
254
DROP TABLE IF EXISTS `branches`;
254
DROP TABLE IF EXISTS `branches`;
255
CREATE TABLE `branches` ( -- information about your libraries or branches are stored here
255
CREATE TABLE `branches` ( -- information about your libraries or branches are stored here
256
  `branchcode` varchar(10) NOT NULL default '', -- a unique key assigned to each branch
256
  `branchcode` varchar(10) NOT NULL default '' COMMENT "a unique key assigned to each branch",
257
  `branchname` LONGTEXT NOT NULL, -- the name of your library or branch
257
  `branchname` LONGTEXT NOT NULL COMMENT "the name of your library or branch",
258
  `branchaddress1` LONGTEXT, -- the first address line of for your library or branch
258
  `branchaddress1` LONGTEXT COMMENT "the first address line of for your library or branch",
259
  `branchaddress2` LONGTEXT, -- the second address line of for your library or branch
259
  `branchaddress2` LONGTEXT COMMENT "the second address line of for your library or branch",
260
  `branchaddress3` LONGTEXT, -- the third address line of for your library or branch
260
  `branchaddress3` LONGTEXT COMMENT "the third address line of for your library or branch",
261
  `branchzip` varchar(25) default NULL, -- the zip or postal code for your library or branch
261
  `branchzip` varchar(25) default NULL COMMENT "the zip or postal code for your library or branch",
262
  `branchcity` LONGTEXT, -- the city or province for your library or branch
262
  `branchcity` LONGTEXT COMMENT "the city or province for your library or branch",
263
  `branchstate` LONGTEXT, -- the state for your library or branch
263
  `branchstate` LONGTEXT COMMENT "the state for your library or branch",
264
  `branchcountry` MEDIUMTEXT, -- the county for your library or branch
264
  `branchcountry` MEDIUMTEXT COMMENT "the county for your library or branch",
265
  `branchphone` LONGTEXT, -- the primary phone for your library or branch
265
  `branchphone` LONGTEXT COMMENT "the primary phone for your library or branch",
266
  `branchfax` LONGTEXT, -- the fax number for your library or branch
266
  `branchfax` LONGTEXT COMMENT "the fax number for your library or branch",
267
  `branchemail` LONGTEXT, -- the primary email address for your library or branch
267
  `branchemail` LONGTEXT COMMENT "the primary email address for your library or branch",
268
  `branchillemail` LONGTEXT, -- the ILL staff email address for your library or branch
268
  `branchillemail` LONGTEXT COMMENT "the ILL staff email address for your library or branch",
269
  `branchreplyto` LONGTEXT, -- the email to be used as a Reply-To
269
  `branchreplyto` LONGTEXT COMMENT "the email to be used as a Reply-To",
270
  `branchreturnpath` LONGTEXT, -- the email to be used as Return-Path
270
  `branchreturnpath` LONGTEXT COMMENT "the email to be used as Return-Path",
271
  `branchurl` LONGTEXT, -- the URL for your library or branch's website
271
  `branchurl` LONGTEXT COMMENT "the URL for your library or branch's website",
272
  `issuing` tinyint(4) default NULL, -- unused in Koha
272
  `issuing` tinyint(4) default NULL COMMENT "unused in Koha",
273
  `branchip` varchar(15) default NULL, -- the IP address for your library or branch
273
  `branchip` varchar(15) default NULL COMMENT "the IP address for your library or branch",
274
  `branchnotes` LONGTEXT, -- notes related to your library or branch
274
  `branchnotes` LONGTEXT COMMENT "notes related to your library or branch",
275
  opac_info MEDIUMTEXT, -- HTML that displays in OPAC
275
  opac_info MEDIUMTEXT COMMENT "HTML that displays in OPAC",
276
  `geolocation` VARCHAR(255) default NULL, -- geolocation of your library
276
  `geolocation` VARCHAR(255) default NULL COMMENT "geolocation of your library",
277
  `marcorgcode` VARCHAR(16) default NULL, -- MARC Organization Code, see http://www.loc.gov/marc/organizations/orgshome.html, when empty defaults to syspref MARCOrgCode
277
  `marcorgcode` VARCHAR(16) default NULL COMMENT "MARC Organization Code, see http://www.loc.gov/marc/organizations/orgshome.html, when empty defaults to syspref MARCOrgCode",
278
  `pickup_location` tinyint(1) NOT NULL default 1, -- the ability to act as a pickup location
278
  `pickup_location` tinyint(1) NOT NULL default 1 COMMENT "the ability to act as a pickup location",
279
  PRIMARY KEY (`branchcode`)
279
  PRIMARY KEY (`branchcode`)
280
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
280
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
281
281
Lines 309-336 CREATE TABLE `browser` ( Link Here
309
309
310
DROP TABLE IF EXISTS `categories`;
310
DROP TABLE IF EXISTS `categories`;
311
CREATE TABLE `categories` ( -- this table shows information related to Koha patron categories
311
CREATE TABLE `categories` ( -- this table shows information related to Koha patron categories
312
  `categorycode` varchar(10) NOT NULL default '', -- unique primary key used to idenfity the patron category
312
  `categorycode` varchar(10) NOT NULL default '' COMMENT "unique primary key used to idenfity the patron category",
313
  `description` LONGTEXT, -- description of the patron category
313
  `description` LONGTEXT COMMENT "description of the patron category",
314
  `enrolmentperiod` smallint(6) default NULL, -- number of months the patron is enrolled for (will be NULL if enrolmentperioddate is set)
314
  `enrolmentperiod` smallint(6) default NULL COMMENT "number of months the patron is enrolled for (will be NULL if enrolmentperioddate is set)",
315
  `enrolmentperioddate` DATE NULL DEFAULT NULL, -- date the patron is enrolled until (will be NULL if enrolmentperiod is set)
315
  `enrolmentperioddate` DATE NULL DEFAULT NULL COMMENT "date the patron is enrolled until (will be NULL if enrolmentperiod is set)",
316
  `upperagelimit` smallint(6) default NULL, -- age limit for the patron
316
  `upperagelimit` smallint(6) default NULL COMMENT "age limit for the patron",
317
  `dateofbirthrequired` tinyint(1) default NULL, -- the minimum age required for the patron category
317
  `dateofbirthrequired` tinyint(1) default NULL COMMENT "the minimum age required for the patron category",
318
  `finetype` varchar(30) default NULL, -- unused in Koha
318
  `finetype` varchar(30) default NULL COMMENT "unused in Koha",
319
  `bulk` tinyint(1) default NULL,
319
  `bulk` tinyint(1) default NULL,
320
  `enrolmentfee` decimal(28,6) default NULL, -- enrollment fee for the patron
320
  `enrolmentfee` decimal(28,6) default NULL COMMENT "enrollment fee for the patron",
321
  `overduenoticerequired` tinyint(1) default NULL, -- are overdue notices sent to this patron category (1 for yes, 0 for no)
321
  `overduenoticerequired` tinyint(1) default NULL COMMENT "are overdue notices sent to this patron category (1 for yes, 0 for no)",
322
  `issuelimit` smallint(6) default NULL, -- unused in Koha
322
  `issuelimit` smallint(6) default NULL COMMENT "unused in Koha",
323
  `reservefee` decimal(28,6) default NULL, -- cost to place holds
323
  `reservefee` decimal(28,6) default NULL COMMENT "cost to place holds",
324
  `hidelostitems` tinyint(1) NOT NULL default '0', -- are lost items shown to this category (1 for yes, 0 for no)
324
  `hidelostitems` tinyint(1) NOT NULL default '0' COMMENT "are lost items shown to this category (1 for yes, 0 for no)",
325
  `category_type` varchar(1) NOT NULL default 'A', -- type of Koha patron (Adult, Child, Professional, Organizational, Statistical, Staff)
325
  `category_type` varchar(1) NOT NULL default 'A' COMMENT "type of Koha patron (Adult, Child, Professional, Organizational, Statistical, Staff)",
326
  `BlockExpiredPatronOpacActions` tinyint(1) NOT NULL default '-1', -- wheither or not a patron of this category can renew books or place holds once their card has expired. 0 means they can, 1 means they cannot, -1 means use syspref BlockExpiredPatronOpacActions
326
  `BlockExpiredPatronOpacActions` tinyint(1) NOT NULL default '-1' COMMENT "wheither or not a patron of this category can renew books or place holds once their card has expired. 0 means they can, 1 means they cannot, -1 means use syspref BlockExpiredPatronOpacActions",
327
  `default_privacy` ENUM( 'default', 'never', 'forever' ) NOT NULL DEFAULT 'default', -- Default privacy setting for this patron category
327
  `default_privacy` ENUM( 'default', 'never', 'forever' ) NOT NULL DEFAULT 'default' COMMENT "Default privacy setting for this patron category",
328
  `checkprevcheckout` varchar(7) NOT NULL default 'inherit', -- produce a warning for this patron category if this item has previously been checked out to this patron if 'yes', not if 'no', defer to syspref setting if 'inherit'.
328
  `checkprevcheckout` varchar(7) NOT NULL default 'inherit' COMMENT "produce a warning for this patron category if this item has previously been checked out to this patron if 'yes', not if 'no', defer to syspref setting if 'inherit'.",
329
  `reset_password` TINYINT(1) NULL DEFAULT NULL, -- if patrons of this category can do the password reset flow,
329
  `reset_password` TINYINT(1) NULL DEFAULT NULL COMMENT "if patrons of this category can do the password reset flow,",
330
  `change_password` TINYINT(1) NULL DEFAULT NULL, -- if patrons of this category can change their passwords in the OAPC
330
  `change_password` TINYINT(1) NULL DEFAULT NULL COMMENT "if patrons of this category can change their passwords in the OAPC",
331
  `min_password_length` smallint(6) NULL DEFAULT NULL, -- set minimum password length for patrons in this category
331
  `min_password_length` smallint(6) NULL DEFAULT NULL COMMENT "set minimum password length for patrons in this category",
332
  `require_strong_password` TINYINT(1) NULL DEFAULT NULL, -- set required password strength for patrons in this category
332
  `require_strong_password` TINYINT(1) NULL DEFAULT NULL COMMENT "set required password strength for patrons in this category",
333
  `exclude_from_local_holds_priority` tinyint(1) default NULL, -- Exclude patrons of this category from local holds priority
333
  `exclude_from_local_holds_priority` tinyint(1) default NULL COMMENT "Exclude patrons of this category from local holds priority",
334
  PRIMARY KEY  (`categorycode`),
334
  PRIMARY KEY  (`categorycode`),
335
  UNIQUE KEY `categorycode` (`categorycode`)
335
  UNIQUE KEY `categorycode` (`categorycode`)
336
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
336
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 343-349 CREATE TABLE collections ( Link Here
343
  colId integer(11) NOT NULL auto_increment,
343
  colId integer(11) NOT NULL auto_increment,
344
  colTitle varchar(100) NOT NULL DEFAULT '',
344
  colTitle varchar(100) NOT NULL DEFAULT '',
345
  colDesc MEDIUMTEXT NOT NULL,
345
  colDesc MEDIUMTEXT NOT NULL,
346
  colBranchcode varchar(10) DEFAULT NULL, -- 'branchcode for branch where item should be held.'
346
  colBranchcode varchar(10) DEFAULT NULL COMMENT "'branchcode for branch where item should be held.'",
347
  PRIMARY KEY (colId)
347
  PRIMARY KEY (colId)
348
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
348
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
349
349
Lines 371-381 CREATE TABLE collections_tracking ( Link Here
371
371
372
DROP TABLE IF EXISTS `cities`;
372
DROP TABLE IF EXISTS `cities`;
373
CREATE TABLE `cities` ( -- authorized values for cities/states/countries to choose when adding/editing a patron/borrower
373
CREATE TABLE `cities` ( -- authorized values for cities/states/countries to choose when adding/editing a patron/borrower
374
  `cityid` int(11) NOT NULL auto_increment, -- unique identifier added by Koha
374
  `cityid` int(11) NOT NULL auto_increment COMMENT "unique identifier added by Koha",
375
  `city_name` varchar(100) NOT NULL default '', -- name of the city
375
  `city_name` varchar(100) NOT NULL default '' COMMENT "name of the city",
376
  `city_state` VARCHAR( 100 ) NULL DEFAULT NULL, -- name of the state/province
376
  `city_state` VARCHAR( 100 ) NULL DEFAULT NULL COMMENT "name of the state/province",
377
  `city_country` VARCHAR( 100 ) NULL DEFAULT NULL, -- name of the country
377
  `city_country` VARCHAR( 100 ) NULL DEFAULT NULL COMMENT "name of the country",
378
  `city_zipcode` varchar(20) default NULL, -- zip or postal code
378
  `city_zipcode` varchar(20) default NULL COMMENT "zip or postal code",
379
  PRIMARY KEY  (`cityid`)
379
  PRIMARY KEY  (`cityid`)
380
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
380
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
381
381
Lines 385-393 CREATE TABLE `cities` ( -- authorized values for cities/states/countries to choo Link Here
385
385
386
DROP TABLE IF EXISTS desks;
386
DROP TABLE IF EXISTS desks;
387
CREATE TABLE desks ( -- desks available in a library
387
CREATE TABLE desks ( -- desks available in a library
388
  desk_id int(11) NOT NULL auto_increment, -- unique identifier
388
  desk_id int(11) NOT NULL auto_increment COMMENT "unique identifier",
389
  desk_name varchar(100) NOT NULL default '', -- name of the desk
389
  desk_name varchar(100) NOT NULL default '' COMMENT "name of the desk",
390
  branchcode varchar(10) NOT NULL,       -- library the desk is located at
390
  branchcode varchar(10) NOT NULL COMMENT "library the desk is located at",
391
  PRIMARY KEY  (desk_id),
391
  PRIMARY KEY  (desk_id),
392
  KEY `fk_desks_branchcode` (branchcode),
392
  KEY `fk_desks_branchcode` (branchcode),
393
  CONSTRAINT `fk_desks_branchcode` FOREIGN KEY (branchcode) REFERENCES branches (branchcode) ON DELETE CASCADE ON UPDATE CASCADE
393
  CONSTRAINT `fk_desks_branchcode` FOREIGN KEY (branchcode) REFERENCES branches (branchcode) ON DELETE CASCADE ON UPDATE CASCADE
Lines 462-483 CREATE TABLE `currency` ( Link Here
462
462
463
DROP TABLE IF EXISTS `deletedbiblio`;
463
DROP TABLE IF EXISTS `deletedbiblio`;
464
CREATE TABLE `deletedbiblio` ( -- stores information about bibliographic records that have been deleted
464
CREATE TABLE `deletedbiblio` ( -- stores information about bibliographic records that have been deleted
465
  `biblionumber` int(11) NOT NULL auto_increment, -- unique identifier assigned to each bibliographic record
465
  `biblionumber` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned to each bibliographic record",
466
  `frameworkcode` varchar(4) NOT NULL default '', -- foriegn key from the biblio_framework table to identify which framework was used in cataloging this record
466
  `frameworkcode` varchar(4) NOT NULL default '' COMMENT "foriegn key from the biblio_framework table to identify which framework was used in cataloging this record",
467
  `author` LONGTEXT, -- statement of responsibility from MARC record (100$a in MARC21)
467
  `author` LONGTEXT COMMENT "statement of responsibility from MARC record (100$a in MARC21)",
468
  `title` LONGTEXT, -- title (without the subtitle) from the MARC record (245$a in MARC21)
468
  `title` LONGTEXT COMMENT "title (without the subtitle) from the MARC record (245$a in MARC21)",
469
  `medium` LONGTEXT, -- medium from the MARC record (245$h in MARC21)
469
  `medium` LONGTEXT COMMENT "medium from the MARC record (245$h in MARC21)",
470
  `subtitle` LONGTEXT, -- remainder of the title from the MARC record (245$b in MARC21)
470
  `subtitle` LONGTEXT COMMENT "remainder of the title from the MARC record (245$b in MARC21)",
471
  `part_number` LONGTEXT, -- part number from the MARC record (245$n in MARC21)
471
  `part_number` LONGTEXT COMMENT "part number from the MARC record (245$n in MARC21)",
472
  `part_name` LONGTEXT, -- part name from the MARC record (245$p in MARC21)
472
  `part_name` LONGTEXT COMMENT "part name from the MARC record (245$p in MARC21)",
473
  `unititle` LONGTEXT, -- uniform title (without the subtitle) from the MARC record (240$a in MARC21)
473
  `unititle` LONGTEXT COMMENT "uniform title (without the subtitle) from the MARC record (240$a in MARC21)",
474
  `notes` LONGTEXT, -- values from the general notes field in the MARC record (500$a in MARC21) split by bar (|)
474
  `notes` LONGTEXT COMMENT "values from the general notes field in the MARC record (500$a in MARC21) split by bar (|)",
475
  `serial` tinyint(1) default NULL, -- Boolean indicating whether biblio is for a serial
475
  `serial` tinyint(1) default NULL COMMENT "Boolean indicating whether biblio is for a serial",
476
  `seriestitle` LONGTEXT,
476
  `seriestitle` LONGTEXT,
477
  `copyrightdate` smallint(6) default NULL, -- publication or copyright date from the MARC record
477
  `copyrightdate` smallint(6) default NULL COMMENT "publication or copyright date from the MARC record",
478
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time this record was last touched
478
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time this record was last touched",
479
  `datecreated` DATE NOT NULL, -- the date this record was added to Koha
479
  `datecreated` DATE NOT NULL COMMENT "the date this record was added to Koha",
480
  `abstract` LONGTEXT, -- summary from the MARC record (520$a in MARC21)
480
  `abstract` LONGTEXT COMMENT "summary from the MARC record (520$a in MARC21)",
481
  PRIMARY KEY  (`biblionumber`),
481
  PRIMARY KEY  (`biblionumber`),
482
  KEY `blbnoidx` (`biblionumber`)
482
  KEY `blbnoidx` (`biblionumber`)
483
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
483
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 488-524 CREATE TABLE `deletedbiblio` ( -- stores information about bibliographic records Link Here
488
488
489
DROP TABLE IF EXISTS `deletedbiblioitems`;
489
DROP TABLE IF EXISTS `deletedbiblioitems`;
490
CREATE TABLE `deletedbiblioitems` ( -- information about bibliographic records that have been deleted
490
CREATE TABLE `deletedbiblioitems` ( -- information about bibliographic records that have been deleted
491
  `biblioitemnumber` int(11) NOT NULL default 0, -- primary key, unique identifier assigned by Koha
491
  `biblioitemnumber` int(11) NOT NULL default 0 COMMENT "primary key, unique identifier assigned by Koha",
492
  `biblionumber` int(11) NOT NULL default 0, -- foreign key linking this table to the biblio table
492
  `biblionumber` int(11) NOT NULL default 0 COMMENT "foreign key linking this table to the biblio table",
493
  `volume` LONGTEXT,
493
  `volume` LONGTEXT,
494
  `number` LONGTEXT,
494
  `number` LONGTEXT,
495
  `itemtype` varchar(10) default NULL, -- biblio level item type (MARC21 942$c)
495
  `itemtype` varchar(10) default NULL COMMENT "biblio level item type (MARC21 942$c)",
496
  `isbn` LONGTEXT default NULL, -- ISBN (MARC21 020$a)
496
  `isbn` LONGTEXT default NULL COMMENT "ISBN (MARC21 020$a)",
497
  `issn` LONGTEXT default NULL, -- ISSN (MARC21 022$a)
497
  `issn` LONGTEXT default NULL COMMENT "ISSN (MARC21 022$a)",
498
  `ean` LONGTEXT default NULL,
498
  `ean` LONGTEXT default NULL,
499
  `publicationyear` MEDIUMTEXT,
499
  `publicationyear` MEDIUMTEXT,
500
  `publishercode` varchar(255) default NULL, -- publisher (MARC21 260$b)
500
  `publishercode` varchar(255) default NULL COMMENT "publisher (MARC21 260$b)",
501
  `volumedate` date default NULL,
501
  `volumedate` date default NULL,
502
  `volumedesc` MEDIUMTEXT, -- volume information (MARC21 362$a)
502
  `volumedesc` MEDIUMTEXT COMMENT "volume information (MARC21 362$a)",
503
  `collectiontitle` LONGTEXT default NULL,
503
  `collectiontitle` LONGTEXT default NULL,
504
  `collectionissn` MEDIUMTEXT default NULL,
504
  `collectionissn` MEDIUMTEXT default NULL,
505
  `collectionvolume` LONGTEXT default NULL,
505
  `collectionvolume` LONGTEXT default NULL,
506
  `editionstatement` MEDIUMTEXT default NULL,
506
  `editionstatement` MEDIUMTEXT default NULL,
507
  `editionresponsibility` MEDIUMTEXT default NULL,
507
  `editionresponsibility` MEDIUMTEXT default NULL,
508
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
508
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
509
  `illus` varchar(255) default NULL, -- illustrations (MARC21 300$b)
509
  `illus` varchar(255) default NULL COMMENT "illustrations (MARC21 300$b)",
510
  `pages` varchar(255) default NULL, -- number of pages (MARC21 300$c)
510
  `pages` varchar(255) default NULL COMMENT "number of pages (MARC21 300$c)",
511
  `notes` LONGTEXT,
511
  `notes` LONGTEXT,
512
  `size` varchar(255) default NULL, -- material size (MARC21 300$c)
512
  `size` varchar(255) default NULL COMMENT "material size (MARC21 300$c)",
513
  `place` varchar(255) default NULL, -- publication place (MARC21 260$a)
513
  `place` varchar(255) default NULL COMMENT "publication place (MARC21 260$a)",
514
  `lccn` varchar(25) default NULL, -- library of congress control number (MARC21 010$a)
514
  `lccn` varchar(25) default NULL COMMENT "library of congress control number (MARC21 010$a)",
515
  `url` MEDIUMTEXT default NULL, -- url (MARC21 856$u)
515
  `url` MEDIUMTEXT default NULL COMMENT "url (MARC21 856$u)",
516
  `cn_source` varchar(10) default NULL, -- classification source (MARC21 942$2)
516
  `cn_source` varchar(10) default NULL COMMENT "classification source (MARC21 942$2)",
517
  `cn_class` varchar(30) default NULL,
517
  `cn_class` varchar(30) default NULL,
518
  `cn_item` varchar(10) default NULL,
518
  `cn_item` varchar(10) default NULL,
519
  `cn_suffix` varchar(10) default NULL,
519
  `cn_suffix` varchar(10) default NULL,
520
  `cn_sort` varchar(255) default NULL, -- normalized version of the call number used for sorting
520
  `cn_sort` varchar(255) default NULL COMMENT "normalized version of the call number used for sorting",
521
  `agerestriction` varchar(255) default NULL, -- target audience/age restriction from the bib record (MARC21 521$a)
521
  `agerestriction` varchar(255) default NULL COMMENT "target audience/age restriction from the bib record (MARC21 521$a)",
522
  `totalissues` int(10),
522
  `totalissues` int(10),
523
  PRIMARY KEY  (`biblioitemnumber`),
523
  PRIMARY KEY  (`biblioitemnumber`),
524
  KEY `bibinoidx` (`biblioitemnumber`),
524
  KEY `bibinoidx` (`biblioitemnumber`),
Lines 536-617 CREATE TABLE `deletedbiblioitems` ( -- information about bibliographic records t Link Here
536
536
537
DROP TABLE IF EXISTS `deletedborrowers`;
537
DROP TABLE IF EXISTS `deletedborrowers`;
538
CREATE TABLE `deletedborrowers` ( -- stores data related to the patrons/borrowers you have deleted
538
CREATE TABLE `deletedborrowers` ( -- stores data related to the patrons/borrowers you have deleted
539
  `borrowernumber` int(11) NOT NULL default 0, -- primary key, Koha assigned ID number for patrons/borrowers
539
  `borrowernumber` int(11) NOT NULL default 0 COMMENT "primary key, Koha assigned ID number for patrons/borrowers",
540
  `cardnumber` varchar(32) default NULL, -- unique key, library assigned ID number for patrons/borrowers
540
  `cardnumber` varchar(32) default NULL COMMENT "unique key, library assigned ID number for patrons/borrowers",
541
  `surname` LONGTEXT, -- patron/borrower's last name (surname)
541
  `surname` LONGTEXT COMMENT "patron/borrower's last name (surname)",
542
  `firstname` MEDIUMTEXT, -- patron/borrower's first name
542
  `firstname` MEDIUMTEXT COMMENT "patron/borrower's first name",
543
  `title` LONGTEXT, -- patron/borrower's title, for example: Mr. or Mrs.
543
  `title` LONGTEXT COMMENT "patron/borrower's title, for example: Mr. or Mrs.",
544
  `othernames` LONGTEXT, -- any other names associated with the patron/borrower
544
  `othernames` LONGTEXT COMMENT "any other names associated with the patron/borrower",
545
  `initials` MEDIUMTEXT, -- initials for your patron/borrower
545
  `initials` MEDIUMTEXT COMMENT "initials for your patron/borrower",
546
  `streetnumber` TINYTEXT default NULL, -- the house number for your patron/borrower's primary address
546
  `streetnumber` TINYTEXT default NULL COMMENT "the house number for your patron/borrower's primary address",
547
  `streettype` TINYTEXT default NULL, -- the street type (Rd., Blvd, etc) for your patron/borrower's primary address
547
  `streettype` TINYTEXT default NULL COMMENT "the street type (Rd., Blvd, etc) for your patron/borrower's primary address",
548
  `address` LONGTEXT, -- the first address line for your patron/borrower's primary address
548
  `address` LONGTEXT COMMENT "the first address line for your patron/borrower's primary address",
549
  `address2` MEDIUMTEXT, -- the second address line for your patron/borrower's primary address
549
  `address2` MEDIUMTEXT COMMENT "the second address line for your patron/borrower's primary address",
550
  `city` LONGTEXT, -- the city or town for your patron/borrower's primary address
550
  `city` LONGTEXT COMMENT "the city or town for your patron/borrower's primary address",
551
  `state` MEDIUMTEXT default NULL, -- the state or province for your patron/borrower's primary address
551
  `state` MEDIUMTEXT default NULL COMMENT "the state or province for your patron/borrower's primary address",
552
  `zipcode` TINYTEXT default NULL, -- the zip or postal code for your patron/borrower's primary address
552
  `zipcode` TINYTEXT default NULL COMMENT "the zip or postal code for your patron/borrower's primary address",
553
  `country` MEDIUMTEXT, -- the country for your patron/borrower's primary address
553
  `country` MEDIUMTEXT COMMENT "the country for your patron/borrower's primary address",
554
  `email` LONGTEXT, -- the primary email address for your patron/borrower's primary address
554
  `email` LONGTEXT COMMENT "the primary email address for your patron/borrower's primary address",
555
  `phone` MEDIUMTEXT, -- the primary phone number for your patron/borrower's primary address
555
  `phone` MEDIUMTEXT COMMENT "the primary phone number for your patron/borrower's primary address",
556
  `mobile` TINYTEXT default NULL, -- the other phone number for your patron/borrower's primary address
556
  `mobile` TINYTEXT default NULL COMMENT "the other phone number for your patron/borrower's primary address",
557
  `fax` LONGTEXT, -- the fax number for your patron/borrower's primary address
557
  `fax` LONGTEXT COMMENT "the fax number for your patron/borrower's primary address",
558
  `emailpro` MEDIUMTEXT, -- the secondary email addres for your patron/borrower's primary address
558
  `emailpro` MEDIUMTEXT COMMENT "the secondary email addres for your patron/borrower's primary address",
559
  `phonepro` MEDIUMTEXT, -- the secondary phone number for your patron/borrower's primary address
559
  `phonepro` MEDIUMTEXT COMMENT "the secondary phone number for your patron/borrower's primary address",
560
  `B_streetnumber` TINYTEXT default NULL, -- the house number for your patron/borrower's alternate address
560
  `B_streetnumber` TINYTEXT default NULL COMMENT "the house number for your patron/borrower's alternate address",
561
  `B_streettype` TINYTEXT default NULL, -- the street type (Rd., Blvd, etc) for your patron/borrower's alternate address
561
  `B_streettype` TINYTEXT default NULL COMMENT "the street type (Rd., Blvd, etc) for your patron/borrower's alternate address",
562
  `B_address` MEDIUMTEXT default NULL, -- the first address line for your patron/borrower's alternate address
562
  `B_address` MEDIUMTEXT default NULL COMMENT "the first address line for your patron/borrower's alternate address",
563
  `B_address2` MEDIUMTEXT default NULL, -- the second address line for your patron/borrower's alternate address
563
  `B_address2` MEDIUMTEXT default NULL COMMENT "the second address line for your patron/borrower's alternate address",
564
  `B_city` LONGTEXT, -- the city or town for your patron/borrower's alternate address
564
  `B_city` LONGTEXT COMMENT "the city or town for your patron/borrower's alternate address",
565
  `B_state` MEDIUMTEXT default NULL, -- the state for your patron/borrower's alternate address
565
  `B_state` MEDIUMTEXT default NULL COMMENT "the state for your patron/borrower's alternate address",
566
  `B_zipcode` TINYTEXT default NULL, -- the zip or postal code for your patron/borrower's alternate address
566
  `B_zipcode` TINYTEXT default NULL COMMENT "the zip or postal code for your patron/borrower's alternate address",
567
  `B_country` MEDIUMTEXT, -- the country for your patron/borrower's alternate address
567
  `B_country` MEDIUMTEXT COMMENT "the country for your patron/borrower's alternate address",
568
  `B_email` MEDIUMTEXT, -- the patron/borrower's alternate email address
568
  `B_email` MEDIUMTEXT COMMENT "the patron/borrower's alternate email address",
569
  `B_phone` LONGTEXT, -- the patron/borrower's alternate phone number
569
  `B_phone` LONGTEXT COMMENT "the patron/borrower's alternate phone number",
570
  `dateofbirth` date default NULL, -- the patron/borrower's date of birth (YYYY-MM-DD)
570
  `dateofbirth` date default NULL COMMENT "the patron/borrower's date of birth (YYYY-MM-DD)",
571
  `branchcode` varchar(10) NOT NULL default '', -- foreign key from the branches table, includes the code of the patron/borrower's home branch
571
  `branchcode` varchar(10) NOT NULL default '' COMMENT "foreign key from the branches table, includes the code of the patron/borrower's home branch",
572
  `categorycode` varchar(10) NOT NULL default '', -- foreign key from the categories table, includes the code of the patron category
572
  `categorycode` varchar(10) NOT NULL default '' COMMENT "foreign key from the categories table, includes the code of the patron category",
573
  `dateenrolled` date default NULL, -- date the patron was added to Koha (YYYY-MM-DD)
573
  `dateenrolled` date default NULL COMMENT "date the patron was added to Koha (YYYY-MM-DD)",
574
  `dateexpiry` date default NULL, -- date the patron/borrower's card is set to expire (YYYY-MM-DD)
574
  `dateexpiry` date default NULL COMMENT "date the patron/borrower's card is set to expire (YYYY-MM-DD)",
575
  `date_renewed` date default NULL, -- date the patron/borrower's card was last renewed
575
  `date_renewed` date default NULL COMMENT "date the patron/borrower's card was last renewed",
576
  `gonenoaddress` tinyint(1) default NULL, -- set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having an unconfirmed address
576
  `gonenoaddress` tinyint(1) default NULL COMMENT "set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having an unconfirmed address",
577
  `lost` tinyint(1) default NULL, -- set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having lost their card
577
  `lost` tinyint(1) default NULL COMMENT "set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having lost their card",
578
  `debarred` date default NULL, -- until this date the patron can only check-in (no loans, no holds, etc.), is a fine based on days instead of money (YYYY-MM-DD)
578
  `debarred` date default NULL COMMENT "until this date the patron can only check-in (no loans, no holds, etc.), is a fine based on days instead of money (YYYY-MM-DD)",
579
  `debarredcomment` VARCHAR(255) DEFAULT NULL, -- comment on the stop of patron
579
  `debarredcomment` VARCHAR(255) DEFAULT NULL COMMENT "comment on the stop of patron",
580
  `contactname` LONGTEXT, -- used for children and profesionals to include surname or last name of guarantor or organization name
580
  `contactname` LONGTEXT COMMENT "used for children and profesionals to include surname or last name of guarantor or organization name",
581
  `contactfirstname` MEDIUMTEXT, -- used for children to include first name of guarantor
581
  `contactfirstname` MEDIUMTEXT COMMENT "used for children to include first name of guarantor",
582
  `contacttitle` MEDIUMTEXT, -- used for children to include title (Mr., Mrs., etc) of guarantor
582
  `contacttitle` MEDIUMTEXT COMMENT "used for children to include title (Mr., Mrs., etc) of guarantor",
583
  `borrowernotes` LONGTEXT, -- a note on the patron/borrower's account that is only visible in the staff interface
583
  `borrowernotes` LONGTEXT COMMENT "a note on the patron/borrower's account that is only visible in the staff interface",
584
  `relationship` varchar(100) default NULL, -- used for children to include the relationship to their guarantor
584
  `relationship` varchar(100) default NULL COMMENT "used for children to include the relationship to their guarantor",
585
  `sex` varchar(1) default NULL, -- patron/borrower's gender
585
  `sex` varchar(1) default NULL COMMENT "patron/borrower's gender",
586
  `password` varchar(60) default NULL, -- patron/borrower's encrypted password
586
  `password` varchar(60) default NULL COMMENT "patron/borrower's encrypted password",
587
  `flags` int(11) default NULL, -- will include a number associated with the staff member's permissions
587
  `flags` int(11) default NULL COMMENT "will include a number associated with the staff member's permissions",
588
  `userid` varchar(75) default NULL, -- patron/borrower's opac and/or staff interface log in
588
  `userid` varchar(75) default NULL COMMENT "patron/borrower's opac and/or staff interface log in",
589
  `opacnote` LONGTEXT, -- a note on the patron/borrower's account that is visible in the OPAC and staff interface
589
  `opacnote` LONGTEXT COMMENT "a note on the patron/borrower's account that is visible in the OPAC and staff interface",
590
  `contactnote` varchar(255) default NULL, -- a note related to the patron/borrower's alternate address
590
  `contactnote` varchar(255) default NULL COMMENT "a note related to the patron/borrower's alternate address",
591
  `sort1` varchar(80) default NULL, -- a field that can be used for any information unique to the library
591
  `sort1` varchar(80) default NULL COMMENT "a field that can be used for any information unique to the library",
592
  `sort2` varchar(80) default NULL, -- a field that can be used for any information unique to the library
592
  `sort2` varchar(80) default NULL COMMENT "a field that can be used for any information unique to the library",
593
  `altcontactfirstname` MEDIUMTEXT default NULL, -- first name of alternate contact for the patron/borrower
593
  `altcontactfirstname` MEDIUMTEXT default NULL COMMENT "first name of alternate contact for the patron/borrower",
594
  `altcontactsurname` MEDIUMTEXT default NULL, -- surname or last name of the alternate contact for the patron/borrower
594
  `altcontactsurname` MEDIUMTEXT default NULL COMMENT "surname or last name of the alternate contact for the patron/borrower",
595
  `altcontactaddress1` MEDIUMTEXT default NULL, -- the first address line for the alternate contact for the patron/borrower
595
  `altcontactaddress1` MEDIUMTEXT default NULL COMMENT "the first address line for the alternate contact for the patron/borrower",
596
  `altcontactaddress2` MEDIUMTEXT default NULL, -- the second address line for the alternate contact for the patron/borrower
596
  `altcontactaddress2` MEDIUMTEXT default NULL COMMENT "the second address line for the alternate contact for the patron/borrower",
597
  `altcontactaddress3` MEDIUMTEXT default NULL, -- the city for the alternate contact for the patron/borrower
597
  `altcontactaddress3` MEDIUMTEXT default NULL COMMENT "the city for the alternate contact for the patron/borrower",
598
  `altcontactstate` MEDIUMTEXT default NULL, -- the state for the alternate contact for the patron/borrower
598
  `altcontactstate` MEDIUMTEXT default NULL COMMENT "the state for the alternate contact for the patron/borrower",
599
  `altcontactzipcode` MEDIUMTEXT default NULL, -- the zipcode for the alternate contact for the patron/borrower
599
  `altcontactzipcode` MEDIUMTEXT default NULL COMMENT "the zipcode for the alternate contact for the patron/borrower",
600
  `altcontactcountry` MEDIUMTEXT default NULL, -- the country for the alternate contact for the patron/borrower
600
  `altcontactcountry` MEDIUMTEXT default NULL COMMENT "the country for the alternate contact for the patron/borrower",
601
  `altcontactphone` MEDIUMTEXT default NULL, -- the phone number for the alternate contact for the patron/borrower
601
  `altcontactphone` MEDIUMTEXT default NULL COMMENT "the phone number for the alternate contact for the patron/borrower",
602
  `smsalertnumber` varchar(50) default NULL, -- the mobile phone number where the patron/borrower would like to receive notices (if SMS turned on)
602
  `smsalertnumber` varchar(50) default NULL COMMENT "the mobile phone number where the patron/borrower would like to receive notices (if SMS turned on)",
603
  `sms_provider_id` int(11) DEFAULT NULL, -- the provider of the mobile phone number defined in smsalertnumber
603
  `sms_provider_id` int(11) DEFAULT NULL COMMENT "the provider of the mobile phone number defined in smsalertnumber",
604
  `privacy` integer(11) DEFAULT '1' NOT NULL, -- patron/borrower's privacy settings related to their checkout history  KEY `borrowernumber` (`borrowernumber`),
604
  `privacy` integer(11) DEFAULT '1' NOT NULL COMMENT "patron/borrower's privacy settings related to their checkout history  KEY `borrowernumber` (`borrowernumber`),",
605
  `privacy_guarantor_fines` tinyint(1) NOT NULL DEFAULT '0', -- controls if relatives can see this patron's fines
605
  `privacy_guarantor_fines` tinyint(1) NOT NULL DEFAULT '0' COMMENT "controls if relatives can see this patron's fines",
606
  `privacy_guarantor_checkouts` tinyint(1) NOT NULL DEFAULT '0', -- controls if relatives can see this patron's checkouts
606
  `privacy_guarantor_checkouts` tinyint(1) NOT NULL DEFAULT '0' COMMENT "controls if relatives can see this patron's checkouts",
607
  `checkprevcheckout` varchar(7) NOT NULL default 'inherit', -- produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'.
607
  `checkprevcheckout` varchar(7) NOT NULL default 'inherit' COMMENT "produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'.",
608
  `updated_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- time of last change could be useful for synchronization with external systems (among others)
608
  `updated_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "time of last change could be useful for synchronization with external systems (among others)",
609
  `lastseen` datetime default NULL, -- last time a patron has been seen (connected at the OPAC or staff interface)
609
  `lastseen` datetime default NULL COMMENT "last time a patron has been seen (connected at the OPAC or staff interface)",
610
  `lang` varchar(25) NOT NULL default 'default', -- lang to use to send notices to this patron
610
  `lang` varchar(25) NOT NULL default 'default' COMMENT "lang to use to send notices to this patron",
611
  `login_attempts` int(4) NOT NULL default 0, -- number of failed login attemps
611
  `login_attempts` int(4) NOT NULL default 0 COMMENT "number of failed login attemps",
612
  `overdrive_auth_token` MEDIUMTEXT default NULL, -- persist OverDrive auth token
612
  `overdrive_auth_token` MEDIUMTEXT default NULL COMMENT "persist OverDrive auth token",
613
  `anonymized` TINYINT(1) NOT NULL DEFAULT 0, -- flag for data anonymization
613
  `anonymized` TINYINT(1) NOT NULL DEFAULT 0 COMMENT "flag for data anonymization",
614
  `autorenew_checkouts` TINYINT(1) NOT NULL DEFAULT 1, -- flag for allowing auto-renewal
614
  `autorenew_checkouts` TINYINT(1) NOT NULL DEFAULT 1 COMMENT "flag for allowing auto-renewal",
615
  KEY borrowernumber (borrowernumber),
615
  KEY borrowernumber (borrowernumber),
616
  KEY `cardnumber` (`cardnumber`),
616
  KEY `cardnumber` (`cardnumber`),
617
  KEY `sms_provider_id` (`sms_provider_id`)
617
  KEY `sms_provider_id` (`sms_provider_id`)
Lines 623-673 CREATE TABLE `deletedborrowers` ( -- stores data related to the patrons/borrower Link Here
623
623
624
DROP TABLE IF EXISTS `deleteditems`;
624
DROP TABLE IF EXISTS `deleteditems`;
625
CREATE TABLE `deleteditems` (
625
CREATE TABLE `deleteditems` (
626
  `itemnumber` int(11) NOT NULL default 0, -- primary key and unique identifier added by Koha
626
  `itemnumber` int(11) NOT NULL default 0 COMMENT "primary key and unique identifier added by Koha",
627
  `biblionumber` int(11) NOT NULL default 0, -- foreign key from biblio table used to link this item to the right bib record
627
  `biblionumber` int(11) NOT NULL default 0 COMMENT "foreign key from biblio table used to link this item to the right bib record",
628
  `biblioitemnumber` int(11) NOT NULL default 0, -- foreign key from the biblioitems table to link to item to additional information
628
  `biblioitemnumber` int(11) NOT NULL default 0 COMMENT "foreign key from the biblioitems table to link to item to additional information",
629
  `barcode` varchar(20) default NULL, -- item barcode (MARC21 952$p)
629
  `barcode` varchar(20) default NULL COMMENT "item barcode (MARC21 952$p)",
630
  `dateaccessioned` date default NULL, -- date the item was acquired or added to Koha (MARC21 952$d)
630
  `dateaccessioned` date default NULL COMMENT "date the item was acquired or added to Koha (MARC21 952$d)",
631
  `booksellerid` LONGTEXT default NULL, -- where the item was purchased (MARC21 952$e)
631
  `booksellerid` LONGTEXT default NULL COMMENT "where the item was purchased (MARC21 952$e)",
632
  `homebranch` varchar(10) default NULL, -- foreign key from the branches table for the library that owns this item (MARC21 952$a)
632
  `homebranch` varchar(10) default NULL COMMENT "foreign key from the branches table for the library that owns this item (MARC21 952$a)",
633
  `price` decimal(8,2) default NULL, -- purchase price (MARC21 952$g)
633
  `price` decimal(8,2) default NULL COMMENT "purchase price (MARC21 952$g)",
634
  `replacementprice` decimal(8,2) default NULL, -- cost the library charges to replace the item if it has been marked lost (MARC21 952$v)
634
  `replacementprice` decimal(8,2) default NULL COMMENT "cost the library charges to replace the item if it has been marked lost (MARC21 952$v)",
635
  `replacementpricedate` date default NULL, -- the date the price is effective from (MARC21 952$w)
635
  `replacementpricedate` date default NULL COMMENT "the date the price is effective from (MARC21 952$w)",
636
  `datelastborrowed` date default NULL, -- the date the item was last checked out
636
  `datelastborrowed` date default NULL COMMENT "the date the item was last checked out",
637
  `datelastseen` date default NULL, -- the date the item was last see (usually the last time the barcode was scanned or inventory was done)
637
  `datelastseen` date default NULL COMMENT "the date the item was last see (usually the last time the barcode was scanned or inventory was done)",
638
  `stack` tinyint(1) default NULL,
638
  `stack` tinyint(1) default NULL,
639
  `notforloan` tinyint(1) NOT NULL default 0, -- authorized value defining why this item is not for loan (MARC21 952$7)
639
  `notforloan` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining why this item is not for loan (MARC21 952$7)",
640
  `damaged` tinyint(1) NOT NULL default 0, -- authorized value defining this item as damaged (MARC21 952$4)
640
  `damaged` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining this item as damaged (MARC21 952$4)",
641
  `damaged_on` datetime DEFAULT NULL, -- the date and time an item was last marked as damaged, NULL if not damaged
641
  `damaged_on` datetime DEFAULT NULL COMMENT "the date and time an item was last marked as damaged, NULL if not damaged",
642
  `itemlost` tinyint(1) NOT NULL default 0, -- authorized value defining this item as lost (MARC21 952$1)
642
  `itemlost` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining this item as lost (MARC21 952$1)",
643
  `itemlost_on` datetime DEFAULT NULL, -- the date and time an item was last marked as lost, NULL if not lost
643
  `itemlost_on` datetime DEFAULT NULL COMMENT "the date and time an item was last marked as lost, NULL if not lost",
644
  `withdrawn` tinyint(1) NOT NULL default 0, -- authorized value defining this item as withdrawn (MARC21 952$0)
644
  `withdrawn` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining this item as withdrawn (MARC21 952$0)",
645
  `withdrawn_on` datetime DEFAULT NULL, -- the date and time an item was last marked as withdrawn, NULL if not withdrawn
645
  `withdrawn_on` datetime DEFAULT NULL COMMENT "the date and time an item was last marked as withdrawn, NULL if not withdrawn",
646
  `itemcallnumber` varchar(255) default NULL, -- call number for this item (MARC21 952$o)
646
  `itemcallnumber` varchar(255) default NULL COMMENT "call number for this item (MARC21 952$o)",
647
  `coded_location_qualifier` varchar(10) default NULL, -- coded location qualifier(MARC21 952$f)
647
  `coded_location_qualifier` varchar(10) default NULL COMMENT "coded location qualifier(MARC21 952$f)",
648
  `issues` smallint(6) default 0, -- number of times this item has been checked out
648
  `issues` smallint(6) default 0 COMMENT "number of times this item has been checked out",
649
  `renewals` smallint(6) default NULL, -- number of times this item has been renewed
649
  `renewals` smallint(6) default NULL COMMENT "number of times this item has been renewed",
650
  `reserves` smallint(6) default NULL, -- number of times this item has been placed on hold/reserved
650
  `reserves` smallint(6) default NULL COMMENT "number of times this item has been placed on hold/reserved",
651
  `restricted` tinyint(1) default NULL, -- authorized value defining use restrictions for this item (MARC21 952$5)
651
  `restricted` tinyint(1) default NULL COMMENT "authorized value defining use restrictions for this item (MARC21 952$5)",
652
  `itemnotes` LONGTEXT, -- public notes on this item (MARC21 952$z)
652
  `itemnotes` LONGTEXT COMMENT "public notes on this item (MARC21 952$z)",
653
  `itemnotes_nonpublic` LONGTEXT default NULL, -- non-public notes on this item (MARC21 952$x)
653
  `itemnotes_nonpublic` LONGTEXT default NULL COMMENT "non-public notes on this item (MARC21 952$x)",
654
  `holdingbranch` varchar(10) default NULL, -- foreign key from the branches table for the library that is currently in possession item (MARC21 952$b)
654
  `holdingbranch` varchar(10) default NULL COMMENT "foreign key from the branches table for the library that is currently in possession item (MARC21 952$b)",
655
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time this item was last altered
655
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time this item was last altered",
656
  `location` varchar(80) default NULL, -- authorized value for the shelving location for this item (MARC21 952$c)
656
  `location` varchar(80) default NULL COMMENT "authorized value for the shelving location for this item (MARC21 952$c)",
657
  `permanent_location` varchar(80) default NULL, -- linked to the CART and PROC temporary locations feature, stores the permanent shelving location
657
  `permanent_location` varchar(80) default NULL COMMENT "linked to the CART and PROC temporary locations feature, stores the permanent shelving location",
658
  `onloan` date default NULL, -- defines if item is checked out (NULL for not checked out, and due date for checked out)
658
  `onloan` date default NULL COMMENT "defines if item is checked out (NULL for not checked out, and due date for checked out)",
659
  `cn_source` varchar(10) default NULL, -- classification source used on this item (MARC21 952$2)
659
  `cn_source` varchar(10) default NULL COMMENT "classification source used on this item (MARC21 952$2)",
660
  `cn_sort` varchar(255) default NULL, -- normalized form of the call number (MARC21 952$o) used for sorting
660
  `cn_sort` varchar(255) default NULL COMMENT "normalized form of the call number (MARC21 952$o) used for sorting",
661
  `ccode` varchar(80) default NULL, -- authorized value for the collection code associated with this item (MARC21 952$8)
661
  `ccode` varchar(80) default NULL COMMENT "authorized value for the collection code associated with this item (MARC21 952$8)",
662
  `materials` MEDIUMTEXT default NULL, -- materials specified (MARC21 952$3)
662
  `materials` MEDIUMTEXT default NULL COMMENT "materials specified (MARC21 952$3)",
663
  `uri` MEDIUMTEXT default NULL, -- URL for the item (MARC21 952$u)
663
  `uri` MEDIUMTEXT default NULL COMMENT "URL for the item (MARC21 952$u)",
664
  `itype` varchar(10) default NULL, -- foreign key from the itemtypes table defining the type for this item (MARC21 952$y)
664
  `itype` varchar(10) default NULL COMMENT "foreign key from the itemtypes table defining the type for this item (MARC21 952$y)",
665
  `more_subfields_xml` LONGTEXT default NULL, -- additional 952 subfields in XML format
665
  `more_subfields_xml` LONGTEXT default NULL COMMENT "additional 952 subfields in XML format",
666
  `enumchron` MEDIUMTEXT default NULL, -- serial enumeration/chronology for the item (MARC21 952$h)
666
  `enumchron` MEDIUMTEXT default NULL COMMENT "serial enumeration/chronology for the item (MARC21 952$h)",
667
  `copynumber` varchar(32) default NULL, -- copy number (MARC21 952$t)
667
  `copynumber` varchar(32) default NULL COMMENT "copy number (MARC21 952$t)",
668
  `stocknumber` varchar(32) default NULL, -- inventory number (MARC21 952$i)
668
  `stocknumber` varchar(32) default NULL COMMENT "inventory number (MARC21 952$i)",
669
  `new_status` VARCHAR(32) DEFAULT NULL, -- 'new' value, you can put whatever free-text information. This field is intented to be managed by the automatic_item_modification_by_age cronjob.
669
  `new_status` VARCHAR(32) DEFAULT NULL COMMENT "'new' value, you can put whatever free-text information. This field is intented to be managed by the automatic_item_modification_by_age cronjob.",
670
  `exclude_from_local_holds_priority` tinyint(1) default NULL, -- Exclude this item from local holds priority
670
  `exclude_from_local_holds_priority` tinyint(1) default NULL COMMENT "Exclude this item from local holds priority",
671
  PRIMARY KEY  (`itemnumber`),
671
  PRIMARY KEY  (`itemnumber`),
672
  KEY `delitembarcodeidx` (`barcode`),
672
  KEY `delitembarcodeidx` (`barcode`),
673
  KEY `delitemstocknumberidx` (`stocknumber`),
673
  KEY `delitemstocknumberidx` (`stocknumber`),
Lines 707-724 CREATE TABLE `export_format` ( Link Here
707
707
708
DROP TABLE IF EXISTS `import_batch_profiles`;
708
DROP TABLE IF EXISTS `import_batch_profiles`;
709
CREATE TABLE `import_batch_profiles` ( -- profile for batches of marc records to be imported
709
CREATE TABLE `import_batch_profiles` ( -- profile for batches of marc records to be imported
710
  `id` int(11) NOT NULL auto_increment, -- unique identifier and primary key
710
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier and primary key",
711
  `name` varchar(100) NOT NULL, -- name of this profile
711
  `name` varchar(100) NOT NULL COMMENT "name of this profile",
712
  `matcher_id` int(11) default NULL, -- the id of the match rule used (matchpoints.matcher_id)
712
  `matcher_id` int(11) default NULL COMMENT "the id of the match rule used (matchpoints.matcher_id)",
713
  `template_id` int(11) default NULL, -- the id of the marc modification template
713
  `template_id` int(11) default NULL COMMENT "the id of the marc modification template",
714
  `overlay_action` varchar(50) default NULL, -- how to handle duplicate records
714
  `overlay_action` varchar(50) default NULL COMMENT "how to handle duplicate records",
715
  `nomatch_action` varchar(50) default NULL, -- how to handle records where no match is found
715
  `nomatch_action` varchar(50) default NULL COMMENT "how to handle records where no match is found",
716
  `item_action` varchar(50) default NULL, -- what to do with item records
716
  `item_action` varchar(50) default NULL COMMENT "what to do with item records",
717
  `parse_items` tinyint(1) default NULL, -- should items be parsed
717
  `parse_items` tinyint(1) default NULL COMMENT "should items be parsed",
718
  `record_type` varchar(50) default NULL, -- type of record in the batch
718
  `record_type` varchar(50) default NULL COMMENT "type of record in the batch",
719
  `encoding` varchar(50) default NULL, -- file encoding
719
  `encoding` varchar(50) default NULL COMMENT "file encoding",
720
  `format` varchar(50) default NULL, -- marc format
720
  `format` varchar(50) default NULL COMMENT "marc format",
721
  `comments` LONGTEXT, -- any comments added when the file was uploaded
721
  `comments` LONGTEXT COMMENT "any comments added when the file was uploaded",
722
  PRIMARY KEY (`id`),
722
  PRIMARY KEY (`id`),
723
  UNIQUE KEY `u_import_batch_profiles__name` (`name`)
723
  UNIQUE KEY `u_import_batch_profiles__name` (`name`)
724
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
724
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 729-749 CREATE TABLE `import_batch_profiles` ( -- profile for batches of marc records to Link Here
729
729
730
DROP TABLE IF EXISTS `import_batches`;
730
DROP TABLE IF EXISTS `import_batches`;
731
CREATE TABLE `import_batches` ( -- information about batches of marc records that have been imported
731
CREATE TABLE `import_batches` ( -- information about batches of marc records that have been imported
732
  `import_batch_id` int(11) NOT NULL auto_increment, -- unique identifier and primary key
732
  `import_batch_id` int(11) NOT NULL auto_increment COMMENT "unique identifier and primary key",
733
  `matcher_id` int(11) default NULL, -- the id of the match rule used (matchpoints.matcher_id)
733
  `matcher_id` int(11) default NULL COMMENT "the id of the match rule used (matchpoints.matcher_id)",
734
  `template_id` int(11) default NULL,
734
  `template_id` int(11) default NULL,
735
  `branchcode` varchar(10) default NULL,
735
  `branchcode` varchar(10) default NULL,
736
  `num_records` int(11) NOT NULL default 0, -- number of records in the file
736
  `num_records` int(11) NOT NULL default 0 COMMENT "number of records in the file",
737
  `num_items` int(11) NOT NULL default 0, -- number of items in the file
737
  `num_items` int(11) NOT NULL default 0 COMMENT "number of items in the file",
738
  `upload_timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP, -- date and time the file was uploaded
738
  `upload_timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP COMMENT "date and time the file was uploaded",
739
  `overlay_action` enum('replace', 'create_new', 'use_template', 'ignore') NOT NULL default 'create_new', -- how to handle duplicate records
739
  `overlay_action` enum('replace', 'create_new', 'use_template', 'ignore') NOT NULL default 'create_new' COMMENT "how to handle duplicate records",
740
  `nomatch_action` enum('create_new', 'ignore') NOT NULL default 'create_new', -- how to handle records where no match is found
740
  `nomatch_action` enum('create_new', 'ignore') NOT NULL default 'create_new' COMMENT "how to handle records where no match is found",
741
  `item_action` enum('always_add', 'add_only_for_matches', 'add_only_for_new', 'ignore', 'replace') NOT NULL default 'always_add', -- what to do with item records
741
  `item_action` enum('always_add', 'add_only_for_matches', 'add_only_for_new', 'ignore', 'replace') NOT NULL default 'always_add' COMMENT "what to do with item records",
742
  `import_status` enum('staging', 'staged', 'importing', 'imported', 'reverting', 'reverted', 'cleaned') NOT NULL default 'staging', -- the status of the imported file
742
  `import_status` enum('staging', 'staged', 'importing', 'imported', 'reverting', 'reverted', 'cleaned') NOT NULL default 'staging' COMMENT "the status of the imported file",
743
  `batch_type` enum('batch', 'z3950', 'webservice') NOT NULL default 'batch', -- where this batch has come from
743
  `batch_type` enum('batch', 'z3950', 'webservice') NOT NULL default 'batch' COMMENT "where this batch has come from",
744
  `record_type` enum('biblio', 'auth', 'holdings') NOT NULL default 'biblio', -- type of record in the batch
744
  `record_type` enum('biblio', 'auth', 'holdings') NOT NULL default 'biblio' COMMENT "type of record in the batch",
745
  `file_name` varchar(100), -- the name of the file uploaded
745
  `file_name` varchar(100) COMMENT "the name of the file uploaded",
746
  `comments` LONGTEXT, -- any comments added when the file was uploaded
746
  `comments` LONGTEXT COMMENT "any comments added when the file was uploaded",
747
  `profile_id` int(11) default NULL,
747
  `profile_id` int(11) default NULL,
748
  PRIMARY KEY (`import_batch_id`),
748
  PRIMARY KEY (`import_batch_id`),
749
  KEY `branchcode` (`branchcode`),
749
  KEY `branchcode` (`branchcode`),
Lines 784-792 CREATE TABLE `import_records` ( Link Here
784
--
784
--
785
DROP TABLE IF EXISTS `import_record_matches`;
785
DROP TABLE IF EXISTS `import_record_matches`;
786
CREATE TABLE `import_record_matches` ( -- matches found when importing a batch of records
786
CREATE TABLE `import_record_matches` ( -- matches found when importing a batch of records
787
  `import_record_id` int(11) NOT NULL, -- the id given to the imported bib record (import_records.import_record_id)
787
  `import_record_id` int(11) NOT NULL COMMENT "the id given to the imported bib record (import_records.import_record_id)",
788
  `candidate_match_id` int(11) NOT NULL, -- the biblio the imported record matches (biblio.biblionumber)
788
  `candidate_match_id` int(11) NOT NULL COMMENT "the biblio the imported record matches (biblio.biblionumber)",
789
  `score` int(11) NOT NULL default 0, -- the match score
789
  `score` int(11) NOT NULL default 0 COMMENT "the match score",
790
  CONSTRAINT `import_record_matches_ibfk_1` FOREIGN KEY (`import_record_id`)
790
  CONSTRAINT `import_record_matches_ibfk_1` FOREIGN KEY (`import_record_id`)
791
             REFERENCES `import_records` (`import_record_id`) ON DELETE CASCADE ON UPDATE CASCADE,
791
             REFERENCES `import_records` (`import_record_id`) ON DELETE CASCADE ON UPDATE CASCADE,
792
  KEY `record_score` (`import_record_id`, `score`)
792
  KEY `record_score` (`import_record_id`, `score`)
Lines 856-906 CREATE TABLE `import_items` ( Link Here
856
856
857
DROP TABLE IF EXISTS `items`;
857
DROP TABLE IF EXISTS `items`;
858
CREATE TABLE `items` ( -- holdings/item information
858
CREATE TABLE `items` ( -- holdings/item information
859
  `itemnumber` int(11) NOT NULL auto_increment, -- primary key and unique identifier added by Koha
859
  `itemnumber` int(11) NOT NULL auto_increment COMMENT "primary key and unique identifier added by Koha",
860
  `biblionumber` int(11) NOT NULL default 0, -- foreign key from biblio table used to link this item to the right bib record
860
  `biblionumber` int(11) NOT NULL default 0 COMMENT "foreign key from biblio table used to link this item to the right bib record",
861
  `biblioitemnumber` int(11) NOT NULL default 0, -- foreign key from the biblioitems table to link to item to additional information
861
  `biblioitemnumber` int(11) NOT NULL default 0 COMMENT "foreign key from the biblioitems table to link to item to additional information",
862
  `barcode` varchar(20) default NULL, -- item barcode (MARC21 952$p)
862
  `barcode` varchar(20) default NULL COMMENT "item barcode (MARC21 952$p)",
863
  `dateaccessioned` date default NULL, -- date the item was acquired or added to Koha (MARC21 952$d)
863
  `dateaccessioned` date default NULL COMMENT "date the item was acquired or added to Koha (MARC21 952$d)",
864
  `booksellerid` LONGTEXT default NULL, -- where the item was purchased (MARC21 952$e)
864
  `booksellerid` LONGTEXT default NULL COMMENT "where the item was purchased (MARC21 952$e)",
865
  `homebranch` varchar(10) default NULL, -- foreign key from the branches table for the library that owns this item (MARC21 952$a)
865
  `homebranch` varchar(10) default NULL COMMENT "foreign key from the branches table for the library that owns this item (MARC21 952$a)",
866
  `price` decimal(8,2) default NULL, -- purchase price (MARC21 952$g)
866
  `price` decimal(8,2) default NULL COMMENT "purchase price (MARC21 952$g)",
867
  `replacementprice` decimal(8,2) default NULL, -- cost the library charges to replace the item if it has been marked lost (MARC21 952$v)
867
  `replacementprice` decimal(8,2) default NULL COMMENT "cost the library charges to replace the item if it has been marked lost (MARC21 952$v)",
868
  `replacementpricedate` date default NULL, -- the date the price is effective from (MARC21 952$w)
868
  `replacementpricedate` date default NULL COMMENT "the date the price is effective from (MARC21 952$w)",
869
  `datelastborrowed` date default NULL, -- the date the item was last checked out/issued
869
  `datelastborrowed` date default NULL COMMENT "the date the item was last checked out/issued",
870
  `datelastseen` date default NULL, -- the date the item was last see (usually the last time the barcode was scanned or inventory was done)
870
  `datelastseen` date default NULL COMMENT "the date the item was last see (usually the last time the barcode was scanned or inventory was done)",
871
  `stack` tinyint(1) default NULL,
871
  `stack` tinyint(1) default NULL,
872
  `notforloan` tinyint(1) NOT NULL default 0, -- authorized value defining why this item is not for loan (MARC21 952$7)
872
  `notforloan` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining why this item is not for loan (MARC21 952$7)",
873
  `damaged` tinyint(1) NOT NULL default 0, -- authorized value defining this item as damaged (MARC21 952$4)
873
  `damaged` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining this item as damaged (MARC21 952$4)",
874
  `damaged_on` datetime DEFAULT NULL, -- the date and time an item was last marked as damaged, NULL if not damaged
874
  `damaged_on` datetime DEFAULT NULL COMMENT "the date and time an item was last marked as damaged, NULL if not damaged",
875
  `itemlost` tinyint(1) NOT NULL default 0, -- authorized value defining this item as lost (MARC21 952$1)
875
  `itemlost` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining this item as lost (MARC21 952$1)",
876
  `itemlost_on` datetime DEFAULT NULL, -- the date and time an item was last marked as lost, NULL if not lost
876
  `itemlost_on` datetime DEFAULT NULL COMMENT "the date and time an item was last marked as lost, NULL if not lost",
877
  `withdrawn` tinyint(1) NOT NULL default 0, -- authorized value defining this item as withdrawn (MARC21 952$0)
877
  `withdrawn` tinyint(1) NOT NULL default 0 COMMENT "authorized value defining this item as withdrawn (MARC21 952$0)",
878
  `withdrawn_on` datetime DEFAULT NULL, -- the date and time an item was last marked as withdrawn, NULL if not withdrawn
878
  `withdrawn_on` datetime DEFAULT NULL COMMENT "the date and time an item was last marked as withdrawn, NULL if not withdrawn",
879
  `itemcallnumber` varchar(255) default NULL, -- call number for this item (MARC21 952$o)
879
  `itemcallnumber` varchar(255) default NULL COMMENT "call number for this item (MARC21 952$o)",
880
  `coded_location_qualifier` varchar(10) default NULL, -- coded location qualifier(MARC21 952$f)
880
  `coded_location_qualifier` varchar(10) default NULL COMMENT "coded location qualifier(MARC21 952$f)",
881
  `issues` smallint(6) default 0, -- number of times this item has been checked out/issued
881
  `issues` smallint(6) default 0 COMMENT "number of times this item has been checked out/issued",
882
  `renewals` smallint(6) default NULL, -- number of times this item has been renewed
882
  `renewals` smallint(6) default NULL COMMENT "number of times this item has been renewed",
883
  `reserves` smallint(6) default NULL, -- number of times this item has been placed on hold/reserved
883
  `reserves` smallint(6) default NULL COMMENT "number of times this item has been placed on hold/reserved",
884
  `restricted` tinyint(1) default NULL, -- authorized value defining use restrictions for this item (MARC21 952$5)
884
  `restricted` tinyint(1) default NULL COMMENT "authorized value defining use restrictions for this item (MARC21 952$5)",
885
  `itemnotes` LONGTEXT, -- public notes on this item (MARC21 952$z)
885
  `itemnotes` LONGTEXT COMMENT "public notes on this item (MARC21 952$z)",
886
  `itemnotes_nonpublic` LONGTEXT default NULL, -- non-public notes on this item (MARC21 952$x)
886
  `itemnotes_nonpublic` LONGTEXT default NULL COMMENT "non-public notes on this item (MARC21 952$x)",
887
  `holdingbranch` varchar(10) default NULL, -- foreign key from the branches table for the library that is currently in possession item (MARC21 952$b)
887
  `holdingbranch` varchar(10) default NULL COMMENT "foreign key from the branches table for the library that is currently in possession item (MARC21 952$b)",
888
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time this item was last altered
888
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time this item was last altered",
889
  `location` varchar(80) default NULL, -- authorized value for the shelving location for this item (MARC21 952$c)
889
  `location` varchar(80) default NULL COMMENT "authorized value for the shelving location for this item (MARC21 952$c)",
890
  `permanent_location` varchar(80) default NULL, -- linked to the CART and PROC temporary locations feature, stores the permanent shelving location
890
  `permanent_location` varchar(80) default NULL COMMENT "linked to the CART and PROC temporary locations feature, stores the permanent shelving location",
891
  `onloan` date default NULL, -- defines if item is checked out (NULL for not checked out, and due date for checked out)
891
  `onloan` date default NULL COMMENT "defines if item is checked out (NULL for not checked out, and due date for checked out)",
892
  `cn_source` varchar(10) default NULL, -- classification source used on this item (MARC21 952$2)
892
  `cn_source` varchar(10) default NULL COMMENT "classification source used on this item (MARC21 952$2)",
893
  `cn_sort` varchar(255) default NULL,  -- normalized form of the call number (MARC21 952$o) used for sorting
893
  `cn_sort` varchar(255) default NULL COMMENT "normalized form of the call number (MARC21 952$o) used for sorting",
894
  `ccode` varchar(80) default NULL, -- authorized value for the collection code associated with this item (MARC21 952$8)
894
  `ccode` varchar(80) default NULL COMMENT "authorized value for the collection code associated with this item (MARC21 952$8)",
895
  `materials` MEDIUMTEXT default NULL, -- materials specified (MARC21 952$3)
895
  `materials` MEDIUMTEXT default NULL COMMENT "materials specified (MARC21 952$3)",
896
  `uri` MEDIUMTEXT default NULL, -- URL for the item (MARC21 952$u)
896
  `uri` MEDIUMTEXT default NULL COMMENT "URL for the item (MARC21 952$u)",
897
  `itype` varchar(10) default NULL, -- foreign key from the itemtypes table defining the type for this item (MARC21 952$y)
897
  `itype` varchar(10) default NULL COMMENT "foreign key from the itemtypes table defining the type for this item (MARC21 952$y)",
898
  `more_subfields_xml` LONGTEXT default NULL, -- additional 952 subfields in XML format
898
  `more_subfields_xml` LONGTEXT default NULL COMMENT "additional 952 subfields in XML format",
899
  `enumchron` MEDIUMTEXT default NULL, -- serial enumeration/chronology for the item (MARC21 952$h)
899
  `enumchron` MEDIUMTEXT default NULL COMMENT "serial enumeration/chronology for the item (MARC21 952$h)",
900
  `copynumber` varchar(32) default NULL, -- copy number (MARC21 952$t)
900
  `copynumber` varchar(32) default NULL COMMENT "copy number (MARC21 952$t)",
901
  `stocknumber` varchar(32) default NULL, -- inventory number (MARC21 952$i)
901
  `stocknumber` varchar(32) default NULL COMMENT "inventory number (MARC21 952$i)",
902
  `new_status` VARCHAR(32) DEFAULT NULL, -- 'new' value, you can put whatever free-text information. This field is intented to be managed by the automatic_item_modification_by_age cronjob.
902
  `new_status` VARCHAR(32) DEFAULT NULL COMMENT "'new' value, you can put whatever free-text information. This field is intented to be managed by the automatic_item_modification_by_age cronjob.",
903
  `exclude_from_local_holds_priority` tinyint(1) default NULL, -- Exclude this item from local holds priority
903
  `exclude_from_local_holds_priority` tinyint(1) default NULL COMMENT "Exclude this item from local holds priority",
904
  PRIMARY KEY  (`itemnumber`),
904
  PRIMARY KEY  (`itemnumber`),
905
  UNIQUE KEY `itembarcodeidx` (`barcode`),
905
  UNIQUE KEY `itembarcodeidx` (`barcode`),
906
  KEY `itemstocknumberidx` (`stocknumber`),
906
  KEY `itemstocknumberidx` (`stocknumber`),
Lines 925-948 CREATE TABLE `items` ( -- holdings/item information Link Here
925
925
926
DROP TABLE IF EXISTS `itemtypes`;
926
DROP TABLE IF EXISTS `itemtypes`;
927
CREATE TABLE `itemtypes` ( -- defines the item types
927
CREATE TABLE `itemtypes` ( -- defines the item types
928
  itemtype varchar(10) NOT NULL default '', -- unique key, a code associated with the item type
928
  itemtype varchar(10) NOT NULL default '' COMMENT "unique key, a code associated with the item type",
929
  parent_type varchar(10) NULL default NULL, -- unique key, a code associated with the item type
929
  parent_type varchar(10) NULL default NULL COMMENT "unique key, a code associated with the item type",
930
  description LONGTEXT, -- a plain text explanation of the item type
930
  description LONGTEXT COMMENT "a plain text explanation of the item type",
931
  rentalcharge decimal(28,6) default NULL, -- the amount charged when this item is checked out/issued
931
  rentalcharge decimal(28,6) default NULL COMMENT "the amount charged when this item is checked out/issued",
932
  rentalcharge_daily decimal(28,6) default NULL, -- the amount charged for each day between checkout date and due date
932
  rentalcharge_daily decimal(28,6) default NULL COMMENT "the amount charged for each day between checkout date and due date",
933
  rentalcharge_daily_calendar tinyint(1) NOT NULL DEFAULT 1, -- controls if the daily rental fee is calculated directly or using finesCalendar
933
  rentalcharge_daily_calendar tinyint(1) NOT NULL DEFAULT 1 COMMENT "controls if the daily rental fee is calculated directly or using finesCalendar",
934
  rentalcharge_hourly decimal(28,6) default NULL, -- the amount charged for each hour between checkout date and due date
934
  rentalcharge_hourly decimal(28,6) default NULL COMMENT "the amount charged for each hour between checkout date and due date",
935
  rentalcharge_hourly_calendar tinyint(1) NOT NULL DEFAULT 1, -- controls if the hourly rental fee is calculated directly or using finesCalendar
935
  rentalcharge_hourly_calendar tinyint(1) NOT NULL DEFAULT 1 COMMENT "controls if the hourly rental fee is calculated directly or using finesCalendar",
936
  defaultreplacecost decimal(28,6) default NULL, -- default replacement cost
936
  defaultreplacecost decimal(28,6) default NULL COMMENT "default replacement cost",
937
  processfee decimal(28,6) default NULL, -- default text be recorded in the column note when the processing fee is applied
937
  processfee decimal(28,6) default NULL COMMENT "default text be recorded in the column note when the processing fee is applied",
938
  notforloan smallint(6) default NULL, -- 1 if the item is not for loan, 0 if the item is available for loan
938
  notforloan smallint(6) default NULL COMMENT "1 if the item is not for loan, 0 if the item is available for loan",
939
  imageurl varchar(200) default NULL, -- URL for the item type icon
939
  imageurl varchar(200) default NULL COMMENT "URL for the item type icon",
940
  summary MEDIUMTEXT, -- information from the summary field, may include HTML
940
  summary MEDIUMTEXT COMMENT "information from the summary field, may include HTML",
941
  checkinmsg VARCHAR(255), -- message that is displayed when an item with the given item type is checked in
941
  checkinmsg VARCHAR(255) COMMENT "message that is displayed when an item with the given item type is checked in",
942
  checkinmsgtype CHAR(16) DEFAULT 'message' NOT NULL, -- type (CSS class) for the checkinmsg, can be "alert" or "message"
942
  checkinmsgtype CHAR(16) DEFAULT 'message' NOT NULL COMMENT "type (CSS class) for the checkinmsg, can be "alert" or "message"",
943
  sip_media_type VARCHAR(3) DEFAULT NULL, -- SIP2 protocol media type for this itemtype
943
  sip_media_type VARCHAR(3) DEFAULT NULL COMMENT "SIP2 protocol media type for this itemtype",
944
  hideinopac tinyint(1) NOT NULL DEFAULT 0, -- Hide the item type from the search options in OPAC
944
  hideinopac tinyint(1) NOT NULL DEFAULT 0 COMMENT "Hide the item type from the search options in OPAC",
945
  searchcategory varchar(80) default NULL, -- Group this item type with others with the same value on OPAC search options
945
  searchcategory varchar(80) default NULL COMMENT "Group this item type with others with the same value on OPAC search options",
946
  PRIMARY KEY  (`itemtype`),
946
  PRIMARY KEY  (`itemtype`),
947
  CONSTRAINT itemtypes_ibfk_1 FOREIGN KEY (parent_type) REFERENCES itemtypes(itemtype) ON UPDATE CASCADE ON DELETE CASCADE,
947
  CONSTRAINT itemtypes_ibfk_1 FOREIGN KEY (parent_type) REFERENCES itemtypes(itemtype) ON UPDATE CASCADE ON DELETE CASCADE,
948
  UNIQUE KEY `itemtype` (`itemtype`)
948
  UNIQUE KEY `itemtype` (`itemtype`)
Lines 954-968 CREATE TABLE `itemtypes` ( -- defines the item types Link Here
954
954
955
DROP TABLE IF EXISTS `branchtransfers`;
955
DROP TABLE IF EXISTS `branchtransfers`;
956
CREATE TABLE `branchtransfers` ( -- information for items that are in transit between branches
956
CREATE TABLE `branchtransfers` ( -- information for items that are in transit between branches
957
  `branchtransfer_id` int(12) NOT NULL auto_increment, -- primary key
957
  `branchtransfer_id` int(12) NOT NULL auto_increment COMMENT "primary key",
958
  `itemnumber` int(11) NOT NULL default 0, -- the itemnumber that it is in transit (items.itemnumber)
958
  `itemnumber` int(11) NOT NULL default 0 COMMENT "the itemnumber that it is in transit (items.itemnumber)",
959
  `daterequested` timestamp NOT NULL default CURRENT_TIMESTAMP, -- the date the transfer was requested
959
  `daterequested` timestamp NOT NULL default CURRENT_TIMESTAMP COMMENT "the date the transfer was requested",
960
  `datesent` datetime default NULL, -- the date the transfer was initialized
960
  `datesent` datetime default NULL COMMENT "the date the transfer was initialized",
961
  `frombranch` varchar(10) NOT NULL default '', -- the branch the transfer is coming from
961
  `frombranch` varchar(10) NOT NULL default '' COMMENT "the branch the transfer is coming from",
962
  `datearrived` datetime default NULL, -- the date the transfer arrived at its destination
962
  `datearrived` datetime default NULL COMMENT "the date the transfer arrived at its destination",
963
  `tobranch` varchar(10) NOT NULL default '', -- the branch the transfer was going to
963
  `tobranch` varchar(10) NOT NULL default '' COMMENT "the branch the transfer was going to",
964
  `comments` LONGTEXT, -- any comments related to the transfer
964
  `comments` LONGTEXT COMMENT "any comments related to the transfer",
965
  `reason` ENUM('Manual', 'StockrotationAdvance', 'StockrotationRepatriation', 'ReturnToHome', 'ReturnToHolding', 'RotatingCollection', 'Reserve', 'LostReserve', 'CancelReserve'), -- what triggered the transfer
965
  `reason` ENUM('Manual', 'StockrotationAdvance', 'StockrotationRepatriation', 'ReturnToHome', 'ReturnToHolding', 'RotatingCollection', 'Reserve', 'LostReserve', 'CancelReserve') COMMENT "what triggered the transfer",
966
  PRIMARY KEY (`branchtransfer_id`),
966
  PRIMARY KEY (`branchtransfer_id`),
967
  KEY `frombranch` (`frombranch`),
967
  KEY `frombranch` (`frombranch`),
968
  KEY `tobranch` (`tobranch`),
968
  KEY `tobranch` (`tobranch`),
Lines 1193-1203 CREATE TABLE `matchchecks` ( Link Here
1193
1193
1194
DROP TABLE IF EXISTS `need_merge_authorities`;
1194
DROP TABLE IF EXISTS `need_merge_authorities`;
1195
CREATE TABLE `need_merge_authorities` ( -- keeping track of authority records still to be merged by merge_authority cron job
1195
CREATE TABLE `need_merge_authorities` ( -- keeping track of authority records still to be merged by merge_authority cron job
1196
  `id` int NOT NULL auto_increment PRIMARY KEY, -- unique id
1196
  `id` int NOT NULL auto_increment PRIMARY KEY COMMENT "unique id",
1197
  `authid` bigint NOT NULL, -- reference to original authority record
1197
  `authid` bigint NOT NULL COMMENT "reference to original authority record",
1198
  `authid_new` bigint, -- reference to optional new authority record
1198
  `authid_new` bigint COMMENT "reference to optional new authority record",
1199
  `reportxml` MEDIUMTEXT, -- xml showing original reporting tag
1199
  `reportxml` MEDIUMTEXT COMMENT "xml showing original reporting tag",
1200
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- date and time last modified
1200
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "date and time last modified",
1201
  `done` tinyint DEFAULT 0  -- indication whether merge has been executed (0=not done, 1=done, 2=in progress)
1201
  `done` tinyint DEFAULT 0  -- indication whether merge has been executed (0=not done, 1=done, 2=in progress)
1202
-- Note: authid and authid_new should NOT be FOREIGN keys !
1202
-- Note: authid and authid_new should NOT be FOREIGN keys !
1203
-- authid may have been deleted; authid_new may be zero
1203
-- authid may have been deleted; authid_new may be zero
Lines 1260-1277 CREATE TABLE `oai_sets_biblios` ( Link Here
1260
1260
1261
DROP TABLE IF EXISTS `overduerules`;
1261
DROP TABLE IF EXISTS `overduerules`;
1262
CREATE TABLE `overduerules` ( -- overdue notice status and triggers
1262
CREATE TABLE `overduerules` ( -- overdue notice status and triggers
1263
  `overduerules_id` int(11) NOT NULL AUTO_INCREMENT, -- unique identifier for the overduerules
1263
  `overduerules_id` int(11) NOT NULL AUTO_INCREMENT COMMENT "unique identifier for the overduerules",
1264
  `branchcode` varchar(10) NOT NULL default '', -- foreign key from the branches table to define which branch this rule is for (if blank it's all libraries)
1264
  `branchcode` varchar(10) NOT NULL default '' COMMENT "foreign key from the branches table to define which branch this rule is for (if blank it's all libraries)",
1265
  `categorycode` varchar(10) NOT NULL default '', -- foreign key from the categories table to define which patron category this rule is for
1265
  `categorycode` varchar(10) NOT NULL default '' COMMENT "foreign key from the categories table to define which patron category this rule is for",
1266
  `delay1` int(4) default NULL, -- number of days after the item is overdue that the first notice is sent
1266
  `delay1` int(4) default NULL COMMENT "number of days after the item is overdue that the first notice is sent",
1267
  `letter1` varchar(20) default NULL, -- foreign key from the letter table to define which notice should be sent as the first notice
1267
  `letter1` varchar(20) default NULL COMMENT "foreign key from the letter table to define which notice should be sent as the first notice",
1268
  `debarred1` varchar(1) default 0, -- is the patron restricted when the first notice is sent (1 for yes, 0 for no)
1268
  `debarred1` varchar(1) default 0 COMMENT "is the patron restricted when the first notice is sent (1 for yes, 0 for no)",
1269
  `delay2` int(4) default NULL, -- number of days after the item is overdue that the second notice is sent
1269
  `delay2` int(4) default NULL COMMENT "number of days after the item is overdue that the second notice is sent",
1270
  `debarred2` varchar(1) default 0, -- is the patron restricted when the second notice is sent (1 for yes, 0 for no)
1270
  `debarred2` varchar(1) default 0 COMMENT "is the patron restricted when the second notice is sent (1 for yes, 0 for no)",
1271
  `letter2` varchar(20) default NULL, -- foreign key from the letter table to define which notice should be sent as the second notice
1271
  `letter2` varchar(20) default NULL COMMENT "foreign key from the letter table to define which notice should be sent as the second notice",
1272
  `delay3` int(4) default NULL, -- number of days after the item is overdue that the third notice is sent
1272
  `delay3` int(4) default NULL COMMENT "number of days after the item is overdue that the third notice is sent",
1273
  `letter3` varchar(20) default NULL, -- foreign key from the letter table to define which notice should be sent as the third notice
1273
  `letter3` varchar(20) default NULL COMMENT "foreign key from the letter table to define which notice should be sent as the third notice",
1274
  `debarred3` int(1) default 0, -- is the patron restricted when the third notice is sent (1 for yes, 0 for no)
1274
  `debarred3` int(1) default 0 COMMENT "is the patron restricted when the third notice is sent (1 for yes, 0 for no)",
1275
  PRIMARY KEY  (`overduerules_id`),
1275
  PRIMARY KEY  (`overduerules_id`),
1276
  UNIQUE KEY `overduerules_branch_cat` (`branchcode`,`categorycode`)
1276
  UNIQUE KEY `overduerules_branch_cat` (`branchcode`,`categorycode`)
1277
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1277
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 1320-1332 CREATE TABLE `printers_profile` ( Link Here
1320
1320
1321
DROP TABLE IF EXISTS `repeatable_holidays`;
1321
DROP TABLE IF EXISTS `repeatable_holidays`;
1322
CREATE TABLE `repeatable_holidays` ( -- information for the days the library is closed
1322
CREATE TABLE `repeatable_holidays` ( -- information for the days the library is closed
1323
  `id` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
1323
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
1324
  `branchcode` varchar(10) NOT NULL, -- foreign key from the branches table, defines which branch this closing is for
1324
  `branchcode` varchar(10) NOT NULL COMMENT "foreign key from the branches table, defines which branch this closing is for",
1325
  `weekday` smallint(6) default NULL, -- day of the week (0=Sunday, 1=Monday, etc) this closing is repeated on
1325
  `weekday` smallint(6) default NULL COMMENT "day of the week (0=Sunday, 1=Monday, etc) this closing is repeated on",
1326
  `day` smallint(6) default NULL, -- day of the month this closing is on
1326
  `day` smallint(6) default NULL COMMENT "day of the month this closing is on",
1327
  `month` smallint(6) default NULL, -- month this closing is in
1327
  `month` smallint(6) default NULL COMMENT "month this closing is in",
1328
  `title` varchar(50) NOT NULL default '', -- title of this closing
1328
  `title` varchar(50) NOT NULL default '' COMMENT "title of this closing",
1329
  `description` MEDIUMTEXT NOT NULL, -- description for this closing
1329
  `description` MEDIUMTEXT NOT NULL COMMENT "description for this closing",
1330
  PRIMARY KEY  (`id`),
1330
  PRIMARY KEY  (`id`),
1331
  CONSTRAINT `repeatable_holidays_ibfk_1` FOREIGN KEY (`branchcode`) REFERENCES `branches` (`branchcode`) ON DELETE CASCADE ON UPDATE CASCADE
1331
  CONSTRAINT `repeatable_holidays_ibfk_1` FOREIGN KEY (`branchcode`) REFERENCES `branches` (`branchcode`) ON DELETE CASCADE ON UPDATE CASCADE
1332
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1332
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 1337-1349 CREATE TABLE `repeatable_holidays` ( -- information for the days the library is Link Here
1337
1337
1338
DROP TABLE IF EXISTS `reports_dictionary`;
1338
DROP TABLE IF EXISTS `reports_dictionary`;
1339
CREATE TABLE reports_dictionary ( -- definitions (or snippets of SQL) stored for use in reports
1339
CREATE TABLE reports_dictionary ( -- definitions (or snippets of SQL) stored for use in reports
1340
   `id` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
1340
   `id` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
1341
   `name` varchar(255) default NULL, -- name for this definition
1341
   `name` varchar(255) default NULL COMMENT "name for this definition",
1342
   `description` MEDIUMTEXT, -- description for this definition
1342
   `description` MEDIUMTEXT COMMENT "description for this definition",
1343
   `date_created` datetime default NULL, -- date and time this definition was created
1343
   `date_created` datetime default NULL COMMENT "date and time this definition was created",
1344
   `date_modified` datetime default NULL, -- date and time this definition was last modified
1344
   `date_modified` datetime default NULL COMMENT "date and time this definition was last modified",
1345
   `saved_sql` MEDIUMTEXT, -- SQL snippet for us in reports
1345
   `saved_sql` MEDIUMTEXT COMMENT "SQL snippet for us in reports",
1346
   report_area varchar(6) DEFAULT NULL, -- Koha module this definition is for Circulation, Catalog, Patrons, Acquistions, Accounts)
1346
   report_area varchar(6) DEFAULT NULL COMMENT "Koha module this definition is for Circulation, Catalog, Patrons, Acquistions, Accounts)",
1347
   PRIMARY KEY  (id),
1347
   PRIMARY KEY  (id),
1348
   KEY dictionary_area_idx (report_area)
1348
   KEY dictionary_area_idx (report_area)
1349
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1349
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 1354-1368 CREATE TABLE reports_dictionary ( -- definitions (or snippets of SQL) stored for Link Here
1354
1354
1355
DROP TABLE IF EXISTS `saved_sql`;
1355
DROP TABLE IF EXISTS `saved_sql`;
1356
CREATE TABLE saved_sql ( -- saved sql reports
1356
CREATE TABLE saved_sql ( -- saved sql reports
1357
   `id` int(11) NOT NULL auto_increment, -- unique id and primary key assigned by Koha
1357
   `id` int(11) NOT NULL auto_increment COMMENT "unique id and primary key assigned by Koha",
1358
   `borrowernumber` int(11) default NULL, -- the staff member who created this report (borrowers.borrowernumber)
1358
   `borrowernumber` int(11) default NULL COMMENT "the staff member who created this report (borrowers.borrowernumber)",
1359
   `date_created` datetime default NULL, -- the date this report was created
1359
   `date_created` datetime default NULL COMMENT "the date this report was created",
1360
   `last_modified` datetime default NULL, -- the date this report was last edited
1360
   `last_modified` datetime default NULL COMMENT "the date this report was last edited",
1361
   `savedsql` MEDIUMTEXT, -- the SQL for this report
1361
   `savedsql` MEDIUMTEXT COMMENT "the SQL for this report",
1362
   `last_run` datetime default NULL,
1362
   `last_run` datetime default NULL,
1363
   `report_name` varchar(255) NOT NULL default '', -- the name of this report
1363
   `report_name` varchar(255) NOT NULL default '' COMMENT "the name of this report",
1364
   `type` varchar(255) default NULL, -- always 1 for tabular
1364
   `type` varchar(255) default NULL COMMENT "always 1 for tabular",
1365
   `notes` MEDIUMTEXT, -- the notes or description given to this report
1365
   `notes` MEDIUMTEXT COMMENT "the notes or description given to this report",
1366
   `cache_expiry` int NOT NULL default 300,
1366
   `cache_expiry` int NOT NULL default 300,
1367
   `public` tinyint(1) NOT NULL default FALSE,
1367
   `public` tinyint(1) NOT NULL default FALSE,
1368
    report_area varchar(6) default NULL,
1368
    report_area varchar(6) default NULL,
Lines 1413-1426 CREATE TABLE `search_field` ( Link Here
1413
1413
1414
DROP TABLE IF EXISTS `search_history`;
1414
DROP TABLE IF EXISTS `search_history`;
1415
CREATE TABLE IF NOT EXISTS `search_history` ( -- patron's opac search history
1415
CREATE TABLE IF NOT EXISTS `search_history` ( -- patron's opac search history
1416
  `id` int(11) NOT NULL auto_increment, -- search history id
1416
  `id` int(11) NOT NULL auto_increment COMMENT "search history id",
1417
  `userid` int(11) NOT NULL, -- the patron who performed the search (borrowers.borrowernumber)
1417
  `userid` int(11) NOT NULL COMMENT "the patron who performed the search (borrowers.borrowernumber)",
1418
  `sessionid` varchar(32) NOT NULL, -- a system generated session id
1418
  `sessionid` varchar(32) NOT NULL COMMENT "a system generated session id",
1419
  `query_desc` varchar(255) NOT NULL, -- the search that was performed
1419
  `query_desc` varchar(255) NOT NULL COMMENT "the search that was performed",
1420
  `query_cgi` MEDIUMTEXT NOT NULL, -- the string to append to the search url to rerun the search
1420
  `query_cgi` MEDIUMTEXT NOT NULL COMMENT "the string to append to the search url to rerun the search",
1421
  `type` varchar(16) NOT NULL DEFAULT 'biblio', -- search type, must be 'biblio' or 'authority'
1421
  `type` varchar(16) NOT NULL DEFAULT 'biblio' COMMENT "search type, must be 'biblio' or 'authority'",
1422
  `total` int(11) NOT NULL, -- the total of results found
1422
  `total` int(11) NOT NULL COMMENT "the total of results found",
1423
  `time` timestamp NOT NULL default CURRENT_TIMESTAMP, -- the date and time the search was run
1423
  `time` timestamp NOT NULL default CURRENT_TIMESTAMP COMMENT "the date and time the search was run",
1424
  KEY `userid` (`userid`),
1424
  KEY `userid` (`userid`),
1425
  KEY `sessionid` (`sessionid`),
1425
  KEY `sessionid` (`sessionid`),
1426
  PRIMARY KEY (`id`)
1426
  PRIMARY KEY (`id`)
Lines 1488-1569 CREATE TABLE `sms_providers` ( Link Here
1488
1488
1489
DROP TABLE IF EXISTS `borrowers`;
1489
DROP TABLE IF EXISTS `borrowers`;
1490
CREATE TABLE `borrowers` ( -- this table includes information about your patrons/borrowers/members
1490
CREATE TABLE `borrowers` ( -- this table includes information about your patrons/borrowers/members
1491
  `borrowernumber` int(11) NOT NULL auto_increment, -- primary key, Koha assigned ID number for patrons/borrowers
1491
  `borrowernumber` int(11) NOT NULL auto_increment COMMENT "primary key, Koha assigned ID number for patrons/borrowers",
1492
  `cardnumber` varchar(32) default NULL, -- unique key, library assigned ID number for patrons/borrowers
1492
  `cardnumber` varchar(32) default NULL COMMENT "unique key, library assigned ID number for patrons/borrowers",
1493
  `surname` LONGTEXT, -- patron/borrower's last name (surname)
1493
  `surname` LONGTEXT COMMENT "patron/borrower's last name (surname)",
1494
  `firstname` MEDIUMTEXT, -- patron/borrower's first name
1494
  `firstname` MEDIUMTEXT COMMENT "patron/borrower's first name",
1495
  `title` LONGTEXT, -- patron/borrower's title, for example: Mr. or Mrs.
1495
  `title` LONGTEXT COMMENT "patron/borrower's title, for example: Mr. or Mrs.",
1496
  `othernames` LONGTEXT, -- any other names associated with the patron/borrower
1496
  `othernames` LONGTEXT COMMENT "any other names associated with the patron/borrower",
1497
  `initials` MEDIUMTEXT, -- initials for your patron/borrower
1497
  `initials` MEDIUMTEXT COMMENT "initials for your patron/borrower",
1498
  `streetnumber` TINYTEXT default NULL, -- the house number for your patron/borrower's primary address
1498
  `streetnumber` TINYTEXT default NULL COMMENT "the house number for your patron/borrower's primary address",
1499
  `streettype` TINYTEXT default NULL, -- the street type (Rd., Blvd, etc) for your patron/borrower's primary address
1499
  `streettype` TINYTEXT default NULL COMMENT "the street type (Rd., Blvd, etc) for your patron/borrower's primary address",
1500
  `address` LONGTEXT, -- the first address line for your patron/borrower's primary address
1500
  `address` LONGTEXT COMMENT "the first address line for your patron/borrower's primary address",
1501
  `address2` MEDIUMTEXT, -- the second address line for your patron/borrower's primary address
1501
  `address2` MEDIUMTEXT COMMENT "the second address line for your patron/borrower's primary address",
1502
  `city` LONGTEXT, -- the city or town for your patron/borrower's primary address
1502
  `city` LONGTEXT COMMENT "the city or town for your patron/borrower's primary address",
1503
  `state` MEDIUMTEXT default NULL, -- the state or province for your patron/borrower's primary address
1503
  `state` MEDIUMTEXT default NULL COMMENT "the state or province for your patron/borrower's primary address",
1504
  `zipcode` TINYTEXT default NULL, -- the zip or postal code for your patron/borrower's primary address
1504
  `zipcode` TINYTEXT default NULL COMMENT "the zip or postal code for your patron/borrower's primary address",
1505
  `country` MEDIUMTEXT, -- the country for your patron/borrower's primary address
1505
  `country` MEDIUMTEXT COMMENT "the country for your patron/borrower's primary address",
1506
  `email` LONGTEXT, -- the primary email address for your patron/borrower's primary address
1506
  `email` LONGTEXT COMMENT "the primary email address for your patron/borrower's primary address",
1507
  `phone` MEDIUMTEXT, -- the primary phone number for your patron/borrower's primary address
1507
  `phone` MEDIUMTEXT COMMENT "the primary phone number for your patron/borrower's primary address",
1508
  `mobile` TINYTEXT default NULL, -- the other phone number for your patron/borrower's primary address
1508
  `mobile` TINYTEXT default NULL COMMENT "the other phone number for your patron/borrower's primary address",
1509
  `fax` LONGTEXT, -- the fax number for your patron/borrower's primary address
1509
  `fax` LONGTEXT COMMENT "the fax number for your patron/borrower's primary address",
1510
  `emailpro` MEDIUMTEXT, -- the secondary email addres for your patron/borrower's primary address
1510
  `emailpro` MEDIUMTEXT COMMENT "the secondary email addres for your patron/borrower's primary address",
1511
  `phonepro` MEDIUMTEXT, -- the secondary phone number for your patron/borrower's primary address
1511
  `phonepro` MEDIUMTEXT COMMENT "the secondary phone number for your patron/borrower's primary address",
1512
  `B_streetnumber` TINYTEXT default NULL, -- the house number for your patron/borrower's alternate address
1512
  `B_streetnumber` TINYTEXT default NULL COMMENT "the house number for your patron/borrower's alternate address",
1513
  `B_streettype` TINYTEXT default NULL, -- the street type (Rd., Blvd, etc) for your patron/borrower's alternate address
1513
  `B_streettype` TINYTEXT default NULL COMMENT "the street type (Rd., Blvd, etc) for your patron/borrower's alternate address",
1514
  `B_address` MEDIUMTEXT default NULL, -- the first address line for your patron/borrower's alternate address
1514
  `B_address` MEDIUMTEXT default NULL COMMENT "the first address line for your patron/borrower's alternate address",
1515
  `B_address2` MEDIUMTEXT default NULL, -- the second address line for your patron/borrower's alternate address
1515
  `B_address2` MEDIUMTEXT default NULL COMMENT "the second address line for your patron/borrower's alternate address",
1516
  `B_city` LONGTEXT, -- the city or town for your patron/borrower's alternate address
1516
  `B_city` LONGTEXT COMMENT "the city or town for your patron/borrower's alternate address",
1517
  `B_state` MEDIUMTEXT default NULL, -- the state for your patron/borrower's alternate address
1517
  `B_state` MEDIUMTEXT default NULL COMMENT "the state for your patron/borrower's alternate address",
1518
  `B_zipcode` TINYTEXT default NULL, -- the zip or postal code for your patron/borrower's alternate address
1518
  `B_zipcode` TINYTEXT default NULL COMMENT "the zip or postal code for your patron/borrower's alternate address",
1519
  `B_country` MEDIUMTEXT, -- the country for your patron/borrower's alternate address
1519
  `B_country` MEDIUMTEXT COMMENT "the country for your patron/borrower's alternate address",
1520
  `B_email` MEDIUMTEXT, -- the patron/borrower's alternate email address
1520
  `B_email` MEDIUMTEXT COMMENT "the patron/borrower's alternate email address",
1521
  `B_phone` LONGTEXT, -- the patron/borrower's alternate phone number
1521
  `B_phone` LONGTEXT COMMENT "the patron/borrower's alternate phone number",
1522
  `dateofbirth` date default NULL, -- the patron/borrower's date of birth (YYYY-MM-DD)
1522
  `dateofbirth` date default NULL COMMENT "the patron/borrower's date of birth (YYYY-MM-DD)",
1523
  `branchcode` varchar(10) NOT NULL default '', -- foreign key from the branches table, includes the code of the patron/borrower's home branch
1523
  `branchcode` varchar(10) NOT NULL default '' COMMENT "foreign key from the branches table, includes the code of the patron/borrower's home branch",
1524
  `categorycode` varchar(10) NOT NULL default '', -- foreign key from the categories table, includes the code of the patron category
1524
  `categorycode` varchar(10) NOT NULL default '' COMMENT "foreign key from the categories table, includes the code of the patron category",
1525
  `dateenrolled` date default NULL, -- date the patron was added to Koha (YYYY-MM-DD)
1525
  `dateenrolled` date default NULL COMMENT "date the patron was added to Koha (YYYY-MM-DD)",
1526
  `dateexpiry` date default NULL, -- date the patron/borrower's card is set to expire (YYYY-MM-DD)
1526
  `dateexpiry` date default NULL COMMENT "date the patron/borrower's card is set to expire (YYYY-MM-DD)",
1527
  `date_renewed` date default NULL, -- date the patron/borrower's card was last renewed
1527
  `date_renewed` date default NULL COMMENT "date the patron/borrower's card was last renewed",
1528
  `gonenoaddress` tinyint(1) default NULL, -- set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having an unconfirmed address
1528
  `gonenoaddress` tinyint(1) default NULL COMMENT "set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having an unconfirmed address",
1529
  `lost` tinyint(1) default NULL, -- set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having lost their card
1529
  `lost` tinyint(1) default NULL COMMENT "set to 1 for yes and 0 for no, flag to note that library marked this patron/borrower as having lost their card",
1530
  `debarred` date default NULL, -- until this date the patron can only check-in (no loans, no holds, etc.), is a fine based on days instead of money (YYYY-MM-DD)
1530
  `debarred` date default NULL COMMENT "until this date the patron can only check-in (no loans, no holds, etc.), is a fine based on days instead of money (YYYY-MM-DD)",
1531
  `debarredcomment` VARCHAR(255) DEFAULT NULL, -- comment on the stop of the patron
1531
  `debarredcomment` VARCHAR(255) DEFAULT NULL COMMENT "comment on the stop of the patron",
1532
  `contactname` LONGTEXT, -- used for children and profesionals to include surname or last name of guarantor or organization name
1532
  `contactname` LONGTEXT COMMENT "used for children and profesionals to include surname or last name of guarantor or organization name",
1533
  `contactfirstname` MEDIUMTEXT, -- used for children to include first name of guarantor
1533
  `contactfirstname` MEDIUMTEXT COMMENT "used for children to include first name of guarantor",
1534
  `contacttitle` MEDIUMTEXT, -- used for children to include title (Mr., Mrs., etc) of guarantor
1534
  `contacttitle` MEDIUMTEXT COMMENT "used for children to include title (Mr., Mrs., etc) of guarantor",
1535
  `borrowernotes` LONGTEXT, -- a note on the patron/borrower's account that is only visible in the staff interface
1535
  `borrowernotes` LONGTEXT COMMENT "a note on the patron/borrower's account that is only visible in the staff interface",
1536
  `relationship` varchar(100) default NULL, -- used for children to include the relationship to their guarantor
1536
  `relationship` varchar(100) default NULL COMMENT "used for children to include the relationship to their guarantor",
1537
  `sex` varchar(1) default NULL, -- patron/borrower's gender
1537
  `sex` varchar(1) default NULL COMMENT "patron/borrower's gender",
1538
  `password` varchar(60) default NULL, -- patron/borrower's Bcrypt encrypted password
1538
  `password` varchar(60) default NULL COMMENT "patron/borrower's Bcrypt encrypted password",
1539
  `flags` int(11) default NULL, -- will include a number associated with the staff member's permissions
1539
  `flags` int(11) default NULL COMMENT "will include a number associated with the staff member's permissions",
1540
  `userid` varchar(75) default NULL, -- patron/borrower's opac and/or staff interface log in
1540
  `userid` varchar(75) default NULL COMMENT "patron/borrower's opac and/or staff interface log in",
1541
  `opacnote` LONGTEXT, -- a note on the patron/borrower's account that is visible in the OPAC and staff interface
1541
  `opacnote` LONGTEXT COMMENT "a note on the patron/borrower's account that is visible in the OPAC and staff interface",
1542
  `contactnote` varchar(255) default NULL, -- a note related to the patron/borrower's alternate address
1542
  `contactnote` varchar(255) default NULL COMMENT "a note related to the patron/borrower's alternate address",
1543
  `sort1` varchar(80) default NULL, -- a field that can be used for any information unique to the library
1543
  `sort1` varchar(80) default NULL COMMENT "a field that can be used for any information unique to the library",
1544
  `sort2` varchar(80) default NULL, -- a field that can be used for any information unique to the library
1544
  `sort2` varchar(80) default NULL COMMENT "a field that can be used for any information unique to the library",
1545
  `altcontactfirstname` MEDIUMTEXT  default NULL, -- first name of alternate contact for the patron/borrower
1545
  `altcontactfirstname` MEDIUMTEXT  default NULL COMMENT "first name of alternate contact for the patron/borrower",
1546
  `altcontactsurname` MEDIUMTEXT default NULL, -- surname or last name of the alternate contact for the patron/borrower
1546
  `altcontactsurname` MEDIUMTEXT default NULL COMMENT "surname or last name of the alternate contact for the patron/borrower",
1547
  `altcontactaddress1` MEDIUMTEXT default NULL, -- the first address line for the alternate contact for the patron/borrower
1547
  `altcontactaddress1` MEDIUMTEXT default NULL COMMENT "the first address line for the alternate contact for the patron/borrower",
1548
  `altcontactaddress2` MEDIUMTEXT default NULL, -- the second address line for the alternate contact for the patron/borrower
1548
  `altcontactaddress2` MEDIUMTEXT default NULL COMMENT "the second address line for the alternate contact for the patron/borrower",
1549
  `altcontactaddress3` MEDIUMTEXT default NULL, -- the city for the alternate contact for the patron/borrower
1549
  `altcontactaddress3` MEDIUMTEXT default NULL COMMENT "the city for the alternate contact for the patron/borrower",
1550
  `altcontactstate` MEDIUMTEXT default NULL, -- the state for the alternate contact for the patron/borrower
1550
  `altcontactstate` MEDIUMTEXT default NULL COMMENT "the state for the alternate contact for the patron/borrower",
1551
  `altcontactzipcode` MEDIUMTEXT default NULL, -- the zipcode for the alternate contact for the patron/borrower
1551
  `altcontactzipcode` MEDIUMTEXT default NULL COMMENT "the zipcode for the alternate contact for the patron/borrower",
1552
  `altcontactcountry` MEDIUMTEXT default NULL, -- the country for the alternate contact for the patron/borrower
1552
  `altcontactcountry` MEDIUMTEXT default NULL COMMENT "the country for the alternate contact for the patron/borrower",
1553
  `altcontactphone` MEDIUMTEXT default NULL, -- the phone number for the alternate contact for the patron/borrower
1553
  `altcontactphone` MEDIUMTEXT default NULL COMMENT "the phone number for the alternate contact for the patron/borrower",
1554
  `smsalertnumber` varchar(50) default NULL, -- the mobile phone number where the patron/borrower would like to receive notices (if SMS turned on)
1554
  `smsalertnumber` varchar(50) default NULL COMMENT "the mobile phone number where the patron/borrower would like to receive notices (if SMS turned on)",
1555
  `sms_provider_id` int(11) DEFAULT NULL, -- the provider of the mobile phone number defined in smsalertnumber
1555
  `sms_provider_id` int(11) DEFAULT NULL COMMENT "the provider of the mobile phone number defined in smsalertnumber",
1556
  `privacy` integer(11) DEFAULT '1' NOT NULL, -- patron/borrower's privacy settings related to their checkout history
1556
  `privacy` integer(11) DEFAULT '1' NOT NULL COMMENT "patron/borrower's privacy settings related to their checkout history",
1557
  `privacy_guarantor_fines` tinyint(1) NOT NULL DEFAULT '0', -- controls if relatives can see this patron's fines
1557
  `privacy_guarantor_fines` tinyint(1) NOT NULL DEFAULT '0' COMMENT "controls if relatives can see this patron's fines",
1558
  `privacy_guarantor_checkouts` tinyint(1) NOT NULL DEFAULT '0', -- controls if relatives can see this patron's checkouts
1558
  `privacy_guarantor_checkouts` tinyint(1) NOT NULL DEFAULT '0' COMMENT "controls if relatives can see this patron's checkouts",
1559
  `checkprevcheckout` varchar(7) NOT NULL default 'inherit', -- produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'.
1559
  `checkprevcheckout` varchar(7) NOT NULL default 'inherit' COMMENT "produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'.",
1560
  `updated_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- time of last change could be useful for synchronization with external systems (among others)
1560
  `updated_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "time of last change could be useful for synchronization with external systems (among others)",
1561
  `lastseen` datetime default NULL, -- last time a patron has been seen (connected at the OPAC or staff interface)
1561
  `lastseen` datetime default NULL COMMENT "last time a patron has been seen (connected at the OPAC or staff interface)",
1562
  `lang` varchar(25) NOT NULL default 'default', -- lang to use to send notices to this patron
1562
  `lang` varchar(25) NOT NULL default 'default' COMMENT "lang to use to send notices to this patron",
1563
  `login_attempts` int(4) NOT NULL default 0, -- number of failed login attemps
1563
  `login_attempts` int(4) NOT NULL default 0 COMMENT "number of failed login attemps",
1564
  `overdrive_auth_token` MEDIUMTEXT default NULL, -- persist OverDrive auth token
1564
  `overdrive_auth_token` MEDIUMTEXT default NULL COMMENT "persist OverDrive auth token",
1565
  `anonymized` TINYINT(1) NOT NULL DEFAULT 0, -- flag for data anonymization
1565
  `anonymized` TINYINT(1) NOT NULL DEFAULT 0 COMMENT "flag for data anonymization",
1566
  `autorenew_checkouts` TINYINT(1) NOT NULL DEFAULT 1, -- flag for allowing auto-renewal
1566
  `autorenew_checkouts` TINYINT(1) NOT NULL DEFAULT 1 COMMENT "flag for allowing auto-renewal",
1567
  UNIQUE KEY `cardnumber` (`cardnumber`),
1567
  UNIQUE KEY `cardnumber` (`cardnumber`),
1568
  PRIMARY KEY `borrowernumber` (`borrowernumber`),
1568
  PRIMARY KEY `borrowernumber` (`borrowernumber`),
1569
  KEY `categorycode` (`categorycode`),
1569
  KEY `categorycode` (`categorycode`),
Lines 1584-1593 CREATE TABLE `borrowers` ( -- this table includes information about your patrons Link Here
1584
1584
1585
DROP TABLE IF EXISTS `borrower_attributes`;
1585
DROP TABLE IF EXISTS `borrower_attributes`;
1586
CREATE TABLE `borrower_attributes` ( -- values of custom patron fields known as extended patron attributes linked to patrons/borrowers
1586
CREATE TABLE `borrower_attributes` ( -- values of custom patron fields known as extended patron attributes linked to patrons/borrowers
1587
  `id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, -- Row id field
1587
  `id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY COMMENT "Row id field",
1588
  `borrowernumber` int(11) NOT NULL, -- foreign key from the borrowers table, defines which patron/borrower has this attribute
1588
  `borrowernumber` int(11) NOT NULL COMMENT "foreign key from the borrowers table, defines which patron/borrower has this attribute",
1589
  `code` varchar(10) NOT NULL, -- foreign key from the borrower_attribute_types table, defines which custom field this value was entered for
1589
  `code` varchar(10) NOT NULL COMMENT "foreign key from the borrower_attribute_types table, defines which custom field this value was entered for",
1590
  `attribute` varchar(255) default NULL, -- custom patron field value
1590
  `attribute` varchar(255) default NULL COMMENT "custom patron field value",
1591
  KEY `borrowernumber` (`borrowernumber`),
1591
  KEY `borrowernumber` (`borrowernumber`),
1592
  KEY `code_attribute` (`code`, `attribute` (191)),
1592
  KEY `code_attribute` (`code`, `attribute` (191)),
1593
  CONSTRAINT `borrower_attributes_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`)
1593
  CONSTRAINT `borrower_attributes_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`)
Lines 1602-1615 CREATE TABLE `borrower_attributes` ( -- values of custom patron fields known as Link Here
1602
1602
1603
DROP TABLE IF EXISTS `borrower_debarments`;
1603
DROP TABLE IF EXISTS `borrower_debarments`;
1604
CREATE TABLE borrower_debarments ( -- tracks restrictions on the patron's record
1604
CREATE TABLE borrower_debarments ( -- tracks restrictions on the patron's record
1605
  borrower_debarment_id int(11) NOT NULL AUTO_INCREMENT, -- unique key for the restriction
1605
  borrower_debarment_id int(11) NOT NULL AUTO_INCREMENT COMMENT "unique key for the restriction",
1606
  borrowernumber int(11) NOT NULL, -- foreign key for borrowers.borrowernumber for patron who is restricted
1606
  borrowernumber int(11) NOT NULL COMMENT "foreign key for borrowers.borrowernumber for patron who is restricted",
1607
  expiration date DEFAULT NULL, -- expiration date of the restriction
1607
  expiration date DEFAULT NULL COMMENT "expiration date of the restriction",
1608
  `type` enum('SUSPENSION','OVERDUES','MANUAL','DISCHARGE') NOT NULL DEFAULT 'MANUAL', -- type of restriction
1608
  `type` enum('SUSPENSION','OVERDUES','MANUAL','DISCHARGE') NOT NULL DEFAULT 'MANUAL' COMMENT "type of restriction",
1609
  `comment` MEDIUMTEXT, -- comments about the restriction
1609
  `comment` MEDIUMTEXT COMMENT "comments about the restriction",
1610
  manager_id int(11) DEFAULT NULL, -- foreign key for borrowers.borrowernumber for the librarian managing the restriction
1610
  manager_id int(11) DEFAULT NULL COMMENT "foreign key for borrowers.borrowernumber for the librarian managing the restriction",
1611
  created timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- date the restriction was added
1611
  created timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "date the restriction was added",
1612
  updated timestamp NULL DEFAULT NULL, -- date the restriction was updated
1612
  updated timestamp NULL DEFAULT NULL COMMENT "date the restriction was updated",
1613
  PRIMARY KEY (borrower_debarment_id),
1613
  PRIMARY KEY (borrower_debarment_id),
1614
  KEY borrowernumber (borrowernumber),
1614
  KEY borrowernumber (borrowernumber),
1615
  CONSTRAINT `borrower_debarments_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`)
1615
  CONSTRAINT `borrower_debarments_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`)
Lines 1622-1632 CREATE TABLE borrower_debarments ( -- tracks restrictions on the patron's record Link Here
1622
1622
1623
DROP TABLE IF EXISTS `api_keys`;
1623
DROP TABLE IF EXISTS `api_keys`;
1624
CREATE TABLE `api_keys` (
1624
CREATE TABLE `api_keys` (
1625
    `client_id`   VARCHAR(191) NOT NULL,           -- API client ID
1625
    `client_id`   VARCHAR(191) NOT NULL COMMENT "API client ID",
1626
    `secret`      VARCHAR(191) NOT NULL,           -- API client secret used for API authentication
1626
    `secret`      VARCHAR(191) NOT NULL COMMENT "API client secret used for API authentication",
1627
    `description` VARCHAR(255) NOT NULL,           -- API client description
1627
    `description` VARCHAR(255) NOT NULL COMMENT "API client description",
1628
    `patron_id`   INT(11) NOT NULL,                -- Foreign key to the borrowers table
1628
    `patron_id`   INT(11) NOT NULL COMMENT "Foreign key to the borrowers table",
1629
    `active`      TINYINT(1) DEFAULT 1 NOT NULL,   -- 0 means this API key is revoked
1629
    `active`      TINYINT(1) DEFAULT 1 NOT NULL COMMENT "0 means this API key is revoked",
1630
    PRIMARY KEY `client_id` (`client_id`),
1630
    PRIMARY KEY `client_id` (`client_id`),
1631
    UNIQUE KEY `secret` (`secret`),
1631
    UNIQUE KEY `secret` (`secret`),
1632
    KEY `patron_id` (`patron_id`),
1632
    KEY `patron_id` (`patron_id`),
Lines 1642-1665 CREATE TABLE `api_keys` ( Link Here
1642
1642
1643
DROP TABLE IF EXISTS `issues`;
1643
DROP TABLE IF EXISTS `issues`;
1644
CREATE TABLE `issues` ( -- information related to check outs or issues
1644
CREATE TABLE `issues` ( -- information related to check outs or issues
1645
  `issue_id` int(11) NOT NULL AUTO_INCREMENT, -- primary key for issues table
1645
  `issue_id` int(11) NOT NULL AUTO_INCREMENT COMMENT "primary key for issues table",
1646
  `borrowernumber` int(11), -- foreign key, linking this to the borrowers table for the patron this item was checked out to
1646
  `borrowernumber` int(11) COMMENT "foreign key, linking this to the borrowers table for the patron this item was checked out to",
1647
  `issuer_id` INT(11) NULL DEFAULT NULL, -- foreign key, linking this to the borrowers table for the user who checked out this item
1647
  `issuer_id` INT(11) NULL DEFAULT NULL COMMENT "foreign key, linking this to the borrowers table for the user who checked out this item",
1648
  `itemnumber` int(11), -- foreign key, linking this to the items table for the item that was checked out
1648
  `itemnumber` int(11) COMMENT "foreign key, linking this to the items table for the item that was checked out",
1649
  `date_due` datetime default NULL, -- datetime the item is due (yyyy-mm-dd hh:mm::ss)
1649
  `date_due` datetime default NULL COMMENT "datetime the item is due (yyyy-mm-dd hh:mm::ss)",
1650
  `branchcode` varchar(10) default NULL, -- foreign key, linking to the branches table for the location the item was checked out
1650
  `branchcode` varchar(10) default NULL COMMENT "foreign key, linking to the branches table for the location the item was checked out",
1651
  `returndate` datetime default NULL, -- date the item was returned, will be NULL until moved to old_issues
1651
  `returndate` datetime default NULL COMMENT "date the item was returned, will be NULL until moved to old_issues",
1652
  `lastreneweddate` datetime default NULL, -- date the item was last renewed
1652
  `lastreneweddate` datetime default NULL COMMENT "date the item was last renewed",
1653
  `renewals` tinyint(4) NOT NULL default 0, -- lists the number of times the item was renewed
1653
  `renewals` tinyint(4) NOT NULL default 0 COMMENT "lists the number of times the item was renewed",
1654
  `unseen_renewals` tinyint(4) NOT NULL default 0, -- lists the number of consecutive times the item was renewed without being seen
1654
  `unseen_renewals` tinyint(4) NOT NULL default 0 COMMENT "lists the number of consecutive times the item was renewed without being seen",
1655
  `auto_renew` tinyint(1) default FALSE, -- automatic renewal
1655
  `auto_renew` tinyint(1) default FALSE COMMENT "automatic renewal",
1656
  `auto_renew_error` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL, -- automatic renewal error
1656
  `auto_renew_error` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT "automatic renewal error",
1657
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this record was last touched
1657
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "the date and time this record was last touched",
1658
  `issuedate` datetime default NULL, -- date the item was checked out or issued
1658
  `issuedate` datetime default NULL COMMENT "date the item was checked out or issued",
1659
  `onsite_checkout` int(1) NOT NULL default 0, -- in house use flag
1659
  `onsite_checkout` int(1) NOT NULL default 0 COMMENT "in house use flag",
1660
  `note` LONGTEXT default NULL, -- issue note text
1660
  `note` LONGTEXT default NULL COMMENT "issue note text",
1661
  `notedate` datetime default NULL, -- datetime of issue note (yyyy-mm-dd hh:mm::ss)
1661
  `notedate` datetime default NULL COMMENT "datetime of issue note (yyyy-mm-dd hh:mm::ss)",
1662
  `noteseen` int(1) default NULL, -- describes whether checkout note has been seen 1, not been seen 0 or doesn't exist null
1662
  `noteseen` int(1) default NULL COMMENT "describes whether checkout note has been seen 1, not been seen 0 or doesn't exist null",
1663
  PRIMARY KEY (`issue_id`),
1663
  PRIMARY KEY (`issue_id`),
1664
  UNIQUE KEY `itemnumber` (`itemnumber`),
1664
  UNIQUE KEY `itemnumber` (`itemnumber`),
1665
  KEY `issuesborridx` (`borrowernumber`),
1665
  KEY `issuesborridx` (`borrowernumber`),
Lines 1677-1700 CREATE TABLE `issues` ( -- information related to check outs or issues Link Here
1677
1677
1678
DROP TABLE IF EXISTS `old_issues`;
1678
DROP TABLE IF EXISTS `old_issues`;
1679
CREATE TABLE `old_issues` ( -- lists items that were checked out and have been returned
1679
CREATE TABLE `old_issues` ( -- lists items that were checked out and have been returned
1680
  `issue_id` int(11) NOT NULL, -- primary key for issues table
1680
  `issue_id` int(11) NOT NULL COMMENT "primary key for issues table",
1681
  `borrowernumber` int(11) default NULL, -- foreign key, linking this to the borrowers table for the patron this item was checked out to
1681
  `borrowernumber` int(11) default NULL COMMENT "foreign key, linking this to the borrowers table for the patron this item was checked out to",
1682
  `issuer_id` INT(11) NULL DEFAULT NULL, -- foreign key, linking this to the borrowers table for the user who checked out this item
1682
  `issuer_id` INT(11) NULL DEFAULT NULL COMMENT "foreign key, linking this to the borrowers table for the user who checked out this item",
1683
  `itemnumber` int(11) default NULL, -- foreign key, linking this to the items table for the item that was checked out
1683
  `itemnumber` int(11) default NULL COMMENT "foreign key, linking this to the items table for the item that was checked out",
1684
  `date_due` datetime default NULL, -- date the item is due (yyyy-mm-dd)
1684
  `date_due` datetime default NULL COMMENT "date the item is due (yyyy-mm-dd)",
1685
  `branchcode` varchar(10) default NULL, -- foreign key, linking to the branches table for the location the item was checked out
1685
  `branchcode` varchar(10) default NULL COMMENT "foreign key, linking to the branches table for the location the item was checked out",
1686
  `returndate` datetime default NULL, -- date the item was returned
1686
  `returndate` datetime default NULL COMMENT "date the item was returned",
1687
  `lastreneweddate` datetime default NULL, -- date the item was last renewed
1687
  `lastreneweddate` datetime default NULL COMMENT "date the item was last renewed",
1688
  `renewals` tinyint(4) NOT NULL default 0, -- lists the number of times the item was renewed
1688
  `renewals` tinyint(4) NOT NULL default 0 COMMENT "lists the number of times the item was renewed",
1689
  `unseen_renewals` tinyint(4) NOT NULL default 0, -- lists the number of consecutive times the item was renewed without being seen
1689
  `unseen_renewals` tinyint(4) NOT NULL default 0 COMMENT "lists the number of consecutive times the item was renewed without being seen",
1690
  `auto_renew` tinyint(1) default FALSE, -- automatic renewal
1690
  `auto_renew` tinyint(1) default FALSE COMMENT "automatic renewal",
1691
  `auto_renew_error` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL, -- automatic renewal error
1691
  `auto_renew_error` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT "automatic renewal error",
1692
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this record was last touched
1692
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "the date and time this record was last touched",
1693
  `issuedate` datetime default NULL, -- date the item was checked out or issued
1693
  `issuedate` datetime default NULL COMMENT "date the item was checked out or issued",
1694
  `onsite_checkout` int(1) NOT NULL default 0, -- in house use flag
1694
  `onsite_checkout` int(1) NOT NULL default 0 COMMENT "in house use flag",
1695
  `note` LONGTEXT default NULL, -- issue note text
1695
  `note` LONGTEXT default NULL COMMENT "issue note text",
1696
  `notedate` datetime default NULL, -- datetime of issue note (yyyy-mm-dd hh:mm::ss)
1696
  `notedate` datetime default NULL COMMENT "datetime of issue note (yyyy-mm-dd hh:mm::ss)",
1697
  `noteseen` int(1) default NULL, -- describes whether checkout note has been seen 1, not been seen 0 or doesn't exist null
1697
  `noteseen` int(1) default NULL COMMENT "describes whether checkout note has been seen 1, not been seen 0 or doesn't exist null",
1698
  PRIMARY KEY (`issue_id`),
1698
  PRIMARY KEY (`issue_id`),
1699
  KEY `old_issuesborridx` (`borrowernumber`),
1699
  KEY `old_issuesborridx` (`borrowernumber`),
1700
  KEY `old_issuesitemidx` (`itemnumber`),
1700
  KEY `old_issuesitemidx` (`itemnumber`),
Lines 1755-1770 CREATE TABLE `creator_batches` ( Link Here
1755
1755
1756
DROP TABLE IF EXISTS `opac_news`;
1756
DROP TABLE IF EXISTS `opac_news`;
1757
CREATE TABLE `opac_news` ( -- data from the news tool
1757
CREATE TABLE `opac_news` ( -- data from the news tool
1758
  `idnew` int(10) unsigned NOT NULL auto_increment, -- unique identifier for the news article
1758
  `idnew` int(10) unsigned NOT NULL auto_increment COMMENT "unique identifier for the news article",
1759
  `branchcode` varchar(10) default NULL, -- branch code users to create branch specific news, NULL is every branch.
1759
  `branchcode` varchar(10) default NULL COMMENT "branch code users to create branch specific news, NULL is every branch.",
1760
  `title` varchar(250) NOT NULL default '', -- title of the news article
1760
  `title` varchar(250) NOT NULL default '' COMMENT "title of the news article",
1761
  `content` MEDIUMTEXT NOT NULL, -- the body of your news article
1761
  `content` MEDIUMTEXT NOT NULL COMMENT "the body of your news article",
1762
  `lang` varchar(50) NOT NULL default '', -- location for the article (koha is the staff interface, slip is the circulation receipt and language codes are for the opac)
1762
  `lang` varchar(50) NOT NULL default '' COMMENT "location for the article (koha is the staff interface, slip is the circulation receipt and language codes are for the opac)",
1763
  `published_on` date DEFAULT NULL, -- publication date
1763
  `published_on` date DEFAULT NULL COMMENT "publication date",
1764
  `updated_on` timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- last modification
1764
  `updated_on` timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "last modification",
1765
  `expirationdate` date default NULL, -- date the article is set to expire or no longer be visible
1765
  `expirationdate` date default NULL COMMENT "date the article is set to expire or no longer be visible",
1766
  `number` int(11) default NULL, -- the order in which this article appears in that specific location
1766
  `number` int(11) default NULL COMMENT "the order in which this article appears in that specific location",
1767
  `borrowernumber` int(11) default NULL, -- The user who created the news article
1767
  `borrowernumber` int(11) default NULL COMMENT "The user who created the news article",
1768
  PRIMARY KEY  (`idnew`),
1768
  PRIMARY KEY  (`idnew`),
1769
  CONSTRAINT `borrowernumber_fk` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE CASCADE,
1769
  CONSTRAINT `borrowernumber_fk` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE CASCADE,
1770
  CONSTRAINT opac_news_branchcode_ibfk FOREIGN KEY (branchcode) REFERENCES branches (branchcode)
1770
  CONSTRAINT opac_news_branchcode_ibfk FOREIGN KEY (branchcode) REFERENCES branches (branchcode)
Lines 1777-1785 CREATE TABLE `opac_news` ( -- data from the news tool Link Here
1777
1777
1778
DROP TABLE IF EXISTS `patronimage`;
1778
DROP TABLE IF EXISTS `patronimage`;
1779
CREATE TABLE `patronimage` ( -- information related to patron images
1779
CREATE TABLE `patronimage` ( -- information related to patron images
1780
  `borrowernumber` int(11) NOT NULL, -- the borrowernumber of the patron this image is attached to (borrowers.borrowernumber)
1780
  `borrowernumber` int(11) NOT NULL COMMENT "the borrowernumber of the patron this image is attached to (borrowers.borrowernumber)",
1781
  `mimetype` varchar(15) NOT NULL, -- the format of the image (png, jpg, etc)
1781
  `mimetype` varchar(15) NOT NULL COMMENT "the format of the image (png, jpg, etc)",
1782
  `imagefile` mediumblob NOT NULL, -- the image
1782
  `imagefile` mediumblob NOT NULL COMMENT "the image",
1783
  PRIMARY KEY  (`borrowernumber`),
1783
  PRIMARY KEY  (`borrowernumber`),
1784
  CONSTRAINT `patronimage_fk1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE
1784
  CONSTRAINT `patronimage_fk1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE
1785
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1785
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 1790-1818 CREATE TABLE `patronimage` ( -- information related to patron images Link Here
1790
1790
1791
DROP TABLE IF EXISTS `reserves`;
1791
DROP TABLE IF EXISTS `reserves`;
1792
CREATE TABLE `reserves` ( -- information related to holds/reserves in Koha
1792
CREATE TABLE `reserves` ( -- information related to holds/reserves in Koha
1793
  `reserve_id` int(11) NOT NULL auto_increment, -- primary key
1793
  `reserve_id` int(11) NOT NULL auto_increment COMMENT "primary key",
1794
  `borrowernumber` int(11) NOT NULL default 0, -- foreign key from the borrowers table defining which patron this hold is for
1794
  `borrowernumber` int(11) NOT NULL default 0 COMMENT "foreign key from the borrowers table defining which patron this hold is for",
1795
  `reservedate` date default NULL, -- the date the hold was placed
1795
  `reservedate` date default NULL COMMENT "the date the hold was placed",
1796
  `biblionumber` int(11) NOT NULL default 0, -- foreign key from the biblio table defining which bib record this hold is on
1796
  `biblionumber` int(11) NOT NULL default 0 COMMENT "foreign key from the biblio table defining which bib record this hold is on",
1797
  `branchcode` varchar(10) default NULL, -- foreign key from the branches table defining which branch the patron wishes to pick this hold up at
1797
  `branchcode` varchar(10) default NULL COMMENT "foreign key from the branches table defining which branch the patron wishes to pick this hold up at",
1798
  `desk_id` int(11) default NULL, -- foreign key from the desks table defining which desk the patron should pick this hold up at
1798
  `desk_id` int(11) default NULL COMMENT "foreign key from the desks table defining which desk the patron should pick this hold up at",
1799
  `notificationdate` date default NULL, -- currently unused
1799
  `notificationdate` date default NULL COMMENT "currently unused",
1800
  `reminderdate` date default NULL, -- currently unused
1800
  `reminderdate` date default NULL COMMENT "currently unused",
1801
  `cancellationdate` date default NULL, -- the date this hold was cancelled
1801
  `cancellationdate` date default NULL COMMENT "the date this hold was cancelled",
1802
  `cancellation_reason` varchar(80) default NULL, -- optional authorised value CANCELLATION_REASON
1802
  `cancellation_reason` varchar(80) default NULL COMMENT "optional authorised value CANCELLATION_REASON",
1803
  `reservenotes` LONGTEXT, -- notes related to this hold
1803
  `reservenotes` LONGTEXT COMMENT "notes related to this hold",
1804
  `priority` smallint(6) NOT NULL DEFAULT 1, -- where in the queue the patron sits
1804
  `priority` smallint(6) NOT NULL DEFAULT 1 COMMENT "where in the queue the patron sits",
1805
  `found` varchar(1) default NULL, -- a one letter code defining what the status is of the hold is after it has been confirmed
1805
  `found` varchar(1) default NULL COMMENT "a one letter code defining what the status is of the hold is after it has been confirmed",
1806
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this hold was last updated
1806
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "the date and time this hold was last updated",
1807
  `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
1807
  `itemnumber` int(11) default NULL COMMENT "foreign key from the items table defining the specific item the patron has placed on hold or the item this hold was filled with",
1808
  `waitingdate` date default NULL, -- the date the item was marked as waiting for the patron at the library
1808
  `waitingdate` date default NULL COMMENT "the date the item was marked as waiting for the patron at the library",
1809
  `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)
1809
  `expirationdate` DATE DEFAULT NULL COMMENT "the date the hold expires (usually the date entered by the patron to say they don't need the hold after a certain date)",
1810
  `lowestPriority` tinyint(1) NOT NULL DEFAULT 0,
1810
  `lowestPriority` tinyint(1) NOT NULL DEFAULT 0,
1811
  `suspend` tinyint(1) NOT NULL DEFAULT 0,
1811
  `suspend` tinyint(1) NOT NULL DEFAULT 0,
1812
  `suspend_until` DATETIME NULL DEFAULT NULL,
1812
  `suspend_until` DATETIME NULL DEFAULT NULL,
1813
  `itemtype` VARCHAR(10) NULL DEFAULT NULL, -- If record level hold, the optional itemtype of the item the patron is requesting
1813
  `itemtype` VARCHAR(10) NULL DEFAULT NULL COMMENT "If record level hold, the optional itemtype of the item the patron is requesting",
1814
  `item_level_hold` tinyint(1) NOT NULL DEFAULT 0, -- Is the hpld placed at item level
1814
  `item_level_hold` tinyint(1) NOT NULL DEFAULT 0 COMMENT "Is the hpld placed at item level",
1815
  `non_priority` tinyint(1) NOT NULL DEFAULT 0, -- Is this a non priority hold
1815
  `non_priority` tinyint(1) NOT NULL DEFAULT 0 COMMENT "Is this a non priority hold",
1816
  PRIMARY KEY (`reserve_id`),
1816
  PRIMARY KEY (`reserve_id`),
1817
  KEY priorityfoundidx (priority,found),
1817
  KEY priorityfoundidx (priority,found),
1818
  KEY `borrowernumber` (`borrowernumber`),
1818
  KEY `borrowernumber` (`borrowernumber`),
Lines 1835-1863 CREATE TABLE `reserves` ( -- information related to holds/reserves in Koha Link Here
1835
1835
1836
DROP TABLE IF EXISTS `old_reserves`;
1836
DROP TABLE IF EXISTS `old_reserves`;
1837
CREATE TABLE `old_reserves` ( -- this table holds all holds/reserves that have been completed (either filled or cancelled)
1837
CREATE TABLE `old_reserves` ( -- this table holds all holds/reserves that have been completed (either filled or cancelled)
1838
  `reserve_id` int(11) NOT NULL, -- primary key
1838
  `reserve_id` int(11) NOT NULL COMMENT "primary key",
1839
  `borrowernumber` int(11) default NULL, -- foreign key from the borrowers table defining which patron this hold is for
1839
  `borrowernumber` int(11) default NULL COMMENT "foreign key from the borrowers table defining which patron this hold is for",
1840
  `reservedate` date default NULL, -- the date the hold was places
1840
  `reservedate` date default NULL COMMENT "the date the hold was places",
1841
  `biblionumber` int(11) default NULL, -- foreign key from the biblio table defining which bib record this hold is on
1841
  `biblionumber` int(11) default NULL COMMENT "foreign key from the biblio table defining which bib record this hold is on",
1842
  `branchcode` varchar(10) default NULL, -- foreign key from the branches table defining which branch the patron wishes to pick this hold up at
1842
  `branchcode` varchar(10) default NULL COMMENT "foreign key from the branches table defining which branch the patron wishes to pick this hold up at",
1843
  `desk_id` int(11) default NULL, -- foreign key from the desks table defining which desk the patron should pick this hold up at
1843
  `desk_id` int(11) default NULL COMMENT "foreign key from the desks table defining which desk the patron should pick this hold up at",
1844
  `notificationdate` date default NULL, -- currently unused
1844
  `notificationdate` date default NULL COMMENT "currently unused",
1845
  `reminderdate` date default NULL, -- currently unused
1845
  `reminderdate` date default NULL COMMENT "currently unused",
1846
  `cancellationdate` date default NULL, -- the date this hold was cancelled
1846
  `cancellationdate` date default NULL COMMENT "the date this hold was cancelled",
1847
  `cancellation_reason` varchar(80) default NULL, -- optional authorised value CANCELLATION_REASON
1847
  `cancellation_reason` varchar(80) default NULL COMMENT "optional authorised value CANCELLATION_REASON",
1848
  `reservenotes` LONGTEXT, -- notes related to this hold
1848
  `reservenotes` LONGTEXT COMMENT "notes related to this hold",
1849
  `priority` smallint(6) NOT NULL DEFAULT 1, -- where in the queue the patron sits
1849
  `priority` smallint(6) NOT NULL DEFAULT 1 COMMENT "where in the queue the patron sits",
1850
  `found` varchar(1) default NULL, -- a one letter code defining what the status is of the hold is after it has been confirmed
1850
  `found` varchar(1) default NULL COMMENT "a one letter code defining what the status is of the hold is after it has been confirmed",
1851
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this hold was last updated
1851
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "the date and time this hold was last updated",
1852
  `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
1852
  `itemnumber` int(11) default NULL COMMENT "foreign key from the items table defining the specific item the patron has placed on hold or the item this hold was filled with",
1853
  `waitingdate` date default NULL, -- the date the item was marked as waiting for the patron at the library
1853
  `waitingdate` date default NULL COMMENT "the date the item was marked as waiting for the patron at the library",
1854
  `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)
1854
  `expirationdate` DATE DEFAULT NULL COMMENT "the date the hold expires (usually the date entered by the patron to say they don't need the hold after a certain date)",
1855
  `lowestPriority` tinyint(1) NOT NULL DEFAULT 0, -- has this hold been pinned to the lowest priority in the holds queue (1 for yes, 0 for no)
1855
  `lowestPriority` tinyint(1) NOT NULL DEFAULT 0 COMMENT "has this hold been pinned to the lowest priority in the holds queue (1 for yes, 0 for no)",
1856
  `suspend` tinyint(1) NOT NULL DEFAULT 0, -- in this hold suspended (1 for yes, 0 for no)
1856
  `suspend` tinyint(1) NOT NULL DEFAULT 0 COMMENT "in this hold suspended (1 for yes, 0 for no)",
1857
  `suspend_until` DATETIME NULL DEFAULT NULL, -- the date this hold is suspended until (NULL for infinitely)
1857
  `suspend_until` DATETIME NULL DEFAULT NULL COMMENT "the date this hold is suspended until (NULL for infinitely)",
1858
  `itemtype` VARCHAR(10) NULL DEFAULT NULL, -- If record level hold, the optional itemtype of the item the patron is requesting
1858
  `itemtype` VARCHAR(10) NULL DEFAULT NULL COMMENT "If record level hold, the optional itemtype of the item the patron is requesting",
1859
  `item_level_hold` tinyint(1) NOT NULL DEFAULT 0, -- Is the hpld placed at item level
1859
  `item_level_hold` tinyint(1) NOT NULL DEFAULT 0 COMMENT "Is the hpld placed at item level",
1860
  `non_priority` tinyint(1) NOT NULL DEFAULT 0, -- Is this a non priority hold
1860
  `non_priority` tinyint(1) NOT NULL DEFAULT 0 COMMENT "Is this a non priority hold",
1861
  PRIMARY KEY (`reserve_id`),
1861
  PRIMARY KEY (`reserve_id`),
1862
  KEY `old_reserves_borrowernumber` (`borrowernumber`),
1862
  KEY `old_reserves_borrowernumber` (`borrowernumber`),
1863
  KEY `old_reserves_biblionumber` (`biblionumber`),
1863
  KEY `old_reserves_biblionumber` (`biblionumber`),
Lines 1880-1891 CREATE TABLE `old_reserves` ( -- this table holds all holds/reserves that have b Link Here
1880
1880
1881
DROP TABLE IF EXISTS `reviews`;
1881
DROP TABLE IF EXISTS `reviews`;
1882
CREATE TABLE `reviews` ( -- patron opac comments
1882
CREATE TABLE `reviews` ( -- patron opac comments
1883
  `reviewid` int(11) NOT NULL auto_increment, -- unique identifier for this comment
1883
  `reviewid` int(11) NOT NULL auto_increment COMMENT "unique identifier for this comment",
1884
  `borrowernumber` int(11) default NULL, -- foreign key from the borrowers table defining which patron left this comment
1884
  `borrowernumber` int(11) default NULL COMMENT "foreign key from the borrowers table defining which patron left this comment",
1885
  `biblionumber` int(11) default NULL, -- foreign key from the biblio table defining which bibliographic record this comment is for
1885
  `biblionumber` int(11) default NULL COMMENT "foreign key from the biblio table defining which bibliographic record this comment is for",
1886
  `review` MEDIUMTEXT, -- the body of the comment
1886
  `review` MEDIUMTEXT COMMENT "the body of the comment",
1887
  `approved` tinyint(4) default 0, -- whether this comment has been approved by a librarian (1 for yes, 0 for no)
1887
  `approved` tinyint(4) default 0 COMMENT "whether this comment has been approved by a librarian (1 for yes, 0 for no)",
1888
  `datereviewed` datetime default NULL, -- the date the comment was left
1888
  `datereviewed` datetime default NULL COMMENT "the date the comment was left",
1889
  PRIMARY KEY  (`reviewid`),
1889
  PRIMARY KEY  (`reviewid`),
1890
  CONSTRAINT `reviews_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE CASCADE,
1890
  CONSTRAINT `reviews_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE CASCADE,
1891
  CONSTRAINT `reviews_ibfk_2` FOREIGN KEY (`biblionumber`) REFERENCES `biblio` (`biblionumber`) ON DELETE CASCADE ON UPDATE CASCADE
1891
  CONSTRAINT `reviews_ibfk_2` FOREIGN KEY (`biblionumber`) REFERENCES `biblio` (`biblionumber`) ON DELETE CASCADE ON UPDATE CASCADE
Lines 1897-1910 CREATE TABLE `reviews` ( -- patron opac comments Link Here
1897
1897
1898
DROP TABLE IF EXISTS `special_holidays`;
1898
DROP TABLE IF EXISTS `special_holidays`;
1899
CREATE TABLE `special_holidays` ( -- non repeatable holidays/library closings
1899
CREATE TABLE `special_holidays` ( -- non repeatable holidays/library closings
1900
  `id` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
1900
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
1901
  `branchcode` varchar(10) NOT NULL, -- foreign key from the branches table, defines which branch this closing is for
1901
  `branchcode` varchar(10) NOT NULL COMMENT "foreign key from the branches table, defines which branch this closing is for",
1902
  `day` smallint(6) NOT NULL default 0, -- day of the month this closing is on
1902
  `day` smallint(6) NOT NULL default 0 COMMENT "day of the month this closing is on",
1903
  `month` smallint(6) NOT NULL default 0, -- month this closing is in
1903
  `month` smallint(6) NOT NULL default 0 COMMENT "month this closing is in",
1904
  `year` smallint(6) NOT NULL default 0, -- year this closing is in
1904
  `year` smallint(6) NOT NULL default 0 COMMENT "year this closing is in",
1905
  `isexception` smallint(1) NOT NULL default 1, -- is this a holiday exception to a repeatable holiday (1 for yes, 0 for no)
1905
  `isexception` smallint(1) NOT NULL default 1 COMMENT "is this a holiday exception to a repeatable holiday (1 for yes, 0 for no)",
1906
  `title` varchar(50) NOT NULL default '', -- title for this closing
1906
  `title` varchar(50) NOT NULL default '' COMMENT "title for this closing",
1907
  `description` MEDIUMTEXT NOT NULL, -- description of this closing
1907
  `description` MEDIUMTEXT NOT NULL COMMENT "description of this closing",
1908
  PRIMARY KEY  (`id`),
1908
  PRIMARY KEY  (`id`),
1909
  CONSTRAINT `special_holidays_ibfk_1` FOREIGN KEY (`branchcode`) REFERENCES `branches` (`branchcode`) ON DELETE CASCADE ON UPDATE CASCADE
1909
  CONSTRAINT `special_holidays_ibfk_1` FOREIGN KEY (`branchcode`) REFERENCES `branches` (`branchcode`) ON DELETE CASCADE ON UPDATE CASCADE
1910
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1910
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 1915-1930 CREATE TABLE `special_holidays` ( -- non repeatable holidays/library closings Link Here
1915
1915
1916
DROP TABLE IF EXISTS `statistics`;
1916
DROP TABLE IF EXISTS `statistics`;
1917
CREATE TABLE `statistics` ( -- information related to transactions (circulation and fines) in Koha
1917
CREATE TABLE `statistics` ( -- information related to transactions (circulation and fines) in Koha
1918
  `datetime` datetime default NULL, -- date and time of the transaction
1918
  `datetime` datetime default NULL COMMENT "date and time of the transaction",
1919
  `branch` varchar(10) default NULL, -- foreign key, branch where the transaction occurred
1919
  `branch` varchar(10) default NULL COMMENT "foreign key, branch where the transaction occurred",
1920
  `value` double(16,4) default NULL, -- monetary value associated with the transaction
1920
  `value` double(16,4) default NULL COMMENT "monetary value associated with the transaction",
1921
  `type` varchar(16) default NULL, -- transaction type (localuse, issue, return, renew, writeoff, payment)
1921
  `type` varchar(16) default NULL COMMENT "transaction type (localuse, issue, return, renew, writeoff, payment)",
1922
  `other` LONGTEXT, -- used by SIP
1922
  `other` LONGTEXT COMMENT "used by SIP",
1923
  `itemnumber` int(11) default NULL, -- foreign key from the items table, links transaction to a specific item
1923
  `itemnumber` int(11) default NULL COMMENT "foreign key from the items table, links transaction to a specific item",
1924
  `itemtype` varchar(10) default NULL, -- foreign key from the itemtypes table, links transaction to a specific item type
1924
  `itemtype` varchar(10) default NULL COMMENT "foreign key from the itemtypes table, links transaction to a specific item type",
1925
  `location` varchar(80) default NULL, -- authorized value for the shelving location for this item (MARC21 952$c)
1925
  `location` varchar(80) default NULL COMMENT "authorized value for the shelving location for this item (MARC21 952$c)",
1926
  `borrowernumber` int(11) default NULL, -- foreign key from the borrowers table, links transaction to a specific borrower
1926
  `borrowernumber` int(11) default NULL COMMENT "foreign key from the borrowers table, links transaction to a specific borrower",
1927
  `ccode` varchar(80) default NULL, -- foreign key from the items table, links transaction to a specific collection code
1927
  `ccode` varchar(80) default NULL COMMENT "foreign key from the items table, links transaction to a specific collection code",
1928
  KEY `timeidx` (`datetime`),
1928
  KEY `timeidx` (`datetime`),
1929
  KEY `branch_idx` (`branch`),
1929
  KEY `branch_idx` (`branch`),
1930
  KEY `type_idx` (`type`),
1930
  KEY `type_idx` (`type`),
Lines 1976-1985 CREATE TABLE `pseudonymized_transactions` ( Link Here
1976
1976
1977
DROP TABLE IF EXISTS pseudonymized_borrower_attributes;
1977
DROP TABLE IF EXISTS pseudonymized_borrower_attributes;
1978
CREATE TABLE pseudonymized_borrower_attributes ( -- association table between pseudonymized_transactions and borrower_attributes
1978
CREATE TABLE pseudonymized_borrower_attributes ( -- association table between pseudonymized_transactions and borrower_attributes
1979
  `id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, -- Row id field
1979
  `id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY COMMENT "Row id field",
1980
  `transaction_id` int(11) NOT NULL,
1980
  `transaction_id` int(11) NOT NULL,
1981
  `code` varchar(10) NOT NULL, -- foreign key from the borrower_attribute_types table, defines which custom field this value was entered for
1981
  `code` varchar(10) NOT NULL COMMENT "foreign key from the borrower_attribute_types table, defines which custom field this value was entered for",
1982
  `attribute` varchar(255) default NULL, -- custom patron field value
1982
  `attribute` varchar(255) default NULL COMMENT "custom patron field value",
1983
  CONSTRAINT `pseudonymized_borrower_attributes_ibfk_1` FOREIGN KEY (`transaction_id`) REFERENCES `pseudonymized_transactions` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
1983
  CONSTRAINT `pseudonymized_borrower_attributes_ibfk_1` FOREIGN KEY (`transaction_id`) REFERENCES `pseudonymized_transactions` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
1984
  CONSTRAINT `anonymized_borrower_attributes_ibfk_2` FOREIGN KEY (`code`) REFERENCES `borrower_attribute_types` (`code`) ON DELETE CASCADE ON UPDATE CASCADE
1984
  CONSTRAINT `anonymized_borrower_attributes_ibfk_2` FOREIGN KEY (`code`) REFERENCES `borrower_attribute_types` (`code`) ON DELETE CASCADE ON UPDATE CASCADE
1985
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
1985
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 2037-2082 CREATE TABLE subscription_numberpatterns ( Link Here
2037
2037
2038
DROP TABLE IF EXISTS `subscription`;
2038
DROP TABLE IF EXISTS `subscription`;
2039
CREATE TABLE `subscription` ( -- information related to the subscription
2039
CREATE TABLE `subscription` ( -- information related to the subscription
2040
  `biblionumber` int(11) NOT NULL, -- foreign key for biblio.biblionumber that this subscription is attached to
2040
  `biblionumber` int(11) NOT NULL COMMENT "foreign key for biblio.biblionumber that this subscription is attached to",
2041
  `subscriptionid` int(11) NOT NULL auto_increment, -- unique key for this subscription
2041
  `subscriptionid` int(11) NOT NULL auto_increment COMMENT "unique key for this subscription",
2042
  `librarian` varchar(100) default '', -- the librarian's username from borrowers.userid
2042
  `librarian` varchar(100) default '' COMMENT "the librarian's username from borrowers.userid",
2043
  `startdate` date default NULL, -- start date for this subscription
2043
  `startdate` date default NULL COMMENT "start date for this subscription",
2044
  `aqbooksellerid` int(11) default 0, -- foreign key for aqbooksellers.id to link to the vendor
2044
  `aqbooksellerid` int(11) default 0 COMMENT "foreign key for aqbooksellers.id to link to the vendor",
2045
  `cost` int(11) default 0,
2045
  `cost` int(11) default 0,
2046
  `aqbudgetid` int(11) default 0,
2046
  `aqbudgetid` int(11) default 0,
2047
  `weeklength` int(11) default 0, -- subscription length in weeks (will not be filled in if monthlength or numberlength is set)
2047
  `weeklength` int(11) default 0 COMMENT "subscription length in weeks (will not be filled in if monthlength or numberlength is set)",
2048
  `monthlength` int(11) default 0, -- subscription length in weeks (will not be filled in if weeklength or numberlength is set)
2048
  `monthlength` int(11) default 0 COMMENT "subscription length in weeks (will not be filled in if weeklength or numberlength is set)",
2049
  `numberlength` int(11) default 0, -- subscription length in weeks (will not be filled in if monthlength or weeklength is set)
2049
  `numberlength` int(11) default 0 COMMENT "subscription length in weeks (will not be filled in if monthlength or weeklength is set)",
2050
  `periodicity` integer default null, -- frequency type links to subscription_frequencies.id
2050
  `periodicity` integer default null COMMENT "frequency type links to subscription_frequencies.id",
2051
  countissuesperunit INTEGER NOT NULL DEFAULT 1,
2051
  countissuesperunit INTEGER NOT NULL DEFAULT 1,
2052
  `notes` LONGTEXT, -- notes
2052
  `notes` LONGTEXT COMMENT "notes",
2053
  `status` varchar(100) NOT NULL default '',  -- status of this subscription
2053
  `status` varchar(100) NOT NULL default '' COMMENT "status of this subscription",
2054
  `lastvalue1` int(11) default NULL,
2054
  `lastvalue1` int(11) default NULL,
2055
  `innerloop1` int(11) default 0,
2055
  `innerloop1` int(11) default 0,
2056
  `lastvalue2` int(11) default NULL,
2056
  `lastvalue2` int(11) default NULL,
2057
  `innerloop2` int(11) default 0,
2057
  `innerloop2` int(11) default 0,
2058
  `lastvalue3` int(11) default NULL,
2058
  `lastvalue3` int(11) default NULL,
2059
  `innerloop3` int(11) default 0,
2059
  `innerloop3` int(11) default 0,
2060
  `firstacquidate` date default NULL, -- first issue received date
2060
  `firstacquidate` date default NULL COMMENT "first issue received date",
2061
  `manualhistory` tinyint(1) NOT NULL default 0, -- yes or no to managing the history manually
2061
  `manualhistory` tinyint(1) NOT NULL default 0 COMMENT "yes or no to managing the history manually",
2062
  `irregularity` MEDIUMTEXT, -- any irregularities in the subscription
2062
  `irregularity` MEDIUMTEXT COMMENT "any irregularities in the subscription",
2063
  skip_serialseq tinyint(1) NOT NULL DEFAULT 0,
2063
  skip_serialseq tinyint(1) NOT NULL DEFAULT 0,
2064
  `letter` varchar(20) default NULL,
2064
  `letter` varchar(20) default NULL,
2065
  `numberpattern` integer default null, -- the numbering pattern used links to subscription_numberpatterns.id
2065
  `numberpattern` integer default null COMMENT "the numbering pattern used links to subscription_numberpatterns.id",
2066
  locale VARCHAR(80) DEFAULT NULL, -- for foreign language subscriptions to display months, seasons, etc correctly
2066
  locale VARCHAR(80) DEFAULT NULL COMMENT "for foreign language subscriptions to display months, seasons, etc correctly",
2067
  `distributedto` MEDIUMTEXT,
2067
  `distributedto` MEDIUMTEXT,
2068
  `internalnotes` LONGTEXT,
2068
  `internalnotes` LONGTEXT,
2069
  `callnumber` MEDIUMTEXT, -- default call number
2069
  `callnumber` MEDIUMTEXT COMMENT "default call number",
2070
  `location` varchar(80) NULL default '', -- default shelving location (items.location)
2070
  `location` varchar(80) NULL default '' COMMENT "default shelving location (items.location)",
2071
  `branchcode` varchar(10) NOT NULL default '', -- default branches (items.homebranch)
2071
  `branchcode` varchar(10) NOT NULL default '' COMMENT "default branches (items.homebranch)",
2072
  `lastbranch` varchar(10),
2072
  `lastbranch` varchar(10),
2073
  `serialsadditems` tinyint(1) NOT NULL default '0', -- does receiving this serial create an item record
2073
  `serialsadditems` tinyint(1) NOT NULL default '0' COMMENT "does receiving this serial create an item record",
2074
  `staffdisplaycount` VARCHAR(10) NULL, -- how many issues to show to the staff
2074
  `staffdisplaycount` VARCHAR(10) NULL COMMENT "how many issues to show to the staff",
2075
  `opacdisplaycount` VARCHAR(10) NULL, -- how many issues to show to the public
2075
  `opacdisplaycount` VARCHAR(10) NULL COMMENT "how many issues to show to the public",
2076
  `graceperiod` int(11) NOT NULL default '0', -- grace period in days
2076
  `graceperiod` int(11) NOT NULL default '0' COMMENT "grace period in days",
2077
  `enddate` date default NULL, -- subscription end date
2077
  `enddate` date default NULL COMMENT "subscription end date",
2078
  `closed` TINYINT(1) NOT NULL DEFAULT 0, -- yes / no if the subscription is closed
2078
  `closed` TINYINT(1) NOT NULL DEFAULT 0 COMMENT "yes / no if the subscription is closed",
2079
  `reneweddate` date default NULL, -- date of last renewal for the subscription
2079
  `reneweddate` date default NULL COMMENT "date of last renewal for the subscription",
2080
  `itemtype` VARCHAR( 10 ) NULL,
2080
  `itemtype` VARCHAR( 10 ) NULL,
2081
  `previousitemtype` VARCHAR( 10 ) NULL,
2081
  `previousitemtype` VARCHAR( 10 ) NULL,
2082
  `mana_id` int(11) NULL DEFAULT NULL,
2082
  `mana_id` int(11) NULL DEFAULT NULL,
Lines 2092-2112 CREATE TABLE `subscription` ( -- information related to the subscription Link Here
2092
2092
2093
DROP TABLE IF EXISTS `serial`;
2093
DROP TABLE IF EXISTS `serial`;
2094
CREATE TABLE `serial` ( -- issues related to subscriptions
2094
CREATE TABLE `serial` ( -- issues related to subscriptions
2095
  `serialid` int(11) NOT NULL auto_increment, -- unique key for the issue
2095
  `serialid` int(11) NOT NULL auto_increment COMMENT "unique key for the issue",
2096
  `biblionumber` int(11) NOT NULL, -- foreign key for the biblio.biblionumber that this issue is attached to
2096
  `biblionumber` int(11) NOT NULL COMMENT "foreign key for the biblio.biblionumber that this issue is attached to",
2097
  `subscriptionid` int(11) NOT NULL, -- foreign key to the subscription.subscriptionid that this issue is part of
2097
  `subscriptionid` int(11) NOT NULL COMMENT "foreign key to the subscription.subscriptionid that this issue is part of",
2098
  `serialseq` varchar(100) NOT NULL default '', -- issue information (volume, number, etc)
2098
  `serialseq` varchar(100) NOT NULL default '' COMMENT "issue information (volume, number, etc)",
2099
  `serialseq_x` varchar( 100 ) NULL DEFAULT NULL, -- first part of issue information
2099
  `serialseq_x` varchar( 100 ) NULL DEFAULT NULL COMMENT "first part of issue information",
2100
  `serialseq_y` varchar( 100 ) NULL DEFAULT NULL, -- second part of issue information
2100
  `serialseq_y` varchar( 100 ) NULL DEFAULT NULL COMMENT "second part of issue information",
2101
  `serialseq_z` varchar( 100 ) NULL DEFAULT NULL, -- third part of issue information
2101
  `serialseq_z` varchar( 100 ) NULL DEFAULT NULL COMMENT "third part of issue information",
2102
  `status` tinyint(4) NOT NULL default 0, -- status code for this issue (see manual for full descriptions)
2102
  `status` tinyint(4) NOT NULL default 0 COMMENT "status code for this issue (see manual for full descriptions)",
2103
  `planneddate` date default NULL, -- date expected
2103
  `planneddate` date default NULL COMMENT "date expected",
2104
  `notes` MEDIUMTEXT, -- notes
2104
  `notes` MEDIUMTEXT COMMENT "notes",
2105
  `publisheddate` date default NULL, -- date published
2105
  `publisheddate` date default NULL COMMENT "date published",
2106
  publisheddatetext varchar(100) default NULL, -- date published (descriptive)
2106
  publisheddatetext varchar(100) default NULL COMMENT "date published (descriptive)",
2107
  `claimdate` date default NULL, -- date claimed
2107
  `claimdate` date default NULL COMMENT "date claimed",
2108
  claims_count int(11) default 0, -- number of claims made related to this issue
2108
  claims_count int(11) default 0 COMMENT "number of claims made related to this issue",
2109
  `routingnotes` MEDIUMTEXT, -- notes from the routing list
2109
  `routingnotes` MEDIUMTEXT COMMENT "notes from the routing list",
2110
  PRIMARY KEY (`serialid`),
2110
  PRIMARY KEY (`serialid`),
2111
  CONSTRAINT serial_ibfk_1 FOREIGN KEY (biblionumber) REFERENCES biblio (biblionumber) ON DELETE CASCADE ON UPDATE CASCADE,
2111
  CONSTRAINT serial_ibfk_1 FOREIGN KEY (biblionumber) REFERENCES biblio (biblionumber) ON DELETE CASCADE ON UPDATE CASCADE,
2112
  CONSTRAINT serial_ibfk_2 FOREIGN KEY (subscriptionid) REFERENCES subscription (subscriptionid) ON DELETE CASCADE ON UPDATE CASCADE
2112
  CONSTRAINT serial_ibfk_2 FOREIGN KEY (subscriptionid) REFERENCES subscription (subscriptionid) ON DELETE CASCADE ON UPDATE CASCADE
Lines 2137-2146 CREATE TABLE `subscriptionhistory` ( Link Here
2137
2137
2138
DROP TABLE IF EXISTS `subscriptionroutinglist`;
2138
DROP TABLE IF EXISTS `subscriptionroutinglist`;
2139
CREATE TABLE `subscriptionroutinglist` ( -- information related to the routing lists attached to subscriptions
2139
CREATE TABLE `subscriptionroutinglist` ( -- information related to the routing lists attached to subscriptions
2140
  `routingid` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
2140
  `routingid` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
2141
  `borrowernumber` int(11) NOT NULL, -- foreign key from the borrowers table, defines with patron is on the routing list
2141
  `borrowernumber` int(11) NOT NULL COMMENT "foreign key from the borrowers table, defines with patron is on the routing list",
2142
  `ranking` int(11) default NULL, -- where the patron stands in line to receive the serial
2142
  `ranking` int(11) default NULL COMMENT "where the patron stands in line to receive the serial",
2143
  `subscriptionid` int(11) NOT NULL, -- foreign key from the subscription table, defines which subscription this routing list is for
2143
  `subscriptionid` int(11) NOT NULL COMMENT "foreign key from the subscription table, defines which subscription this routing list is for",
2144
  PRIMARY KEY  (`routingid`),
2144
  PRIMARY KEY  (`routingid`),
2145
  UNIQUE (`subscriptionid`, `borrowernumber`),
2145
  UNIQUE (`subscriptionid`, `borrowernumber`),
2146
  CONSTRAINT `subscriptionroutinglist_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`)
2146
  CONSTRAINT `subscriptionroutinglist_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`)
Lines 2155-2165 CREATE TABLE `subscriptionroutinglist` ( -- information related to the routing l Link Here
2155
2155
2156
DROP TABLE IF EXISTS `systempreferences`;
2156
DROP TABLE IF EXISTS `systempreferences`;
2157
CREATE TABLE `systempreferences` ( -- global system preferences
2157
CREATE TABLE `systempreferences` ( -- global system preferences
2158
  `variable` varchar(50) NOT NULL default '', -- system preference name
2158
  `variable` varchar(50) NOT NULL default '' COMMENT "system preference name",
2159
  `value` MEDIUMTEXT, -- system preference values
2159
  `value` MEDIUMTEXT COMMENT "system preference values",
2160
  `options` LONGTEXT, -- options for multiple choice system preferences
2160
  `options` LONGTEXT COMMENT "options for multiple choice system preferences",
2161
  `explanation` MEDIUMTEXT, -- descriptive text for the system preference
2161
  `explanation` MEDIUMTEXT COMMENT "descriptive text for the system preference",
2162
  `type` varchar(20) default NULL, -- type of question this preference asks (multiple choice, plain text, yes or no, etc)
2162
  `type` varchar(20) default NULL COMMENT "type of question this preference asks (multiple choice, plain text, yes or no, etc)",
2163
  PRIMARY KEY  (`variable`)
2163
  PRIMARY KEY  (`variable`)
2164
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2164
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2165
2165
Lines 2180-2191 CREATE TABLE `tags` ( Link Here
2180
2180
2181
DROP TABLE IF EXISTS `tags_all`;
2181
DROP TABLE IF EXISTS `tags_all`;
2182
CREATE TABLE `tags_all` ( -- all of the tags
2182
CREATE TABLE `tags_all` ( -- all of the tags
2183
  `tag_id`         int(11) NOT NULL auto_increment, -- unique id and primary key
2183
  `tag_id`         int(11) NOT NULL auto_increment COMMENT "unique id and primary key",
2184
  `borrowernumber` int(11) DEFAULT NULL, -- the patron who added the tag (borrowers.borrowernumber)
2184
  `borrowernumber` int(11) DEFAULT NULL COMMENT "the patron who added the tag (borrowers.borrowernumber)",
2185
  `biblionumber`   int(11) NOT NULL, -- the bib record this tag was left on (biblio.biblionumber)
2185
  `biblionumber`   int(11) NOT NULL COMMENT "the bib record this tag was left on (biblio.biblionumber)",
2186
  `term`      varchar(191) NOT NULL COLLATE utf8mb4_bin, -- the tag
2186
  `term`      varchar(191) NOT NULL COLLATE utf8mb4_bin COMMENT "the tag",
2187
  `language`       int(4) default NULL, -- the language the tag was left in
2187
  `language`       int(4) default NULL COMMENT "the language the tag was left in",
2188
  `date_created` datetime  NOT NULL, -- the date the tag was added
2188
  `date_created` datetime  NOT NULL COMMENT "the date the tag was added",
2189
  PRIMARY KEY  (`tag_id`),
2189
  PRIMARY KEY  (`tag_id`),
2190
  KEY `tags_borrowers_fk_1` (`borrowernumber`),
2190
  KEY `tags_borrowers_fk_1` (`borrowernumber`),
2191
  KEY `tags_biblionumber_fk_1` (`biblionumber`),
2191
  KEY `tags_biblionumber_fk_1` (`biblionumber`),
Lines 2201-2211 CREATE TABLE `tags_all` ( -- all of the tags Link Here
2201
2201
2202
DROP TABLE IF EXISTS `tags_approval`;
2202
DROP TABLE IF EXISTS `tags_approval`;
2203
CREATE TABLE `tags_approval` ( -- approved tags
2203
CREATE TABLE `tags_approval` ( -- approved tags
2204
  `term`   varchar(191) NOT NULL COLLATE utf8mb4_bin, -- the tag
2204
  `term`   varchar(191) NOT NULL COLLATE utf8mb4_bin COMMENT "the tag",
2205
  `approved`     int(1) NOT NULL default '0', -- whether the tag is approved or not (1=yes, 0=pending, -1=rejected)
2205
  `approved`     int(1) NOT NULL default '0' COMMENT "whether the tag is approved or not (1=yes, 0=pending, -1=rejected)",
2206
  `date_approved` datetime       default NULL, -- the date this tag was approved
2206
  `date_approved` datetime       default NULL COMMENT "the date this tag was approved",
2207
  `approved_by` int(11)          default NULL, -- the librarian who approved the tag (borrowers.borrowernumber)
2207
  `approved_by` int(11)          default NULL COMMENT "the librarian who approved the tag (borrowers.borrowernumber)",
2208
  `weight_total` int(9) NOT NULL default '1', -- the total number of times this tag was used
2208
  `weight_total` int(9) NOT NULL default '1' COMMENT "the total number of times this tag was used",
2209
  PRIMARY KEY  (`term`),
2209
  PRIMARY KEY  (`term`),
2210
  KEY `tags_approval_borrowers_fk_1` (`approved_by`),
2210
  KEY `tags_approval_borrowers_fk_1` (`approved_by`),
2211
  CONSTRAINT `tags_approval_borrowers_fk_1` FOREIGN KEY (`approved_by`)
2211
  CONSTRAINT `tags_approval_borrowers_fk_1` FOREIGN KEY (`approved_by`)
Lines 2218-2226 CREATE TABLE `tags_approval` ( -- approved tags Link Here
2218
2218
2219
DROP TABLE IF EXISTS `tags_index`;
2219
DROP TABLE IF EXISTS `tags_index`;
2220
CREATE TABLE `tags_index` ( -- a weighted list of all tags and where they are used
2220
CREATE TABLE `tags_index` ( -- a weighted list of all tags and where they are used
2221
  `term`    varchar(191) NOT NULL COLLATE utf8mb4_bin, -- the tag
2221
  `term`    varchar(191) NOT NULL COLLATE utf8mb4_bin COMMENT "the tag",
2222
  `biblionumber` int(11) NOT NULL, -- the bib record this tag was used on (biblio.biblionumber)
2222
  `biblionumber` int(11) NOT NULL COMMENT "the bib record this tag was used on (biblio.biblionumber)",
2223
  `weight`        int(9) NOT NULL default '1', -- the number of times this term was used on this bib record
2223
  `weight`        int(9) NOT NULL default '1' COMMENT "the number of times this term was used on this bib record",
2224
  PRIMARY KEY  (`term`,`biblionumber`),
2224
  PRIMARY KEY  (`term`,`biblionumber`),
2225
  KEY `tags_index_biblionumber_fk_1` (`biblionumber`),
2225
  KEY `tags_index_biblionumber_fk_1` (`biblionumber`),
2226
  CONSTRAINT `tags_index_term_fk_1` FOREIGN KEY (`term`)
2226
  CONSTRAINT `tags_index_term_fk_1` FOREIGN KEY (`term`)
Lines 2248-2262 CREATE TABLE `userflags` ( Link Here
2248
2248
2249
DROP TABLE IF EXISTS `virtualshelves`;
2249
DROP TABLE IF EXISTS `virtualshelves`;
2250
CREATE TABLE `virtualshelves` ( -- information about lists (or virtual shelves)
2250
CREATE TABLE `virtualshelves` ( -- information about lists (or virtual shelves)
2251
  `shelfnumber` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
2251
  `shelfnumber` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
2252
  `shelfname` varchar(255) default NULL, -- name of the list
2252
  `shelfname` varchar(255) default NULL COMMENT "name of the list",
2253
  `owner` int default NULL, -- foreign key linking to the borrowers table (using borrowernumber) for the creator of this list (changed from varchar(80) to int)
2253
  `owner` int default NULL COMMENT "foreign key linking to the borrowers table (using borrowernumber) for the creator of this list (changed from varchar(80) to int)",
2254
  `category` varchar(1) default NULL, -- type of list (private [1], public [2])
2254
  `category` varchar(1) default NULL COMMENT "type of list (private [1], public [2])",
2255
  `sortfield` varchar(16) default 'title', -- the field this list is sorted on
2255
  `sortfield` varchar(16) default 'title' COMMENT "the field this list is sorted on",
2256
  `lastmodified` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time the list was last modified
2256
  `lastmodified` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time the list was last modified",
2257
  `created_on` datetime NOT NULL, -- creation time
2257
  `created_on` datetime NOT NULL COMMENT "creation time",
2258
  `allow_change_from_owner` tinyint(1) default 1, -- can owner change contents?
2258
  `allow_change_from_owner` tinyint(1) default 1 COMMENT "can owner change contents?",
2259
  `allow_change_from_others` tinyint(1) default 0, -- can others change contents?
2259
  `allow_change_from_others` tinyint(1) default 0 COMMENT "can others change contents?",
2260
  PRIMARY KEY  (`shelfnumber`),
2260
  PRIMARY KEY  (`shelfnumber`),
2261
  CONSTRAINT `virtualshelves_ibfk_1` FOREIGN KEY (`owner`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE SET NULL -- no cascaded delete, please see HandleDelBorrower in Members.pm
2261
  CONSTRAINT `virtualshelves_ibfk_1` FOREIGN KEY (`owner`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE SET NULL -- no cascaded delete, please see HandleDelBorrower in Members.pm
2262
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2262
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 2267-2277 CREATE TABLE `virtualshelves` ( -- information about lists (or virtual shelves) Link Here
2267
2267
2268
DROP TABLE IF EXISTS `virtualshelfcontents`;
2268
DROP TABLE IF EXISTS `virtualshelfcontents`;
2269
CREATE TABLE `virtualshelfcontents` ( -- information about the titles in a list (or virtual shelf)
2269
CREATE TABLE `virtualshelfcontents` ( -- information about the titles in a list (or virtual shelf)
2270
  `shelfnumber` int(11) NOT NULL default 0, -- foreign key linking to the virtualshelves table, defines the list that this record has been added to
2270
  `shelfnumber` int(11) NOT NULL default 0 COMMENT "foreign key linking to the virtualshelves table, defines the list that this record has been added to",
2271
  `biblionumber` int(11) NOT NULL default 0, -- foreign key linking to the biblio table, defines the bib record that has been added to the list
2271
  `biblionumber` int(11) NOT NULL default 0 COMMENT "foreign key linking to the biblio table, defines the bib record that has been added to the list",
2272
  `flags` int(11) default NULL,
2272
  `flags` int(11) default NULL,
2273
  `dateadded` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- date and time this bib record was added to the list
2273
  `dateadded` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "date and time this bib record was added to the list",
2274
  `borrowernumber` int, -- borrower number that created this list entry (only the first one is saved: no need for use in/as key)
2274
  `borrowernumber` int COMMENT "borrower number that created this list entry (only the first one is saved: no need for use in/as key)",
2275
  KEY `shelfnumber` (`shelfnumber`),
2275
  KEY `shelfnumber` (`shelfnumber`),
2276
  KEY `biblionumber` (`biblionumber`),
2276
  KEY `biblionumber` (`biblionumber`),
2277
  CONSTRAINT `virtualshelfcontents_ibfk_1` FOREIGN KEY (`shelfnumber`) REFERENCES `virtualshelves` (`shelfnumber`) ON DELETE CASCADE ON UPDATE CASCADE,
2277
  CONSTRAINT `virtualshelfcontents_ibfk_1` FOREIGN KEY (`shelfnumber`) REFERENCES `virtualshelves` (`shelfnumber`) ON DELETE CASCADE ON UPDATE CASCADE,
Lines 2285-2295 CREATE TABLE `virtualshelfcontents` ( -- information about the titles in a list Link Here
2285
2285
2286
DROP TABLE IF EXISTS `virtualshelfshares`;
2286
DROP TABLE IF EXISTS `virtualshelfshares`;
2287
CREATE TABLE `virtualshelfshares` ( -- shared private lists
2287
CREATE TABLE `virtualshelfshares` ( -- shared private lists
2288
  `id` int AUTO_INCREMENT PRIMARY KEY,  -- unique key
2288
  `id` int AUTO_INCREMENT PRIMARY KEY COMMENT "unique key",
2289
  `shelfnumber` int NOT NULL,  -- foreign key for virtualshelves
2289
  `shelfnumber` int NOT NULL COMMENT "foreign key for virtualshelves",
2290
  `borrowernumber` int,  -- borrower that accepted access to this list
2290
  `borrowernumber` int COMMENT "borrower that accepted access to this list",
2291
  `invitekey` varchar(10), -- temporary string used in accepting the invitation to access thist list; not-empty means that the invitation has not been accepted yet
2291
  `invitekey` varchar(10) COMMENT "temporary string used in accepting the invitation to access thist list; not-empty means that the invitation has not been accepted yet",
2292
  `sharedate` datetime,  -- date of invitation or acceptance of invitation
2292
  `sharedate` datetime COMMENT "date of invitation or acceptance of invitation",
2293
  CONSTRAINT `virtualshelfshares_ibfk_1` FOREIGN KEY (`shelfnumber`) REFERENCES `virtualshelves` (`shelfnumber`) ON DELETE CASCADE ON UPDATE CASCADE,
2293
  CONSTRAINT `virtualshelfshares_ibfk_1` FOREIGN KEY (`shelfnumber`) REFERENCES `virtualshelves` (`shelfnumber`) ON DELETE CASCADE ON UPDATE CASCADE,
2294
  CONSTRAINT `virtualshelfshares_ibfk_2` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE SET NULL -- no cascaded delete, please see HandleDelBorrower in Members.pm
2294
  CONSTRAINT `virtualshelfshares_ibfk_2` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL ON UPDATE SET NULL -- no cascaded delete, please see HandleDelBorrower in Members.pm
2295
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2295
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 2300-2323 CREATE TABLE `virtualshelfshares` ( -- shared private lists Link Here
2300
2300
2301
DROP TABLE IF EXISTS `z3950servers`;
2301
DROP TABLE IF EXISTS `z3950servers`;
2302
CREATE TABLE `z3950servers` ( -- connection information for the Z39.50 targets used in cataloging
2302
CREATE TABLE `z3950servers` ( -- connection information for the Z39.50 targets used in cataloging
2303
  `id` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
2303
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
2304
  `host` varchar(255) default NULL, -- target's host name
2304
  `host` varchar(255) default NULL COMMENT "target's host name",
2305
  `port` int(11) default NULL, -- port number used to connect to target
2305
  `port` int(11) default NULL COMMENT "port number used to connect to target",
2306
  `db` varchar(255) default NULL, -- target's database name
2306
  `db` varchar(255) default NULL COMMENT "target's database name",
2307
  `userid` varchar(255) default NULL, -- username needed to log in to target
2307
  `userid` varchar(255) default NULL COMMENT "username needed to log in to target",
2308
  `password` varchar(255) default NULL, -- password needed to log in to target
2308
  `password` varchar(255) default NULL COMMENT "password needed to log in to target",
2309
  `servername` LONGTEXT NOT NULL, -- name given to the target by the library
2309
  `servername` LONGTEXT NOT NULL COMMENT "name given to the target by the library",
2310
  `checked` smallint(6) default NULL, -- whether this target is checked by default  (1 for yes, 0 for no)
2310
  `checked` smallint(6) default NULL COMMENT "whether this target is checked by default  (1 for yes, 0 for no)",
2311
  `rank` int(11) default NULL, -- where this target appears in the list of targets
2311
  `rank` int(11) default NULL COMMENT "where this target appears in the list of targets",
2312
  `syntax` varchar(80) default NULL, -- marc format provided by this target
2312
  `syntax` varchar(80) default NULL COMMENT "marc format provided by this target",
2313
  `timeout` int(11) NOT NULL DEFAULT '0', -- number of seconds before Koha stops trying to access this server
2313
  `timeout` int(11) NOT NULL DEFAULT '0' COMMENT "number of seconds before Koha stops trying to access this server",
2314
  `servertype` enum('zed','sru') NOT NULL default 'zed', -- zed means z39.50 server
2314
  `servertype` enum('zed','sru') NOT NULL default 'zed' COMMENT "zed means z39.50 server",
2315
  `encoding` MEDIUMTEXT default NULL, -- characters encoding provided by this target
2315
  `encoding` MEDIUMTEXT default NULL COMMENT "characters encoding provided by this target",
2316
  `recordtype` enum('authority','biblio') NOT NULL default 'biblio', -- server contains bibliographic or authority records
2316
  `recordtype` enum('authority','biblio') NOT NULL default 'biblio' COMMENT "server contains bibliographic or authority records",
2317
  `sru_options` varchar(255) default NULL, -- options like sru=get, sru_version=1.1; will be passed to the server via ZOOM
2317
  `sru_options` varchar(255) default NULL COMMENT "options like sru=get, sru_version=1.1; will be passed to the server via ZOOM",
2318
  `sru_fields` LONGTEXT default NULL, -- contains the mapping between the Z3950 search fields and the specific SRU server indexes
2318
  `sru_fields` LONGTEXT default NULL COMMENT "contains the mapping between the Z3950 search fields and the specific SRU server indexes",
2319
  `add_xslt` LONGTEXT default NULL, -- zero or more paths to XSLT files to be processed on the search results
2319
  `add_xslt` LONGTEXT default NULL COMMENT "zero or more paths to XSLT files to be processed on the search results",
2320
  `attributes` VARCHAR(255) default NULL, -- additional attributes passed to PQF queries
2320
  `attributes` VARCHAR(255) default NULL COMMENT "additional attributes passed to PQF queries",
2321
  PRIMARY KEY  (`id`)
2321
  PRIMARY KEY  (`id`)
2322
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2322
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2323
2323
Lines 2346-2353 CREATE TABLE `zebraqueue` ( Link Here
2346
DROP TABLE IF EXISTS language_subtag_registry;
2346
DROP TABLE IF EXISTS language_subtag_registry;
2347
CREATE TABLE language_subtag_registry (
2347
CREATE TABLE language_subtag_registry (
2348
        subtag varchar(25),
2348
        subtag varchar(25),
2349
        type varchar(25), -- language-script-region-variant-extension-privateuse
2349
        type varchar(25) COMMENT "language-script-region-variant-extension-privateuse",
2350
        description varchar(25), -- only one of the possible descriptions for ease of reference, see language_descriptions for the complete list
2350
        description varchar(25) COMMENT "only one of the possible descriptions for ease of reference, see language_descriptions for the complete list",
2351
        added date,
2351
        added date,
2352
        id int(11) NOT NULL auto_increment,
2352
        id int(11) NOT NULL auto_increment,
2353
        PRIMARY KEY  (`id`),
2353
        PRIMARY KEY  (`id`),
Lines 2393-2400 CREATE TABLE language_descriptions ( Link Here
2393
2393
2394
DROP TABLE IF EXISTS language_script_bidi;
2394
DROP TABLE IF EXISTS language_script_bidi;
2395
CREATE TABLE language_script_bidi (
2395
CREATE TABLE language_script_bidi (
2396
        rfc4646_subtag varchar(25), -- script subtag, Arab, Hebr, etc.
2396
        rfc4646_subtag varchar(25) COMMENT "script subtag, Arab, Hebr, etc.",
2397
        bidi varchar(3), -- rtl ltr
2397
        bidi varchar(3) COMMENT "rtl ltr",
2398
        KEY `rfc4646_subtag` (`rfc4646_subtag`)
2398
        KEY `rfc4646_subtag` (`rfc4646_subtag`)
2399
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2399
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2400
2400
Lines 2522-2537 CREATE TABLE `message_queue` ( Link Here
2522
2522
2523
DROP TABLE IF EXISTS `letter`;
2523
DROP TABLE IF EXISTS `letter`;
2524
CREATE TABLE `letter` ( -- table for all notice templates in Koha
2524
CREATE TABLE `letter` ( -- table for all notice templates in Koha
2525
  `module` varchar(20) NOT NULL default '', -- Koha module that triggers this notice or slip
2525
  `module` varchar(20) NOT NULL default '' COMMENT "Koha module that triggers this notice or slip",
2526
  `code` varchar(20) NOT NULL default '', -- unique identifier for this notice or slip
2526
  `code` varchar(20) NOT NULL default '' COMMENT "unique identifier for this notice or slip",
2527
  `branchcode` varchar(10) NOT NULL default '', -- the branch this notice or slip is used at (branches.branchcode)
2527
  `branchcode` varchar(10) NOT NULL default '' COMMENT "the branch this notice or slip is used at (branches.branchcode)",
2528
  `name` varchar(100) NOT NULL default '', -- plain text name for this notice or slip
2528
  `name` varchar(100) NOT NULL default '' COMMENT "plain text name for this notice or slip",
2529
  `is_html` tinyint(1) default 0, -- does this notice or slip use HTML (1 for yes, 0 for no)
2529
  `is_html` tinyint(1) default 0 COMMENT "does this notice or slip use HTML (1 for yes, 0 for no)",
2530
  `title` varchar(200) NOT NULL default '', -- subject line of the notice
2530
  `title` varchar(200) NOT NULL default '' COMMENT "subject line of the notice",
2531
  `content` MEDIUMTEXT, -- body text for the notice or slip
2531
  `content` MEDIUMTEXT COMMENT "body text for the notice or slip",
2532
  `message_transport_type` varchar(20) NOT NULL DEFAULT 'email', -- transport type for this notice
2532
  `message_transport_type` varchar(20) NOT NULL DEFAULT 'email' COMMENT "transport type for this notice",
2533
  `lang` varchar(25) NOT NULL DEFAULT 'default', -- lang of the notice
2533
  `lang` varchar(25) NOT NULL DEFAULT 'default' COMMENT "lang of the notice",
2534
  `updated_on` timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- last modification
2534
  `updated_on` timestamp NOT NULL default CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "last modification",
2535
  PRIMARY KEY  (`module`,`code`, `branchcode`, `message_transport_type`, `lang`),
2535
  PRIMARY KEY  (`module`,`code`, `branchcode`, `message_transport_type`, `lang`),
2536
  CONSTRAINT `message_transport_type_fk` FOREIGN KEY (`message_transport_type`)
2536
  CONSTRAINT `message_transport_type_fk` FOREIGN KEY (`message_transport_type`)
2537
  REFERENCES `message_transport_types` (`message_transport_type`) ON DELETE CASCADE ON UPDATE CASCADE
2537
  REFERENCES `message_transport_types` (`message_transport_type`) ON DELETE CASCADE ON UPDATE CASCADE
Lines 2590-2602 CREATE TABLE `message_transports` ( Link Here
2590
2590
2591
DROP TABLE IF EXISTS `borrower_files`;
2591
DROP TABLE IF EXISTS `borrower_files`;
2592
CREATE TABLE IF NOT EXISTS `borrower_files` ( -- files attached to the patron/borrower record
2592
CREATE TABLE IF NOT EXISTS `borrower_files` ( -- files attached to the patron/borrower record
2593
  `file_id` int(11) NOT NULL AUTO_INCREMENT, -- unique key
2593
  `file_id` int(11) NOT NULL AUTO_INCREMENT COMMENT "unique key",
2594
  `borrowernumber` int(11) NOT NULL, -- foreign key linking to the patron via the borrowernumber
2594
  `borrowernumber` int(11) NOT NULL COMMENT "foreign key linking to the patron via the borrowernumber",
2595
  `file_name` varchar(255) NOT NULL, -- file name
2595
  `file_name` varchar(255) NOT NULL COMMENT "file name",
2596
  `file_type` varchar(255) NOT NULL, -- type of file
2596
  `file_type` varchar(255) NOT NULL COMMENT "type of file",
2597
  `file_description` varchar(255) DEFAULT NULL, -- description given to the file
2597
  `file_description` varchar(255) DEFAULT NULL COMMENT "description given to the file",
2598
  `file_content` longblob NOT NULL, -- the file
2598
  `file_content` longblob NOT NULL COMMENT "the file",
2599
  `date_uploaded` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, -- date and time the file was added
2599
  `date_uploaded` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "date and time the file was added",
2600
  PRIMARY KEY (`file_id`),
2600
  PRIMARY KEY (`file_id`),
2601
  KEY `borrowernumber` (`borrowernumber`),
2601
  KEY `borrowernumber` (`borrowernumber`),
2602
  CONSTRAINT borrower_files_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE
2602
  CONSTRAINT borrower_files_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE
Lines 2671-2683 CREATE TABLE `item_circulation_alert_preferences` ( Link Here
2671
--
2671
--
2672
DROP TABLE IF EXISTS `messages`;
2672
DROP TABLE IF EXISTS `messages`;
2673
CREATE TABLE `messages` ( -- circulation messages left via the patron's check out screen
2673
CREATE TABLE `messages` ( -- circulation messages left via the patron's check out screen
2674
  `message_id` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
2674
  `message_id` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
2675
  `borrowernumber` int(11) NOT NULL, -- foreign key linking this message to the borrowers table
2675
  `borrowernumber` int(11) NOT NULL COMMENT "foreign key linking this message to the borrowers table",
2676
  `branchcode` varchar(10) default NULL, -- foreign key linking the message to the branches table
2676
  `branchcode` varchar(10) default NULL COMMENT "foreign key linking the message to the branches table",
2677
  `message_type` varchar(1) NOT NULL, -- whether the message is for the librarians (L) or the patron (B)
2677
  `message_type` varchar(1) NOT NULL COMMENT "whether the message is for the librarians (L) or the patron (B)",
2678
  `message` MEDIUMTEXT NOT NULL, -- the text of the message
2678
  `message` MEDIUMTEXT NOT NULL COMMENT "the text of the message",
2679
  `message_date` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, -- the date and time the message was written
2679
  `message_date` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "the date and time the message was written",
2680
  `manager_id` int(11) default NULL, -- creator of message
2680
  `manager_id` int(11) default NULL COMMENT "creator of message",
2681
  PRIMARY KEY (`message_id`),
2681
  PRIMARY KEY (`message_id`),
2682
  CONSTRAINT `messages_ibfk_1` FOREIGN KEY (`manager_id`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL,
2682
  CONSTRAINT `messages_ibfk_1` FOREIGN KEY (`manager_id`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE SET NULL,
2683
  CONSTRAINT `messages_borrowernumber` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE
2683
  CONSTRAINT `messages_borrowernumber` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE
Lines 2689-2701 CREATE TABLE `messages` ( -- circulation messages left via the patron's check ou Link Here
2689
2689
2690
DROP TABLE IF EXISTS `cash_registers`;
2690
DROP TABLE IF EXISTS `cash_registers`;
2691
CREATE TABLE `cash_registers` (
2691
CREATE TABLE `cash_registers` (
2692
  `id` int(11) NOT NULL auto_increment, -- unique identifier for each account register
2692
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier for each account register",
2693
  `name` varchar(24) NOT NULL, -- the user friendly identifier for each account register
2693
  `name` varchar(24) NOT NULL COMMENT "the user friendly identifier for each account register",
2694
  `description` longtext NOT NULL, -- the user friendly description for each account register
2694
  `description` longtext NOT NULL COMMENT "the user friendly description for each account register",
2695
  `branch` varchar(10) NOT NULL, -- the foreign key the library this account register belongs
2695
  `branch` varchar(10) NOT NULL COMMENT "the foreign key the library this account register belongs",
2696
  `branch_default` tinyint(1) NOT NULL DEFAULT 0, -- boolean flag to denote that this till is the branch default
2696
  `branch_default` tinyint(1) NOT NULL DEFAULT 0 COMMENT "boolean flag to denote that this till is the branch default",
2697
  `starting_float` decimal(28, 6), -- the starting float this account register should be assigned
2697
  `starting_float` decimal(28, 6) COMMENT "the starting float this account register should be assigned",
2698
  `archived` tinyint(1) NOT NULL DEFAULT 0, -- boolean flag to denote if this till is archived or not
2698
  `archived` tinyint(1) NOT NULL DEFAULT 0 COMMENT "boolean flag to denote if this till is archived or not",
2699
  PRIMARY KEY (`id`),
2699
  PRIMARY KEY (`id`),
2700
  UNIQUE KEY `name` (`name`,`branch`),
2700
  UNIQUE KEY `name` (`name`,`branch`),
2701
  CONSTRAINT cash_registers_branch FOREIGN KEY (branch) REFERENCES branches (branchcode) ON UPDATE CASCADE ON DELETE CASCADE
2701
  CONSTRAINT cash_registers_branch FOREIGN KEY (branch) REFERENCES branches (branchcode) ON UPDATE CASCADE ON DELETE CASCADE
Lines 2712-2718 CREATE TABLE `account_credit_types` ( Link Here
2712
  `can_be_added_manually` tinyint(4) NOT NULL DEFAULT 1,
2712
  `can_be_added_manually` tinyint(4) NOT NULL DEFAULT 1,
2713
  `credit_number_enabled` TINYINT(1) NOT NULL DEFAULT 0 COMMENT "Is autogeneration of credit number enabled for this credit type",
2713
  `credit_number_enabled` TINYINT(1) NOT NULL DEFAULT 0 COMMENT "Is autogeneration of credit number enabled for this credit type",
2714
  `is_system` tinyint(1) NOT NULL DEFAULT 0,
2714
  `is_system` tinyint(1) NOT NULL DEFAULT 0,
2715
  `archived` tinyint(1) NOT NULL DEFAULT 0, -- boolean flag to denote if this till is archived or not
2715
  `archived` tinyint(1) NOT NULL DEFAULT 0 COMMENT "boolean flag to denote if this till is archived or not",
2716
  PRIMARY KEY (`code`)
2716
  PRIMARY KEY (`code`)
2717
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2717
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2718
2718
Lines 2736-2746 DROP TABLE IF EXISTS `account_debit_types`; Link Here
2736
CREATE TABLE `account_debit_types` (
2736
CREATE TABLE `account_debit_types` (
2737
  `code` varchar(80) NOT NULL,
2737
  `code` varchar(80) NOT NULL,
2738
  `description` varchar(200) DEFAULT NULL,
2738
  `description` varchar(200) DEFAULT NULL,
2739
  `can_be_invoiced` tinyint(1) NOT NULL DEFAULT 1, -- boolean flag to denote if this debit type is available for manual invoicing
2739
  `can_be_invoiced` tinyint(1) NOT NULL DEFAULT 1 COMMENT "boolean flag to denote if this debit type is available for manual invoicing",
2740
  `can_be_sold` tinyint(1) NOT NULL DEFAULT 0, -- boolean flag to denote if this debit type is available at point of sale
2740
  `can_be_sold` tinyint(1) NOT NULL DEFAULT 0 COMMENT "boolean flag to denote if this debit type is available at point of sale",
2741
  `default_amount` decimal(28,6) DEFAULT NULL,
2741
  `default_amount` decimal(28,6) DEFAULT NULL,
2742
  `is_system` tinyint(1) NOT NULL DEFAULT 0,
2742
  `is_system` tinyint(1) NOT NULL DEFAULT 0,
2743
  `archived` tinyint(1) NOT NULL DEFAULT 0, -- boolean flag to denote if this till is archived or not
2743
  `archived` tinyint(1) NOT NULL DEFAULT 0 COMMENT "boolean flag to denote if this till is archived or not",
2744
  PRIMARY KEY (`code`)
2744
  PRIMARY KEY (`code`)
2745
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2745
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2746
2746
Lines 2773-2786 CREATE TABLE `accountlines` ( Link Here
2773
  `debit_type_code` varchar(80) default NULL,
2773
  `debit_type_code` varchar(80) default NULL,
2774
  `credit_number` varchar(20) NULL DEFAULT NULL COMMENT 'autogenerated number for credits',
2774
  `credit_number` varchar(20) NULL DEFAULT NULL COMMENT 'autogenerated number for credits',
2775
  `status` varchar(16) default NULL,
2775
  `status` varchar(16) default NULL,
2776
  `payment_type` varchar(80) default NULL, -- optional authorised value PAYMENT_TYPE
2776
  `payment_type` varchar(80) default NULL COMMENT "optional authorised value PAYMENT_TYPE",
2777
  `amountoutstanding` decimal(28,6) default NULL,
2777
  `amountoutstanding` decimal(28,6) default NULL,
2778
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
2778
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
2779
  `note` MEDIUMTEXT NULL default NULL,
2779
  `note` MEDIUMTEXT NULL default NULL,
2780
  `manager_id` int(11) NULL DEFAULT NULL,
2780
  `manager_id` int(11) NULL DEFAULT NULL,
2781
  `register_id` int(11) NULL DEFAULT NULL,
2781
  `register_id` int(11) NULL DEFAULT NULL,
2782
  `interface` VARCHAR(16) NOT NULL,
2782
  `interface` VARCHAR(16) NOT NULL,
2783
  `branchcode` VARCHAR( 10 ) NULL DEFAULT NULL, -- the branchcode of the library where a payment was made, a manual invoice created, etc.
2783
  `branchcode` VARCHAR( 10 ) NULL DEFAULT NULL COMMENT "the branchcode of the library where a payment was made, a manual invoice created, etc.",
2784
  PRIMARY KEY (`accountlines_id`),
2784
  PRIMARY KEY (`accountlines_id`),
2785
  KEY `acctsborridx` (`borrowernumber`),
2785
  KEY `acctsborridx` (`borrowernumber`),
2786
  KEY `timeidx` (`timestamp`),
2786
  KEY `timeidx` (`timestamp`),
Lines 2804-2810 CREATE TABLE `accountlines` ( Link Here
2804
2804
2805
DROP TABLE IF EXISTS `account_offset_types`;
2805
DROP TABLE IF EXISTS `account_offset_types`;
2806
CREATE TABLE `account_offset_types` (
2806
CREATE TABLE `account_offset_types` (
2807
  `type` varchar(16) NOT NULL, -- The type of offset this is
2807
  `type` varchar(16) NOT NULL COMMENT "The type of offset this is",
2808
  PRIMARY KEY (`type`)
2808
  PRIMARY KEY (`type`)
2809
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2809
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2810
2810
Lines 2814-2824 CREATE TABLE `account_offset_types` ( Link Here
2814
2814
2815
DROP TABLE IF EXISTS `account_offsets`;
2815
DROP TABLE IF EXISTS `account_offsets`;
2816
CREATE TABLE `account_offsets` (
2816
CREATE TABLE `account_offsets` (
2817
  `id` int(11) NOT NULL auto_increment, -- unique identifier for each offset
2817
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier for each offset",
2818
  `credit_id` int(11) NULL DEFAULT NULL, -- The id of the accountline the increased the patron's balance
2818
  `credit_id` int(11) NULL DEFAULT NULL COMMENT "The id of the accountline the increased the patron's balance",
2819
  `debit_id` int(11) NULL DEFAULT NULL, -- The id of the accountline that decreased the patron's balance
2819
  `debit_id` int(11) NULL DEFAULT NULL COMMENT "The id of the accountline that decreased the patron's balance",
2820
  `type` varchar(16) NOT NULL, -- The type of offset this is
2820
  `type` varchar(16) NOT NULL COMMENT "The type of offset this is",
2821
  `amount` decimal(26,6) NOT NULL, -- The amount of the change
2821
  `amount` decimal(26,6) NOT NULL COMMENT "The amount of the change",
2822
  `created_on` timestamp NOT NULL default CURRENT_TIMESTAMP,
2822
  `created_on` timestamp NOT NULL default CURRENT_TIMESTAMP,
2823
  PRIMARY KEY (`id`),
2823
  PRIMARY KEY (`id`),
2824
  CONSTRAINT `account_offsets_ibfk_p` FOREIGN KEY (`credit_id`) REFERENCES `accountlines` (`accountlines_id`) ON DELETE CASCADE ON UPDATE CASCADE,
2824
  CONSTRAINT `account_offsets_ibfk_p` FOREIGN KEY (`credit_id`) REFERENCES `accountlines` (`accountlines_id`) ON DELETE CASCADE ON UPDATE CASCADE,
Lines 2832-2842 CREATE TABLE `account_offsets` ( Link Here
2832
2832
2833
DROP TABLE IF EXISTS `cash_register_actions`;
2833
DROP TABLE IF EXISTS `cash_register_actions`;
2834
CREATE TABLE `cash_register_actions` (
2834
CREATE TABLE `cash_register_actions` (
2835
  `id` int(11) NOT NULL auto_increment, -- unique identifier for each account register action
2835
  `id` int(11) NOT NULL auto_increment COMMENT "unique identifier for each account register action",
2836
  `code` varchar(24) NOT NULL, -- action code denoting the type of action recorded (enum),
2836
  `code` varchar(24) NOT NULL COMMENT "action code denoting the type of action recorded (enum),",
2837
  `register_id` int(11) NOT NULL, -- id of cash_register this action belongs to,
2837
  `register_id` int(11) NOT NULL COMMENT "id of cash_register this action belongs to,",
2838
  `manager_id` int(11) NOT NULL, -- staff member performing the action
2838
  `manager_id` int(11) NOT NULL COMMENT "staff member performing the action",
2839
  `amount` decimal(28,6) DEFAULT NULL, -- amount recorded in action (signed)
2839
  `amount` decimal(28,6) DEFAULT NULL COMMENT "amount recorded in action (signed)",
2840
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
2840
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
2841
  PRIMARY KEY (`id`),
2841
  PRIMARY KEY (`id`),
2842
  CONSTRAINT `cash_register_actions_manager` FOREIGN KEY (`manager_id`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE,
2842
  CONSTRAINT `cash_register_actions_manager` FOREIGN KEY (`manager_id`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE,
Lines 2849-2862 CREATE TABLE `cash_register_actions` ( Link Here
2849
2849
2850
DROP TABLE IF EXISTS `action_logs`;
2850
DROP TABLE IF EXISTS `action_logs`;
2851
CREATE TABLE `action_logs` ( -- logs of actions taken in Koha (requires that the logs be turned on)
2851
CREATE TABLE `action_logs` ( -- logs of actions taken in Koha (requires that the logs be turned on)
2852
  `action_id` int(11) NOT NULL auto_increment, -- unique identifier for each action
2852
  `action_id` int(11) NOT NULL auto_increment COMMENT "unique identifier for each action",
2853
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP, -- the date and time the action took place
2853
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP COMMENT "the date and time the action took place",
2854
  `user` int(11) NOT NULL default 0, -- the staff member who performed the action (borrowers.borrowernumber)
2854
  `user` int(11) NOT NULL default 0 COMMENT "the staff member who performed the action (borrowers.borrowernumber)",
2855
  `module` MEDIUMTEXT, -- the module this action was taken against
2855
  `module` MEDIUMTEXT COMMENT "the module this action was taken against",
2856
  `action` MEDIUMTEXT, -- the action (includes things like DELETED, ADDED, MODIFY, etc)
2856
  `action` MEDIUMTEXT COMMENT "the action (includes things like DELETED, ADDED, MODIFY, etc)",
2857
  `object` int(11) default NULL, -- the object that the action was taken against (could be a borrowernumber, itemnumber, etc)
2857
  `object` int(11) default NULL COMMENT "the object that the action was taken against (could be a borrowernumber, itemnumber, etc)",
2858
  `info` MEDIUMTEXT, -- information about the action (usually includes SQL statement)
2858
  `info` MEDIUMTEXT COMMENT "information about the action (usually includes SQL statement)",
2859
  `interface` VARCHAR(30) DEFAULT NULL, -- the context this action was taken in
2859
  `interface` VARCHAR(30) DEFAULT NULL COMMENT "the context this action was taken in",
2860
  PRIMARY KEY (`action_id`),
2860
  PRIMARY KEY (`action_id`),
2861
  KEY `timestamp_idx` (`timestamp`),
2861
  KEY `timestamp_idx` (`timestamp`),
2862
  KEY `user_idx` (`user`),
2862
  KEY `user_idx` (`user`),
Lines 2889-2915 CREATE TABLE `alert` ( Link Here
2889
2889
2890
DROP TABLE IF EXISTS `aqbooksellers`;
2890
DROP TABLE IF EXISTS `aqbooksellers`;
2891
CREATE TABLE `aqbooksellers` ( -- information about the vendors listed in acquisitions
2891
CREATE TABLE `aqbooksellers` ( -- information about the vendors listed in acquisitions
2892
  `id` int(11) NOT NULL auto_increment, -- primary key and unique identifier assigned by Koha
2892
  `id` int(11) NOT NULL auto_increment COMMENT "primary key and unique identifier assigned by Koha",
2893
  `name` LONGTEXT NOT NULL, -- vendor name
2893
  `name` LONGTEXT NOT NULL COMMENT "vendor name",
2894
  `address1` LONGTEXT, -- first line of vendor physical address
2894
  `address1` LONGTEXT COMMENT "first line of vendor physical address",
2895
  `address2` LONGTEXT, -- second line of vendor physical address
2895
  `address2` LONGTEXT COMMENT "second line of vendor physical address",
2896
  `address3` LONGTEXT, -- third line of vendor physical address
2896
  `address3` LONGTEXT COMMENT "third line of vendor physical address",
2897
  `address4` LONGTEXT, -- fourth line of vendor physical address
2897
  `address4` LONGTEXT COMMENT "fourth line of vendor physical address",
2898
  `phone` varchar(30) default NULL, -- vendor phone number
2898
  `phone` varchar(30) default NULL COMMENT "vendor phone number",
2899
  `accountnumber` LONGTEXT, -- vendor account number
2899
  `accountnumber` LONGTEXT COMMENT "vendor account number",
2900
  `notes` LONGTEXT, -- order notes
2900
  `notes` LONGTEXT COMMENT "order notes",
2901
  `postal` LONGTEXT, -- vendor postal address (all lines)
2901
  `postal` LONGTEXT COMMENT "vendor postal address (all lines)",
2902
  `url` varchar(255) default NULL, -- vendor web address
2902
  `url` varchar(255) default NULL COMMENT "vendor web address",
2903
  `active` tinyint(4) default NULL, -- is this vendor active (1 for yes, 0 for no)
2903
  `active` tinyint(4) default NULL COMMENT "is this vendor active (1 for yes, 0 for no)",
2904
  `listprice` varchar(10) default NULL, -- currency code for list prices
2904
  `listprice` varchar(10) default NULL COMMENT "currency code for list prices",
2905
  `invoiceprice` varchar(10) default NULL, -- currency code for invoice prices
2905
  `invoiceprice` varchar(10) default NULL COMMENT "currency code for invoice prices",
2906
  `gstreg` tinyint(4) default NULL, -- is your library charged tax (1 for yes, 0 for no)
2906
  `gstreg` tinyint(4) default NULL COMMENT "is your library charged tax (1 for yes, 0 for no)",
2907
  `listincgst` tinyint(4) default NULL, -- is tax included in list prices (1 for yes, 0 for no)
2907
  `listincgst` tinyint(4) default NULL COMMENT "is tax included in list prices (1 for yes, 0 for no)",
2908
  `invoiceincgst` tinyint(4) default NULL, -- is tax included in invoice prices (1 for yes, 0 for no)
2908
  `invoiceincgst` tinyint(4) default NULL COMMENT "is tax included in invoice prices (1 for yes, 0 for no)",
2909
  `tax_rate` decimal(6,4) default NULL, -- the tax rate the library is charged
2909
  `tax_rate` decimal(6,4) default NULL COMMENT "the tax rate the library is charged",
2910
  `discount` float(6,4) default NULL, -- discount offered on all items ordered from this vendor
2910
  `discount` float(6,4) default NULL COMMENT "discount offered on all items ordered from this vendor",
2911
  `fax` varchar(50) default NULL, -- vendor fax number
2911
  `fax` varchar(50) default NULL COMMENT "vendor fax number",
2912
  deliverytime int(11) default NULL, -- vendor delivery time
2912
  deliverytime int(11) default NULL COMMENT "vendor delivery time",
2913
  PRIMARY KEY  (`id`),
2913
  PRIMARY KEY  (`id`),
2914
  KEY `listprice` (`listprice`),
2914
  KEY `listprice` (`listprice`),
2915
  KEY `invoiceprice` (`invoiceprice`),
2915
  KEY `invoiceprice` (`invoiceprice`),
Lines 2943-2957 CREATE TABLE `aqbasketgroups` ( Link Here
2943
2943
2944
DROP TABLE IF EXISTS `aqbudgetperiods`;
2944
DROP TABLE IF EXISTS `aqbudgetperiods`;
2945
CREATE TABLE `aqbudgetperiods` ( -- information related to Budgets
2945
CREATE TABLE `aqbudgetperiods` ( -- information related to Budgets
2946
  `budget_period_id` int(11) NOT NULL auto_increment, -- primary key and unique number assigned by Koha
2946
  `budget_period_id` int(11) NOT NULL auto_increment COMMENT "primary key and unique number assigned by Koha",
2947
  `budget_period_startdate` date NOT NULL, -- date when the budget starts
2947
  `budget_period_startdate` date NOT NULL COMMENT "date when the budget starts",
2948
  `budget_period_enddate` date NOT NULL, -- date when the budget ends
2948
  `budget_period_enddate` date NOT NULL COMMENT "date when the budget ends",
2949
  `budget_period_active` tinyint(1) default '0', -- whether this budget is active or not (1 for yes, 0 for no)
2949
  `budget_period_active` tinyint(1) default '0' COMMENT "whether this budget is active or not (1 for yes, 0 for no)",
2950
  `budget_period_description` LONGTEXT, -- description assigned to this budget
2950
  `budget_period_description` LONGTEXT COMMENT "description assigned to this budget",
2951
  `budget_period_total` decimal(28,6), -- total amount available in this budget
2951
  `budget_period_total` decimal(28,6) COMMENT "total amount available in this budget",
2952
  `budget_period_locked` tinyint(1) default NULL, -- whether this budget is locked or not (1 for yes, 0 for no)
2952
  `budget_period_locked` tinyint(1) default NULL COMMENT "whether this budget is locked or not (1 for yes, 0 for no)",
2953
  `sort1_authcat` varchar(10) default NULL, -- statistical category for this budget
2953
  `sort1_authcat` varchar(10) default NULL COMMENT "statistical category for this budget",
2954
  `sort2_authcat` varchar(10) default NULL, -- second statistical category for this budget
2954
  `sort2_authcat` varchar(10) default NULL COMMENT "second statistical category for this budget",
2955
  PRIMARY KEY  (`budget_period_id`)
2955
  PRIMARY KEY  (`budget_period_id`)
2956
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2956
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
2957
2957
Lines 2961-2981 CREATE TABLE `aqbudgetperiods` ( -- information related to Budgets Link Here
2961
2961
2962
DROP TABLE IF EXISTS `aqbudgets`;
2962
DROP TABLE IF EXISTS `aqbudgets`;
2963
CREATE TABLE `aqbudgets` ( -- information related to Funds
2963
CREATE TABLE `aqbudgets` ( -- information related to Funds
2964
  `budget_id` int(11) NOT NULL auto_increment, -- primary key and unique number assigned to each fund by Koha
2964
  `budget_id` int(11) NOT NULL auto_increment COMMENT "primary key and unique number assigned to each fund by Koha",
2965
  `budget_parent_id` int(11) default NULL, -- if this fund is a child of another this will include the parent id (aqbudgets.budget_id)
2965
  `budget_parent_id` int(11) default NULL COMMENT "if this fund is a child of another this will include the parent id (aqbudgets.budget_id)",
2966
  `budget_code` varchar(30) default NULL, -- code assigned to the fund by the user
2966
  `budget_code` varchar(30) default NULL COMMENT "code assigned to the fund by the user",
2967
  `budget_name` varchar(80) default NULL, -- name assigned to the fund by the user
2967
  `budget_name` varchar(80) default NULL COMMENT "name assigned to the fund by the user",
2968
  `budget_branchcode` varchar(10) default NULL, -- branch that this fund belongs to (branches.branchcode)
2968
  `budget_branchcode` varchar(10) default NULL COMMENT "branch that this fund belongs to (branches.branchcode)",
2969
  `budget_amount` decimal(28,6) NULL default '0.00', -- total amount for this fund
2969
  `budget_amount` decimal(28,6) NULL default '0.00' COMMENT "total amount for this fund",
2970
  `budget_encumb` decimal(28,6) NULL default '0.00', -- budget warning at percentage
2970
  `budget_encumb` decimal(28,6) NULL default '0.00' COMMENT "budget warning at percentage",
2971
  `budget_expend` decimal(28,6) NULL default '0.00', -- budget warning at amount
2971
  `budget_expend` decimal(28,6) NULL default '0.00' COMMENT "budget warning at amount",
2972
  `budget_notes` LONGTEXT, -- notes related to this fund
2972
  `budget_notes` LONGTEXT COMMENT "notes related to this fund",
2973
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- date and time this fund was last touched (created or modified)
2973
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time this fund was last touched (created or modified)",
2974
  `budget_period_id` int(11) default NULL, -- id of the budget that this fund belongs to (aqbudgetperiods.budget_period_id)
2974
  `budget_period_id` int(11) default NULL COMMENT "id of the budget that this fund belongs to (aqbudgetperiods.budget_period_id)",
2975
  `sort1_authcat` varchar(80) default NULL, -- statistical category for this fund
2975
  `sort1_authcat` varchar(80) default NULL COMMENT "statistical category for this fund",
2976
  `sort2_authcat` varchar(80) default NULL, -- second statistical category for this fund
2976
  `sort2_authcat` varchar(80) default NULL COMMENT "second statistical category for this fund",
2977
  `budget_owner_id` int(11) default NULL, -- borrowernumber of the person who owns this fund (borrowers.borrowernumber)
2977
  `budget_owner_id` int(11) default NULL COMMENT "borrowernumber of the person who owns this fund (borrowers.borrowernumber)",
2978
  `budget_permission` int(1) default '0', -- level of permission for this fund (used only by the owner, only by the library, or anyone)
2978
  `budget_permission` int(1) default '0' COMMENT "level of permission for this fund (used only by the owner, only by the library, or anyone)",
2979
  PRIMARY KEY  (`budget_id`),
2979
  PRIMARY KEY  (`budget_id`),
2980
  KEY `budget_parent_id` (`budget_parent_id`),
2980
  KEY `budget_parent_id` (`budget_parent_id`),
2981
  KEY `budget_code` (`budget_code`),
2981
  KEY `budget_code` (`budget_code`),
Lines 3026-3044 CREATE TABLE `aqbudgets_planning` ( Link Here
3026
3026
3027
DROP TABLE IF EXISTS aqcontacts;
3027
DROP TABLE IF EXISTS aqcontacts;
3028
CREATE TABLE aqcontacts (
3028
CREATE TABLE aqcontacts (
3029
  id int(11) NOT NULL auto_increment, -- primary key and unique number assigned by Koha
3029
  id int(11) NOT NULL auto_increment COMMENT "primary key and unique number assigned by Koha",
3030
  name varchar(100) default NULL, -- name of contact at vendor
3030
  name varchar(100) default NULL COMMENT "name of contact at vendor",
3031
  position varchar(100) default NULL, -- contact person's position
3031
  position varchar(100) default NULL COMMENT "contact person's position",
3032
  phone varchar(100) default NULL, -- contact's phone number
3032
  phone varchar(100) default NULL COMMENT "contact's phone number",
3033
  altphone varchar(100) default NULL, -- contact's alternate phone number
3033
  altphone varchar(100) default NULL COMMENT "contact's alternate phone number",
3034
  fax varchar(100) default NULL,  -- contact's fax number
3034
  fax varchar(100) default NULL COMMENT "contact's fax number",
3035
  email varchar(100) default NULL, -- contact's email address
3035
  email varchar(100) default NULL COMMENT "contact's email address",
3036
  notes LONGTEXT, -- notes related to the contact
3036
  notes LONGTEXT COMMENT "notes related to the contact",
3037
  orderacquisition tinyint(1) NOT NULL DEFAULT 0, -- should this contact receive acquisition orders
3037
  orderacquisition tinyint(1) NOT NULL DEFAULT 0 COMMENT "should this contact receive acquisition orders",
3038
  claimacquisition tinyint(1) NOT NULL DEFAULT 0, -- should this contact receive acquisitions claims
3038
  claimacquisition tinyint(1) NOT NULL DEFAULT 0 COMMENT "should this contact receive acquisitions claims",
3039
  claimissues tinyint(1) NOT NULL DEFAULT 0, -- should this contact receive serial claims
3039
  claimissues tinyint(1) NOT NULL DEFAULT 0 COMMENT "should this contact receive serial claims",
3040
  acqprimary tinyint(1) NOT NULL DEFAULT 0, -- is this the primary contact for acquisitions messages
3040
  acqprimary tinyint(1) NOT NULL DEFAULT 0 COMMENT "is this the primary contact for acquisitions messages",
3041
  serialsprimary tinyint(1) NOT NULL DEFAULT 0, -- is this the primary contact for serials messages
3041
  serialsprimary tinyint(1) NOT NULL DEFAULT 0 COMMENT "is this the primary contact for serials messages",
3042
  booksellerid int(11) not NULL,
3042
  booksellerid int(11) not NULL,
3043
  PRIMARY KEY  (id),
3043
  PRIMARY KEY  (id),
3044
  CONSTRAINT booksellerid_aqcontacts_fk FOREIGN KEY (booksellerid)
3044
  CONSTRAINT booksellerid_aqcontacts_fk FOREIGN KEY (booksellerid)
Lines 3068-3089 CREATE TABLE `aqcontract` ( Link Here
3068
3068
3069
DROP TABLE IF EXISTS `aqbasket`;
3069
DROP TABLE IF EXISTS `aqbasket`;
3070
CREATE TABLE `aqbasket` ( -- stores data about baskets in acquisitions
3070
CREATE TABLE `aqbasket` ( -- stores data about baskets in acquisitions
3071
  `basketno` int(11) NOT NULL auto_increment, -- primary key, Koha defined number
3071
  `basketno` int(11) NOT NULL auto_increment COMMENT "primary key, Koha defined number",
3072
  `basketname` varchar(50) default NULL, -- name given to the basket at creation
3072
  `basketname` varchar(50) default NULL COMMENT "name given to the basket at creation",
3073
  `note` LONGTEXT, -- the internal note added at basket creation
3073
  `note` LONGTEXT COMMENT "the internal note added at basket creation",
3074
  `booksellernote` LONGTEXT, -- the vendor note added at basket creation
3074
  `booksellernote` LONGTEXT COMMENT "the vendor note added at basket creation",
3075
  `contractnumber` int(11), -- links this basket to the aqcontract table (aqcontract.contractnumber)
3075
  `contractnumber` int(11) COMMENT "links this basket to the aqcontract table (aqcontract.contractnumber)",
3076
  `creationdate` date default NULL, -- the date the basket was created
3076
  `creationdate` date default NULL COMMENT "the date the basket was created",
3077
  `closedate` date default NULL, -- the date the basket was closed
3077
  `closedate` date default NULL COMMENT "the date the basket was closed",
3078
  `booksellerid` int(11) NOT NULL default 1, -- the Koha assigned ID for the vendor (aqbooksellers.id)
3078
  `booksellerid` int(11) NOT NULL default 1 COMMENT "the Koha assigned ID for the vendor (aqbooksellers.id)",
3079
  `authorisedby` varchar(10) default NULL, -- the borrowernumber of the person who created the basket
3079
  `authorisedby` varchar(10) default NULL COMMENT "the borrowernumber of the person who created the basket",
3080
  `booksellerinvoicenumber` LONGTEXT, -- appears to always be NULL
3080
  `booksellerinvoicenumber` LONGTEXT COMMENT "appears to always be NULL",
3081
  `basketgroupid` int(11), -- links this basket to its group (aqbasketgroups.id)
3081
  `basketgroupid` int(11) COMMENT "links this basket to its group (aqbasketgroups.id)",
3082
  `deliveryplace` varchar(10) default NULL, -- basket delivery place
3082
  `deliveryplace` varchar(10) default NULL COMMENT "basket delivery place",
3083
  `billingplace` varchar(10) default NULL, -- basket billing place
3083
  `billingplace` varchar(10) default NULL COMMENT "basket billing place",
3084
  branch varchar(10) default NULL, -- basket branch
3084
  branch varchar(10) default NULL COMMENT "basket branch",
3085
  is_standing TINYINT(1) NOT NULL DEFAULT 0, -- orders in this basket are standing
3085
  is_standing TINYINT(1) NOT NULL DEFAULT 0 COMMENT "orders in this basket are standing",
3086
  create_items ENUM('ordering', 'receiving', 'cataloguing') default NULL, -- when items should be created for orders in this basket
3086
  create_items ENUM('ordering', 'receiving', 'cataloguing') default NULL COMMENT "when items should be created for orders in this basket",
3087
  PRIMARY KEY  (`basketno`),
3087
  PRIMARY KEY  (`basketno`),
3088
  KEY `booksellerid` (`booksellerid`),
3088
  KEY `booksellerid` (`booksellerid`),
3089
  KEY `basketgroupid` (`basketgroupid`),
3089
  KEY `basketgroupid` (`basketgroupid`),
Lines 3114-3153 CREATE TABLE aqbasketusers ( Link Here
3114
3114
3115
DROP TABLE IF EXISTS `suggestions`;
3115
DROP TABLE IF EXISTS `suggestions`;
3116
CREATE TABLE `suggestions` ( -- purchase suggestions
3116
CREATE TABLE `suggestions` ( -- purchase suggestions
3117
  `suggestionid` int(8) NOT NULL auto_increment, -- unique identifier assigned automatically by Koha
3117
  `suggestionid` int(8) NOT NULL auto_increment COMMENT "unique identifier assigned automatically by Koha",
3118
  `suggestedby` int(11) DEFAULT NULL, -- borrowernumber for the person making the suggestion, foreign key linking to the borrowers table
3118
  `suggestedby` int(11) DEFAULT NULL COMMENT "borrowernumber for the person making the suggestion, foreign key linking to the borrowers table",
3119
  `suggesteddate` date NOT NULL, -- date the suggestion was submitted
3119
  `suggesteddate` date NOT NULL COMMENT "date the suggestion was submitted",
3120
  `managedby` int(11) default NULL, -- borrowernumber for the librarian managing the suggestion, foreign key linking to the borrowers table
3120
  `managedby` int(11) default NULL COMMENT "borrowernumber for the librarian managing the suggestion, foreign key linking to the borrowers table",
3121
  `manageddate` date default NULL, -- date the suggestion was updated
3121
  `manageddate` date default NULL COMMENT "date the suggestion was updated",
3122
   acceptedby INT(11) default NULL, -- borrowernumber for the librarian who accepted the suggestion, foreign key linking to the borrowers table
3122
   acceptedby INT(11) default NULL COMMENT "borrowernumber for the librarian who accepted the suggestion, foreign key linking to the borrowers table",
3123
   accepteddate date default NULL, -- date the suggestion was marked as accepted
3123
   accepteddate date default NULL COMMENT "date the suggestion was marked as accepted",
3124
   rejectedby INT(11) default NULL, -- borrowernumber for the librarian who rejected the suggestion, foreign key linking to the borrowers table
3124
   rejectedby INT(11) default NULL COMMENT "borrowernumber for the librarian who rejected the suggestion, foreign key linking to the borrowers table",
3125
   rejecteddate date default NULL, -- date the suggestion was marked as rejected
3125
   rejecteddate date default NULL COMMENT "date the suggestion was marked as rejected",
3126
   lastmodificationby INT(11) default NULL, -- borrowernumber for the librarian who edit the suggestion for the last time
3126
   lastmodificationby INT(11) default NULL COMMENT "borrowernumber for the librarian who edit the suggestion for the last time",
3127
   lastmodificationdate date default NULL, -- date of the last modification
3127
   lastmodificationdate date default NULL COMMENT "date of the last modification",
3128
  `STATUS` varchar(10) NOT NULL default '', -- suggestion status (ASKED, CHECKED, ACCEPTED, REJECTED, ORDERED, AVAILABLE or a value from the SUGGEST_STATUS authorised value category)
3128
  `STATUS` varchar(10) NOT NULL default '' COMMENT "suggestion status (ASKED, CHECKED, ACCEPTED, REJECTED, ORDERED, AVAILABLE or a value from the SUGGEST_STATUS authorised value category)",
3129
  `archived` TINYINT(1) NOT NULL DEFAULT 0, -- is the suggestion archived?
3129
  `archived` TINYINT(1) NOT NULL DEFAULT 0 COMMENT "is the suggestion archived?",
3130
  `note` LONGTEXT, -- note entered on the suggestion
3130
  `note` LONGTEXT COMMENT "note entered on the suggestion",
3131
  `author` varchar(80) default NULL, -- author of the suggested item
3131
  `author` varchar(80) default NULL COMMENT "author of the suggested item",
3132
  `title` varchar(255) default NULL, -- title of the suggested item
3132
  `title` varchar(255) default NULL COMMENT "title of the suggested item",
3133
  `copyrightdate` smallint(6) default NULL, -- copyright date of the suggested item
3133
  `copyrightdate` smallint(6) default NULL COMMENT "copyright date of the suggested item",
3134
  `publishercode` varchar(255) default NULL, -- publisher of the suggested item
3134
  `publishercode` varchar(255) default NULL COMMENT "publisher of the suggested item",
3135
  `date` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,  -- date and time the suggestion was updated
3135
  `date` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "date and time the suggestion was updated",
3136
  `volumedesc` varchar(255) default NULL,
3136
  `volumedesc` varchar(255) default NULL,
3137
  `publicationyear` smallint(6) default 0,
3137
  `publicationyear` smallint(6) default 0,
3138
  `place` varchar(255) default NULL, -- publication place of the suggested item
3138
  `place` varchar(255) default NULL COMMENT "publication place of the suggested item",
3139
  `isbn` varchar(30) default NULL, -- isbn of the suggested item
3139
  `isbn` varchar(30) default NULL COMMENT "isbn of the suggested item",
3140
  `biblionumber` int(11) default NULL, -- foreign key linking the suggestion to the biblio table after the suggestion has been ordered
3140
  `biblionumber` int(11) default NULL COMMENT "foreign key linking the suggestion to the biblio table after the suggestion has been ordered",
3141
  `reason` MEDIUMTEXT, -- reason for accepting or rejecting the suggestion
3141
  `reason` MEDIUMTEXT COMMENT "reason for accepting or rejecting the suggestion",
3142
  `patronreason` MEDIUMTEXT, -- reason for making the suggestion
3142
  `patronreason` MEDIUMTEXT COMMENT "reason for making the suggestion",
3143
   budgetid INT(11), -- foreign key linking the suggested budget to the aqbudgets table
3143
   budgetid INT(11) COMMENT "foreign key linking the suggested budget to the aqbudgets table",
3144
   branchcode VARCHAR(10) default NULL, -- foreign key linking the suggested branch to the branches table
3144
   branchcode VARCHAR(10) default NULL COMMENT "foreign key linking the suggested branch to the branches table",
3145
   collectiontitle MEDIUMTEXT default NULL, -- collection name for the suggested item
3145
   collectiontitle MEDIUMTEXT default NULL COMMENT "collection name for the suggested item",
3146
   itemtype VARCHAR(30) default NULL, -- suggested item type
3146
   itemtype VARCHAR(30) default NULL COMMENT "suggested item type",
3147
   quantity SMALLINT(6) default NULL, -- suggested quantity to be purchased
3147
   quantity SMALLINT(6) default NULL COMMENT "suggested quantity to be purchased",
3148
   currency VARCHAR(10) default NULL, -- suggested currency for the suggested price
3148
   currency VARCHAR(10) default NULL COMMENT "suggested currency for the suggested price",
3149
   price DECIMAL(28,6) default NULL, -- suggested price
3149
   price DECIMAL(28,6) default NULL COMMENT "suggested price",
3150
   total DECIMAL(28,6) default NULL, -- suggested total cost (price*quantity updated for currency)
3150
   total DECIMAL(28,6) default NULL COMMENT "suggested total cost (price*quantity updated for currency)",
3151
  PRIMARY KEY  (`suggestionid`),
3151
  PRIMARY KEY  (`suggestionid`),
3152
  KEY `suggestedby` (`suggestedby`),
3152
  KEY `suggestedby` (`suggestedby`),
3153
  KEY `managedby` (`managedby`),
3153
  KEY `managedby` (`managedby`),
Lines 3230-3244 CREATE TABLE IF NOT EXISTS edifact_messages ( Link Here
3230
3230
3231
DROP TABLE IF EXISTS aqinvoices;
3231
DROP TABLE IF EXISTS aqinvoices;
3232
CREATE TABLE aqinvoices (
3232
CREATE TABLE aqinvoices (
3233
  invoiceid int(11) NOT NULL AUTO_INCREMENT,    -- ID of the invoice, primary key
3233
  invoiceid int(11) NOT NULL AUTO_INCREMENT COMMENT "ID of the invoice, primary key",
3234
  invoicenumber LONGTEXT NOT NULL,    -- Name of invoice
3234
  invoicenumber LONGTEXT NOT NULL COMMENT "Name of invoice",
3235
  booksellerid int(11) NOT NULL,    -- foreign key to aqbooksellers
3235
  booksellerid int(11) NOT NULL COMMENT "foreign key to aqbooksellers",
3236
  shipmentdate date default NULL,   -- date of shipment
3236
  shipmentdate date default NULL COMMENT "date of shipment",
3237
  billingdate date default NULL,    -- date of billing
3237
  billingdate date default NULL COMMENT "date of billing",
3238
  closedate date default NULL,  -- invoice close date, NULL means the invoice is open
3238
  closedate date default NULL COMMENT "invoice close date, NULL means the invoice is open",
3239
  shipmentcost decimal(28,6) default NULL,  -- shipment cost
3239
  shipmentcost decimal(28,6) default NULL COMMENT "shipment cost",
3240
  shipmentcost_budgetid int(11) default NULL,   -- foreign key to aqbudgets, link the shipment cost to a budget
3240
  shipmentcost_budgetid int(11) default NULL COMMENT "foreign key to aqbudgets, link the shipment cost to a budget",
3241
  message_id int(11) default NULL, -- foreign key to edifact invoice message
3241
  message_id int(11) default NULL COMMENT "foreign key to edifact invoice message",
3242
  PRIMARY KEY (invoiceid),
3242
  PRIMARY KEY (invoiceid),
3243
  CONSTRAINT aqinvoices_fk_aqbooksellerid FOREIGN KEY (booksellerid) REFERENCES aqbooksellers (id) ON DELETE CASCADE ON UPDATE CASCADE,
3243
  CONSTRAINT aqinvoices_fk_aqbooksellerid FOREIGN KEY (booksellerid) REFERENCES aqbooksellers (id) ON DELETE CASCADE ON UPDATE CASCADE,
3244
  CONSTRAINT edifact_msg_fk FOREIGN KEY ( message_id ) REFERENCES edifact_messages ( id ) ON DELETE SET NULL,
3244
  CONSTRAINT edifact_msg_fk FOREIGN KEY ( message_id ) REFERENCES edifact_messages ( id ) ON DELETE SET NULL,
Lines 3251-3264 CREATE TABLE aqinvoices ( Link Here
3251
3251
3252
DROP TABLE IF EXISTS aqinvoice_adjustments;
3252
DROP TABLE IF EXISTS aqinvoice_adjustments;
3253
CREATE TABLE aqinvoice_adjustments (
3253
CREATE TABLE aqinvoice_adjustments (
3254
    adjustment_id int(11) NOT NULL AUTO_INCREMENT, -- primary key for adjustments
3254
    adjustment_id int(11) NOT NULL AUTO_INCREMENT COMMENT "primary key for adjustments",
3255
    invoiceid int(11) NOT NULL, -- foreign key to link an adjustment to an invoice
3255
    invoiceid int(11) NOT NULL COMMENT "foreign key to link an adjustment to an invoice",
3256
    adjustment decimal(28,6), -- amount of adjustment
3256
    adjustment decimal(28,6) COMMENT "amount of adjustment",
3257
    reason varchar(80) default NULL, -- reason for adjustment defined by authorised values in ADJ_REASON category
3257
    reason varchar(80) default NULL COMMENT "reason for adjustment defined by authorised values in ADJ_REASON category",
3258
    note mediumtext default NULL, -- text to explain adjustment
3258
    note mediumtext default NULL COMMENT "text to explain adjustment",
3259
    budget_id int(11) default NULL, -- optional link to budget to apply adjustment to
3259
    budget_id int(11) default NULL COMMENT "optional link to budget to apply adjustment to",
3260
    encumber_open smallint(1) NOT NULL default 1, -- whether or not to encumber the funds when invoice is still open, 1 = yes, 0 = no
3260
    encumber_open smallint(1) NOT NULL default 1 COMMENT "whether or not to encumber the funds when invoice is still open, 1 = yes, 0 = no",
3261
    timestamp timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- timestamp  of last adjustment to adjustment
3261
    timestamp timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "timestamp  of last adjustment to adjustment",
3262
    PRIMARY KEY (adjustment_id),
3262
    PRIMARY KEY (adjustment_id),
3263
    CONSTRAINT aqinvoice_adjustments_fk_invoiceid FOREIGN KEY (invoiceid) REFERENCES aqinvoices (invoiceid) ON DELETE CASCADE ON UPDATE CASCADE,
3263
    CONSTRAINT aqinvoice_adjustments_fk_invoiceid FOREIGN KEY (invoiceid) REFERENCES aqinvoices (invoiceid) ON DELETE CASCADE ON UPDATE CASCADE,
3264
    CONSTRAINT aqinvoice_adjustments_fk_budget_id FOREIGN KEY (budget_id) REFERENCES aqbudgets (budget_id) ON DELETE SET NULL ON UPDATE CASCADE
3264
    CONSTRAINT aqinvoice_adjustments_fk_budget_id FOREIGN KEY (budget_id) REFERENCES aqbudgets (budget_id) ON DELETE SET NULL ON UPDATE CASCADE
Lines 3270-3324 CREATE TABLE aqinvoice_adjustments ( Link Here
3270
3270
3271
DROP TABLE IF EXISTS `aqorders`;
3271
DROP TABLE IF EXISTS `aqorders`;
3272
CREATE TABLE `aqorders` ( -- information related to the basket line items
3272
CREATE TABLE `aqorders` ( -- information related to the basket line items
3273
  `ordernumber` int(11) NOT NULL auto_increment, -- primary key and unique identifier assigned by Koha to each line
3273
  `ordernumber` int(11) NOT NULL auto_increment COMMENT "primary key and unique identifier assigned by Koha to each line",
3274
  `biblionumber` int(11) default NULL, -- links the order to the biblio being ordered (biblio.biblionumber)
3274
  `biblionumber` int(11) default NULL COMMENT "links the order to the biblio being ordered (biblio.biblionumber)",
3275
  `entrydate` date default NULL, -- the date the bib was added to the basket
3275
  `entrydate` date default NULL COMMENT "the date the bib was added to the basket",
3276
  `quantity` smallint(6) default NULL, -- the quantity ordered
3276
  `quantity` smallint(6) default NULL COMMENT "the quantity ordered",
3277
  `currency` varchar(10) default NULL, -- the currency used for the purchase
3277
  `currency` varchar(10) default NULL COMMENT "the currency used for the purchase",
3278
  `listprice` decimal(28,6) default NULL, -- the vendor price for this line item
3278
  `listprice` decimal(28,6) default NULL COMMENT "the vendor price for this line item",
3279
  `datereceived` date default NULL, -- the date this order was received
3279
  `datereceived` date default NULL COMMENT "the date this order was received",
3280
  invoiceid int(11) default NULL, -- id of invoice
3280
  invoiceid int(11) default NULL COMMENT "id of invoice",
3281
  `freight` decimal(28,6) DEFAULT NULL, -- shipping costs (not used)
3281
  `freight` decimal(28,6) DEFAULT NULL COMMENT "shipping costs (not used)",
3282
  `unitprice` decimal(28,6) DEFAULT NULL, -- the actual cost entered when receiving this line item
3282
  `unitprice` decimal(28,6) DEFAULT NULL COMMENT "the actual cost entered when receiving this line item",
3283
  `unitprice_tax_excluded` decimal(28,6) default NULL, -- the unit price excluding tax (on receiving)
3283
  `unitprice_tax_excluded` decimal(28,6) default NULL COMMENT "the unit price excluding tax (on receiving)",
3284
  `unitprice_tax_included` decimal(28,6) default NULL, -- the unit price including tax (on receiving)
3284
  `unitprice_tax_included` decimal(28,6) default NULL COMMENT "the unit price including tax (on receiving)",
3285
  `quantityreceived` smallint(6) NOT NULL default 0, -- the quantity that have been received so far
3285
  `quantityreceived` smallint(6) NOT NULL default 0 COMMENT "the quantity that have been received so far",
3286
  `created_by` int(11) NULL DEFAULT NULL, -- the borrowernumber of order line's creator
3286
  `created_by` int(11) NULL DEFAULT NULL COMMENT "the borrowernumber of order line's creator",
3287
  `datecancellationprinted` date default NULL, -- the date the line item was deleted
3287
  `datecancellationprinted` date default NULL COMMENT "the date the line item was deleted",
3288
  `cancellationreason` MEDIUMTEXT default NULL, -- reason of cancellation
3288
  `cancellationreason` MEDIUMTEXT default NULL COMMENT "reason of cancellation",
3289
  `order_internalnote` LONGTEXT, -- notes related to this order line, made for staff
3289
  `order_internalnote` LONGTEXT COMMENT "notes related to this order line, made for staff",
3290
  `order_vendornote` LONGTEXT, -- notes related to this order line, made for vendor
3290
  `order_vendornote` LONGTEXT COMMENT "notes related to this order line, made for vendor",
3291
  `purchaseordernumber` LONGTEXT, -- not used? always NULL
3291
  `purchaseordernumber` LONGTEXT COMMENT "not used? always NULL",
3292
  `basketno` int(11) default NULL, -- links this order line to a specific basket (aqbasket.basketno)
3292
  `basketno` int(11) default NULL COMMENT "links this order line to a specific basket (aqbasket.basketno)",
3293
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this order line was last modified
3293
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "the date and time this order line was last modified",
3294
  `rrp` decimal(13,2) DEFAULT NULL, -- the retail cost for this line item
3294
  `rrp` decimal(13,2) DEFAULT NULL COMMENT "the retail cost for this line item",
3295
  `replacementprice` decimal(28,6) DEFAULT NULL, -- the replacement cost for this line item
3295
  `replacementprice` decimal(28,6) DEFAULT NULL COMMENT "the replacement cost for this line item",
3296
  `rrp_tax_excluded` decimal(28,6) default NULL, -- the replacement cost excluding tax
3296
  `rrp_tax_excluded` decimal(28,6) default NULL COMMENT "the replacement cost excluding tax",
3297
  `rrp_tax_included` decimal(28,6) default NULL, -- the replacement cost including tax
3297
  `rrp_tax_included` decimal(28,6) default NULL COMMENT "the replacement cost including tax",
3298
  `ecost` decimal(13,2) DEFAULT NULL, -- the replacement cost for this line item
3298
  `ecost` decimal(13,2) DEFAULT NULL COMMENT "the replacement cost for this line item",
3299
  `ecost_tax_excluded` decimal(28,6) default NULL, -- the estimated cost excluding tax
3299
  `ecost_tax_excluded` decimal(28,6) default NULL COMMENT "the estimated cost excluding tax",
3300
  `ecost_tax_included` decimal(28,6) default NULL, -- the estimated cost including tax
3300
  `ecost_tax_included` decimal(28,6) default NULL COMMENT "the estimated cost including tax",
3301
  `tax_rate_bak` decimal(6,4) DEFAULT NULL, -- the tax rate for this line item (%)
3301
  `tax_rate_bak` decimal(6,4) DEFAULT NULL COMMENT "the tax rate for this line item (%)",
3302
  `tax_rate_on_ordering` decimal(6,4) DEFAULT NULL, -- the tax rate on ordering for this line item (%)
3302
  `tax_rate_on_ordering` decimal(6,4) DEFAULT NULL COMMENT "the tax rate on ordering for this line item (%)",
3303
  `tax_rate_on_receiving` decimal(6,4) DEFAULT NULL, -- the tax rate on receiving for this line item (%)
3303
  `tax_rate_on_receiving` decimal(6,4) DEFAULT NULL COMMENT "the tax rate on receiving for this line item (%)",
3304
  `tax_value_bak` decimal(28,6) default NULL, -- the tax value for this line item
3304
  `tax_value_bak` decimal(28,6) default NULL COMMENT "the tax value for this line item",
3305
  `tax_value_on_ordering` decimal(28,6) DEFAULT NULL, -- the tax value on ordering for this line item
3305
  `tax_value_on_ordering` decimal(28,6) DEFAULT NULL COMMENT "the tax value on ordering for this line item",
3306
  `tax_value_on_receiving` decimal(28,6) DEFAULT NULL, -- the tax value on receiving for this line item
3306
  `tax_value_on_receiving` decimal(28,6) DEFAULT NULL COMMENT "the tax value on receiving for this line item",
3307
  `discount` float(6,4) default NULL, -- the discount for this line item (%)
3307
  `discount` float(6,4) default NULL COMMENT "the discount for this line item (%)",
3308
  `budget_id` int(11) NOT NULL, -- the fund this order goes against (aqbudgets.budget_id)
3308
  `budget_id` int(11) NOT NULL COMMENT "the fund this order goes against (aqbudgets.budget_id)",
3309
  `budgetdate` date default NULL, -- not used? always NULL
3309
  `budgetdate` date default NULL COMMENT "not used? always NULL",
3310
  `sort1` varchar(80) default NULL, -- statistical field
3310
  `sort1` varchar(80) default NULL COMMENT "statistical field",
3311
  `sort2` varchar(80) default NULL, -- second statistical field
3311
  `sort2` varchar(80) default NULL COMMENT "second statistical field",
3312
  `sort1_authcat` varchar(10) default NULL,
3312
  `sort1_authcat` varchar(10) default NULL,
3313
  `sort2_authcat` varchar(10) default NULL,
3313
  `sort2_authcat` varchar(10) default NULL,
3314
  `uncertainprice` tinyint(1), -- was this price uncertain (1 for yes, 0 for no)
3314
  `uncertainprice` tinyint(1) COMMENT "was this price uncertain (1 for yes, 0 for no)",
3315
  `subscriptionid` int(11) default NULL, -- links this order line to a subscription (subscription.subscriptionid)
3315
  `subscriptionid` int(11) default NULL COMMENT "links this order line to a subscription (subscription.subscriptionid)",
3316
  parent_ordernumber int(11) default NULL, -- ordernumber of parent order line, or same as ordernumber if no parent
3316
  parent_ordernumber int(11) default NULL COMMENT "ordernumber of parent order line, or same as ordernumber if no parent",
3317
  `orderstatus` varchar(16) default 'new', -- the current status for this line item. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'
3317
  `orderstatus` varchar(16) default 'new' COMMENT "the current status for this line item. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'",
3318
  line_item_id varchar(35) default NULL, -- Supplier's article id for Edifact orderline
3318
  line_item_id varchar(35) default NULL COMMENT "Supplier's article id for Edifact orderline",
3319
  suppliers_reference_number varchar(35) default NULL, -- Suppliers unique edifact quote ref
3319
  suppliers_reference_number varchar(35) default NULL COMMENT "Suppliers unique edifact quote ref",
3320
  suppliers_reference_qualifier varchar(3) default NULL, -- Type of number above usually 'QLI'
3320
  suppliers_reference_qualifier varchar(3) default NULL COMMENT "Type of number above usually 'QLI'",
3321
  `suppliers_report` MEDIUMTEXT COLLATE utf8mb4_unicode_ci, -- reports received from suppliers
3321
  `suppliers_report` MEDIUMTEXT COLLATE utf8mb4_unicode_ci COMMENT "reports received from suppliers",
3322
  PRIMARY KEY  (`ordernumber`),
3322
  PRIMARY KEY  (`ordernumber`),
3323
  KEY `basketno` (`basketno`),
3323
  KEY `basketno` (`basketno`),
3324
  KEY `biblionumber` (`biblionumber`),
3324
  KEY `biblionumber` (`biblionumber`),
Lines 3340-3347 CREATE TABLE `aqorders` ( -- information related to the basket line items Link Here
3340
3340
3341
DROP TABLE IF EXISTS `aqorder_users`;
3341
DROP TABLE IF EXISTS `aqorder_users`;
3342
CREATE TABLE aqorder_users ( -- Mapping orders to patrons for notification sending
3342
CREATE TABLE aqorder_users ( -- Mapping orders to patrons for notification sending
3343
    ordernumber int(11) NOT NULL, -- the order this patrons receive notifications from (aqorders.ordernumber)
3343
    ordernumber int(11) NOT NULL COMMENT "the order this patrons receive notifications from (aqorders.ordernumber)",
3344
    borrowernumber int(11) NOT NULL, -- the borrowernumber for the patron receiving notifications for this order (borrowers.borrowernumber)
3344
    borrowernumber int(11) NOT NULL COMMENT "the borrowernumber for the patron receiving notifications for this order (borrowers.borrowernumber)",
3345
    PRIMARY KEY (ordernumber, borrowernumber),
3345
    PRIMARY KEY (ordernumber, borrowernumber),
3346
    CONSTRAINT aqorder_users_ibfk_1 FOREIGN KEY (ordernumber) REFERENCES aqorders (ordernumber) ON DELETE CASCADE ON UPDATE CASCADE,
3346
    CONSTRAINT aqorder_users_ibfk_1 FOREIGN KEY (ordernumber) REFERENCES aqorders (ordernumber) ON DELETE CASCADE ON UPDATE CASCADE,
3347
    CONSTRAINT aqorder_users_ibfk_2 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE
3347
    CONSTRAINT aqorder_users_ibfk_2 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE
Lines 3353-3361 CREATE TABLE aqorder_users ( -- Mapping orders to patrons for notification sendi Link Here
3353
3353
3354
DROP TABLE IF EXISTS `aqorders_items`;
3354
DROP TABLE IF EXISTS `aqorders_items`;
3355
CREATE TABLE `aqorders_items` ( -- information on items entered in the acquisitions process
3355
CREATE TABLE `aqorders_items` ( -- information on items entered in the acquisitions process
3356
  `ordernumber` int(11) NOT NULL, -- the order this item is attached to (aqorders.ordernumber)
3356
  `ordernumber` int(11) NOT NULL COMMENT "the order this item is attached to (aqorders.ordernumber)",
3357
  `itemnumber` int(11) NOT NULL, -- the item number for this item (items.itemnumber)
3357
  `itemnumber` int(11) NOT NULL COMMENT "the item number for this item (items.itemnumber)",
3358
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this order item was last touched
3358
  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP COMMENT "the date and time this order item was last touched",
3359
  PRIMARY KEY  (`itemnumber`),
3359
  PRIMARY KEY  (`itemnumber`),
3360
  KEY `ordernumber` (`ordernumber`),
3360
  KEY `ordernumber` (`ordernumber`),
3361
  CONSTRAINT aqorders_items_ibfk_1 FOREIGN KEY (ordernumber) REFERENCES aqorders (ordernumber) ON DELETE CASCADE ON UPDATE CASCADE
3361
  CONSTRAINT aqorders_items_ibfk_1 FOREIGN KEY (ordernumber) REFERENCES aqorders (ordernumber) ON DELETE CASCADE ON UPDATE CASCADE
Lines 3382-3390 CREATE TABLE aqorders_transfers ( Link Here
3382
3382
3383
DROP TABLE IF EXISTS aqorders_claims;
3383
DROP TABLE IF EXISTS aqorders_claims;
3384
CREATE TABLE aqorders_claims (
3384
CREATE TABLE aqorders_claims (
3385
    id int(11) AUTO_INCREMENT, -- ID of the claims
3385
    id int(11) AUTO_INCREMENT COMMENT "ID of the claims",
3386
    ordernumber INT(11) NOT NULL, -- order linked to this claim
3386
    ordernumber INT(11) NOT NULL COMMENT "order linked to this claim",
3387
    claimed_on TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Date of the claims
3387
    claimed_on TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "Date of the claims",
3388
    PRIMARY KEY (id),
3388
    PRIMARY KEY (id),
3389
    CONSTRAINT aqorders_claims_ibfk_1 FOREIGN KEY (ordernumber) REFERENCES aqorders (ordernumber) ON DELETE CASCADE ON UPDATE CASCADE
3389
    CONSTRAINT aqorders_claims_ibfk_1 FOREIGN KEY (ordernumber) REFERENCES aqorders (ordernumber) ON DELETE CASCADE ON UPDATE CASCADE
3390
) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
3390
) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
Lines 3411-3423 CREATE TABLE transport_cost ( Link Here
3411
DROP TABLE IF EXISTS `cover_images`;
3411
DROP TABLE IF EXISTS `cover_images`;
3412
3412
3413
CREATE TABLE `cover_images` ( -- local cover images
3413
CREATE TABLE `cover_images` ( -- local cover images
3414
 `imagenumber` int(11) NOT NULL AUTO_INCREMENT, -- unique identifier for the image
3414
 `imagenumber` int(11) NOT NULL AUTO_INCREMENT COMMENT "unique identifier for the image",
3415
 `biblionumber` int(11) DEFAULT NULL, -- foreign key from biblio table to link to biblionumber
3415
 `biblionumber` int(11) DEFAULT NULL COMMENT "foreign key from biblio table to link to biblionumber",
3416
 `itemnumber` int(11) DEFAULT NULL, -- foreign key from item table to link to itemnumber
3416
 `itemnumber` int(11) DEFAULT NULL COMMENT "foreign key from item table to link to itemnumber",
3417
 `mimetype` varchar(15) NOT NULL, -- image type
3417
 `mimetype` varchar(15) NOT NULL COMMENT "image type",
3418
 `imagefile` mediumblob NOT NULL, -- image file contents
3418
 `imagefile` mediumblob NOT NULL COMMENT "image file contents",
3419
 `thumbnail` mediumblob NOT NULL, -- thumbnail file contents
3419
 `thumbnail` mediumblob NOT NULL COMMENT "thumbnail file contents",
3420
 `timestamp` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, -- image creation/update time
3420
 `timestamp` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "image creation/update time",
3421
 PRIMARY KEY (`imagenumber`),
3421
 PRIMARY KEY (`imagenumber`),
3422
 CONSTRAINT `bibliocoverimage_fk1` FOREIGN KEY (`biblionumber`) REFERENCES `biblio` (`biblionumber`) ON DELETE CASCADE ON UPDATE CASCADE,
3422
 CONSTRAINT `bibliocoverimage_fk1` FOREIGN KEY (`biblionumber`) REFERENCES `biblio` (`biblionumber`) ON DELETE CASCADE ON UPDATE CASCADE,
3423
 CONSTRAINT `bibliocoverimage_fk2` FOREIGN KEY (`itemnumber`) REFERENCES `items` (`itemnumber`) ON DELETE CASCADE ON UPDATE CASCADE
3423
 CONSTRAINT `bibliocoverimage_fk2` FOREIGN KEY (`itemnumber`) REFERENCES `items` (`itemnumber`) ON DELETE CASCADE ON UPDATE CASCADE
Lines 3445-3453 CREATE TABLE IF NOT EXISTS `social_data` ( Link Here
3445
3445
3446
DROP TABLE IF EXISTS ratings;
3446
DROP TABLE IF EXISTS ratings;
3447
CREATE TABLE ratings ( -- information related to the star ratings in the OPAC
3447
CREATE TABLE ratings ( -- information related to the star ratings in the OPAC
3448
    borrowernumber int(11) NOT NULL, -- the borrowernumber of the patron who left this rating (borrowers.borrowernumber)
3448
    borrowernumber int(11) NOT NULL COMMENT "the borrowernumber of the patron who left this rating (borrowers.borrowernumber)",
3449
    biblionumber int(11) NOT NULL, -- the biblio this rating is for (biblio.biblionumber)
3449
    biblionumber int(11) NOT NULL COMMENT "the biblio this rating is for (biblio.biblionumber)",
3450
    rating_value tinyint(1) NOT NULL, -- the rating, from 1 to 5
3450
    rating_value tinyint(1) NOT NULL COMMENT "the rating, from 1 to 5",
3451
    timestamp timestamp NOT NULL default CURRENT_TIMESTAMP,
3451
    timestamp timestamp NOT NULL default CURRENT_TIMESTAMP,
3452
    PRIMARY KEY  (borrowernumber,biblionumber),
3452
    PRIMARY KEY  (borrowernumber,biblionumber),
3453
    CONSTRAINT ratings_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE,
3453
    CONSTRAINT ratings_ibfk_1 FOREIGN KEY (borrowernumber) REFERENCES borrowers (borrowernumber) ON DELETE CASCADE ON UPDATE CASCADE,
Lines 3460-3469 CREATE TABLE ratings ( -- information related to the star ratings in the OPAC Link Here
3460
3460
3461
DROP TABLE IF EXISTS quotes;
3461
DROP TABLE IF EXISTS quotes;
3462
CREATE TABLE `quotes` ( -- data for the quote of the day feature
3462
CREATE TABLE `quotes` ( -- data for the quote of the day feature
3463
  `id` int(11) NOT NULL AUTO_INCREMENT, -- unique id for the quote
3463
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT "unique id for the quote",
3464
  `source` MEDIUMTEXT DEFAULT NULL, -- source/credit for the quote
3464
  `source` MEDIUMTEXT DEFAULT NULL COMMENT "source/credit for the quote",
3465
  `text` LONGTEXT NOT NULL, -- text of the quote
3465
  `text` LONGTEXT NOT NULL COMMENT "text of the quote",
3466
  `timestamp` datetime NULL, -- date and time that the quote last appeared in the opac
3466
  `timestamp` datetime NULL COMMENT "date and time that the quote last appeared in the opac",
3467
  PRIMARY KEY (`id`)
3467
  PRIMARY KEY (`id`)
3468
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
3468
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
3469
3469
Lines 3578-3584 CREATE TABLE IF NOT EXISTS `borrower_modifications` ( Link Here
3578
  `smsalertnumber` varchar(50) DEFAULT NULL,
3578
  `smsalertnumber` varchar(50) DEFAULT NULL,
3579
  `privacy` int(11) DEFAULT NULL,
3579
  `privacy` int(11) DEFAULT NULL,
3580
  `extended_attributes` MEDIUMTEXT DEFAULT NULL,
3580
  `extended_attributes` MEDIUMTEXT DEFAULT NULL,
3581
  `gdpr_proc_consent` datetime, -- data processing consent
3581
  `gdpr_proc_consent` datetime COMMENT "data processing consent",
3582
  PRIMARY KEY (`verification_token` (191),`borrowernumber`),
3582
  PRIMARY KEY (`verification_token` (191),`borrowernumber`),
3583
  KEY `verification_token` (`verification_token` (191)),
3583
  KEY `verification_token` (`verification_token` (191)),
3584
  KEY `borrowernumber` (`borrowernumber`)
3584
  KEY `borrowernumber` (`borrowernumber`)
Lines 3610-3621 CREATE TABLE uploaded_files ( Link Here
3610
3610
3611
DROP TABLE IF EXISTS linktracker;
3611
DROP TABLE IF EXISTS linktracker;
3612
CREATE TABLE linktracker (
3612
CREATE TABLE linktracker (
3613
   id int(11) NOT NULL AUTO_INCREMENT, -- primary key identifier
3613
   id int(11) NOT NULL AUTO_INCREMENT COMMENT "primary key identifier",
3614
   biblionumber int(11) DEFAULT NULL, -- biblionumber of the record the link is from
3614
   biblionumber int(11) DEFAULT NULL COMMENT "biblionumber of the record the link is from",
3615
   itemnumber int(11) DEFAULT NULL, -- itemnumber if applicable that the link was from
3615
   itemnumber int(11) DEFAULT NULL COMMENT "itemnumber if applicable that the link was from",
3616
   borrowernumber int(11) DEFAULT NULL, -- borrowernumber who clicked the link
3616
   borrowernumber int(11) DEFAULT NULL COMMENT "borrowernumber who clicked the link",
3617
   url MEDIUMTEXT, -- the link itself
3617
   url MEDIUMTEXT COMMENT "the link itself",
3618
   timeclicked datetime DEFAULT NULL, -- the date and time the link was clicked
3618
   timeclicked datetime DEFAULT NULL COMMENT "the date and time the link was clicked",
3619
   PRIMARY KEY (id),
3619
   PRIMARY KEY (id),
3620
   KEY bibidx (biblionumber),
3620
   KEY bibidx (biblionumber),
3621
   KEY itemidx (itemnumber),
3621
   KEY itemidx (itemnumber),
Lines 3642-3648 DROP TABLE IF EXISTS patron_consent; Link Here
3642
CREATE TABLE patron_consent (
3642
CREATE TABLE patron_consent (
3643
  id int AUTO_INCREMENT,
3643
  id int AUTO_INCREMENT,
3644
  borrowernumber int NOT NULL,
3644
  borrowernumber int NOT NULL,
3645
  type enum('GDPR_PROCESSING' ), -- allows for future extension
3645
  type enum('GDPR_PROCESSING' ) COMMENT "allows for future extension",
3646
  given_on datetime,
3646
  given_on datetime,
3647
  refused_on datetime,
3647
  refused_on datetime,
3648
  PRIMARY KEY (id),
3648
  PRIMARY KEY (id),
Lines 3666-3674 CREATE TABLE plugin_methods ( Link Here
3666
3666
3667
DROP TABLE IF EXISTS patron_lists;
3667
DROP TABLE IF EXISTS patron_lists;
3668
CREATE TABLE patron_lists (
3668
CREATE TABLE patron_lists (
3669
  patron_list_id int(11) NOT NULL AUTO_INCREMENT, -- unique identifier
3669
  patron_list_id int(11) NOT NULL AUTO_INCREMENT COMMENT "unique identifier",
3670
  name varchar(255) CHARACTER SET utf8mb4 NOT NULL,  -- the list's name
3670
  name varchar(255) CHARACTER SET utf8mb4 NOT NULL COMMENT "the list's name",
3671
  owner int(11) NOT NULL,                         -- borrowernumber of the list creator
3671
  owner int(11) NOT NULL COMMENT "borrowernumber of the list creator",
3672
  shared tinyint(1) default 0,
3672
  shared tinyint(1) default 0,
3673
  PRIMARY KEY (patron_list_id),
3673
  PRIMARY KEY (patron_list_id),
3674
  KEY owner (owner)
3674
  KEY owner (owner)
Lines 3686-3694 ALTER TABLE `patron_lists` Link Here
3686
3686
3687
DROP TABLE IF EXISTS patron_list_patrons;
3687
DROP TABLE IF EXISTS patron_list_patrons;
3688
CREATE TABLE patron_list_patrons (
3688
CREATE TABLE patron_list_patrons (
3689
  patron_list_patron_id int(11) NOT NULL AUTO_INCREMENT, -- unique identifier
3689
  patron_list_patron_id int(11) NOT NULL AUTO_INCREMENT COMMENT "unique identifier",
3690
  patron_list_id int(11) NOT NULL,                       -- the list this entry is part of
3690
  patron_list_id int(11) NOT NULL COMMENT "the list this entry is part of",
3691
  borrowernumber int(11) NOT NULL,                       -- the borrower that is part of this list
3691
  borrowernumber int(11) NOT NULL COMMENT "the borrower that is part of this list",
3692
  PRIMARY KEY (patron_list_patron_id),
3692
  PRIMARY KEY (patron_list_patron_id),
3693
  KEY patron_list_id (patron_list_id),
3693
  KEY patron_list_id (patron_list_id),
3694
  KEY borrowernumber (borrowernumber)
3694
  KEY borrowernumber (borrowernumber)
Lines 3745-3758 CREATE TABLE IF NOT EXISTS marc_modification_template_actions ( Link Here
3745
--
3745
--
3746
3746
3747
CREATE TABLE IF NOT EXISTS `misc_files` ( -- miscellaneous files attached to records from various tables
3747
CREATE TABLE IF NOT EXISTS `misc_files` ( -- miscellaneous files attached to records from various tables
3748
  `file_id` int(11) NOT NULL AUTO_INCREMENT, -- unique id for the file record
3748
  `file_id` int(11) NOT NULL AUTO_INCREMENT COMMENT "unique id for the file record",
3749
  `table_tag` varchar(255) NOT NULL, -- usually table name, or arbitrary unique tag
3749
  `table_tag` varchar(255) NOT NULL COMMENT "usually table name, or arbitrary unique tag",
3750
  `record_id` int(11) NOT NULL, -- record id from the table this file is associated to
3750
  `record_id` int(11) NOT NULL COMMENT "record id from the table this file is associated to",
3751
  `file_name` varchar(255) NOT NULL, -- file name
3751
  `file_name` varchar(255) NOT NULL COMMENT "file name",
3752
  `file_type` varchar(255) NOT NULL, -- MIME type of the file
3752
  `file_type` varchar(255) NOT NULL COMMENT "MIME type of the file",
3753
  `file_description` varchar(255) DEFAULT NULL, -- description given to the file
3753
  `file_description` varchar(255) DEFAULT NULL COMMENT "description given to the file",
3754
  `file_content` longblob NOT NULL, -- file content
3754
  `file_content` longblob NOT NULL COMMENT "file content",
3755
  `date_uploaded` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, -- date and time the file was added
3755
  `date_uploaded` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "date and time the file was added",
3756
  PRIMARY KEY (`file_id`),
3756
  PRIMARY KEY (`file_id`),
3757
  KEY `table_tag` (`table_tag`),
3757
  KEY `table_tag` (`table_tag`),
3758
  KEY `record_id` (`record_id`)
3758
  KEY `record_id` (`record_id`)
Lines 3824-3835 CREATE TABLE discharges ( Link Here
3824
3824
3825
DROP TABLE IF EXISTS additional_fields;
3825
DROP TABLE IF EXISTS additional_fields;
3826
CREATE TABLE `additional_fields` (
3826
CREATE TABLE `additional_fields` (
3827
  `id` int(11) NOT NULL AUTO_INCREMENT, -- primary key identifier
3827
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT "primary key identifier",
3828
  `tablename` varchar(255) NOT NULL DEFAULT '', -- tablename of the new field
3828
  `tablename` varchar(255) NOT NULL DEFAULT '' COMMENT "tablename of the new field",
3829
  `name` varchar(255) NOT NULL DEFAULT '', -- name of the field
3829
  `name` varchar(255) NOT NULL DEFAULT '' COMMENT "name of the field",
3830
  `authorised_value_category` varchar(16) NOT NULL DEFAULT '', -- is an authorised value category
3830
  `authorised_value_category` varchar(16) NOT NULL DEFAULT '' COMMENT "is an authorised value category",
3831
  `marcfield` varchar(16) NOT NULL DEFAULT '', -- contains the marc field to copied into the record
3831
  `marcfield` varchar(16) NOT NULL DEFAULT '' COMMENT "contains the marc field to copied into the record",
3832
  `searchable` tinyint(1) NOT NULL DEFAULT '0', -- is the field searchable?
3832
  `searchable` tinyint(1) NOT NULL DEFAULT '0' COMMENT "is the field searchable?",
3833
  PRIMARY KEY (`id`),
3833
  PRIMARY KEY (`id`),
3834
  UNIQUE KEY `fields_uniq` (`tablename` (191),`name` (191))
3834
  UNIQUE KEY `fields_uniq` (`tablename` (191),`name` (191))
3835
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
3835
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 3841-3850 CREATE TABLE `additional_fields` ( Link Here
3841
3841
3842
DROP TABLE IF EXISTS additional_field_values;
3842
DROP TABLE IF EXISTS additional_field_values;
3843
CREATE TABLE `additional_field_values` (
3843
CREATE TABLE `additional_field_values` (
3844
  `id` int(11) NOT NULL AUTO_INCREMENT, -- primary key identifier
3844
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT "primary key identifier",
3845
  `field_id` int(11) NOT NULL, -- foreign key references additional_fields(id)
3845
  `field_id` int(11) NOT NULL COMMENT "foreign key references additional_fields(id)",
3846
  `record_id` int(11) NOT NULL, -- record_id
3846
  `record_id` int(11) NOT NULL COMMENT "record_id",
3847
  `value` varchar(255) NOT NULL DEFAULT '', -- value for this field
3847
  `value` varchar(255) NOT NULL DEFAULT '' COMMENT "value for this field",
3848
  PRIMARY KEY (`id`),
3848
  PRIMARY KEY (`id`),
3849
  UNIQUE KEY `field_record` (`field_id`,`record_id`),
3849
  UNIQUE KEY `field_record` (`field_id`,`record_id`),
3850
  CONSTRAINT `afv_fk` FOREIGN KEY (`field_id`) REFERENCES `additional_fields` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
3850
  CONSTRAINT `afv_fk` FOREIGN KEY (`field_id`) REFERENCES `additional_fields` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
Lines 3859-3865 CREATE TABLE `localization` ( Link Here
3859
      localization_id int(11) NOT NULL AUTO_INCREMENT,
3859
      localization_id int(11) NOT NULL AUTO_INCREMENT,
3860
      entity varchar(16) COLLATE utf8mb4_unicode_ci NOT NULL,
3860
      entity varchar(16) COLLATE utf8mb4_unicode_ci NOT NULL,
3861
      code varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
3861
      code varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
3862
      lang varchar(25) COLLATE utf8mb4_unicode_ci NOT NULL, -- could be a foreign key
3862
      lang varchar(25) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT "could be a foreign key",
3863
      translation MEDIUMTEXT COLLATE utf8mb4_unicode_ci,
3863
      translation MEDIUMTEXT COLLATE utf8mb4_unicode_ci,
3864
      PRIMARY KEY (localization_id),
3864
      PRIMARY KEY (localization_id),
3865
      UNIQUE KEY `entity_code_lang` (`entity`,`code`,`lang`)
3865
      UNIQUE KEY `entity_code_lang` (`entity`,`code`,`lang`)
Lines 3902-3917 CREATE TABLE IF NOT EXISTS edifact_ean ( Link Here
3902
3902
3903
DROP TABLE IF EXISTS courses;
3903
DROP TABLE IF EXISTS courses;
3904
CREATE TABLE `courses` (
3904
CREATE TABLE `courses` (
3905
  `course_id` int(11) NOT NULL AUTO_INCREMENT, -- unique id for the course
3905
  `course_id` int(11) NOT NULL AUTO_INCREMENT COMMENT "unique id for the course",
3906
  `department` varchar(80) DEFAULT NULL, -- the authorised value for the DEPARTMENT
3906
  `department` varchar(80) DEFAULT NULL COMMENT "the authorised value for the DEPARTMENT",
3907
  `course_number` varchar(255) DEFAULT NULL, -- the "course number" assigned to a course
3907
  `course_number` varchar(255) DEFAULT NULL COMMENT "the "course number" assigned to a course",
3908
  `section` varchar(255) DEFAULT NULL, -- the 'section' of a course
3908
  `section` varchar(255) DEFAULT NULL COMMENT "the 'section' of a course",
3909
  `course_name` varchar(255) DEFAULT NULL, -- the name of the course
3909
  `course_name` varchar(255) DEFAULT NULL COMMENT "the name of the course",
3910
  `term` varchar(80) DEFAULT NULL, -- the authorised value for the TERM
3910
  `term` varchar(80) DEFAULT NULL COMMENT "the authorised value for the TERM",
3911
  `staff_note` LONGTEXT, -- the text of the staff only note
3911
  `staff_note` LONGTEXT COMMENT "the text of the staff only note",
3912
  `public_note` LONGTEXT, -- the text of the public / opac note
3912
  `public_note` LONGTEXT COMMENT "the text of the public / opac note",
3913
  `students_count` varchar(20) DEFAULT NULL, -- how many students will be taking this course/section
3913
  `students_count` varchar(20) DEFAULT NULL COMMENT "how many students will be taking this course/section",
3914
  `enabled` enum('yes','no') NOT NULL DEFAULT 'yes', -- determines whether the course is active
3914
  `enabled` enum('yes','no') NOT NULL DEFAULT 'yes' COMMENT "determines whether the course is active",
3915
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
3915
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
3916
   PRIMARY KEY (`course_id`)
3916
   PRIMARY KEY (`course_id`)
3917
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
3917
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 3926-3933 CREATE TABLE `courses` ( Link Here
3926
3926
3927
DROP TABLE IF EXISTS course_instructors;
3927
DROP TABLE IF EXISTS course_instructors;
3928
CREATE TABLE `course_instructors` (
3928
CREATE TABLE `course_instructors` (
3929
  `course_id` int(11) NOT NULL, -- foreign key to link to courses.course_id
3929
  `course_id` int(11) NOT NULL COMMENT "foreign key to link to courses.course_id",
3930
  `borrowernumber` int(11) NOT NULL, -- foreign key to link to borrowers.borrowernumber for instructor information
3930
  `borrowernumber` int(11) NOT NULL COMMENT "foreign key to link to borrowers.borrowernumber for instructor information",
3931
  PRIMARY KEY (`course_id`,`borrowernumber`),
3931
  PRIMARY KEY (`course_id`,`borrowernumber`),
3932
  KEY `borrowernumber` (`borrowernumber`)
3932
  KEY `borrowernumber` (`borrowernumber`)
3933
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
3933
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
Lines 3949-3972 ALTER TABLE `course_instructors` Link Here
3949
3949
3950
DROP TABLE IF EXISTS course_items;
3950
DROP TABLE IF EXISTS course_items;
3951
CREATE TABLE `course_items` (
3951
CREATE TABLE `course_items` (
3952
  `ci_id` int(11) NOT NULL AUTO_INCREMENT, -- course item id
3952
  `ci_id` int(11) NOT NULL AUTO_INCREMENT COMMENT "course item id",
3953
  `itemnumber` int(11) NOT NULL, -- items.itemnumber for the item on reserve
3953
  `itemnumber` int(11) NOT NULL COMMENT "items.itemnumber for the item on reserve",
3954
  `itype` varchar(10) DEFAULT NULL, -- new itemtype for the item to have while on reserve (optional)
3954
  `itype` varchar(10) DEFAULT NULL COMMENT "new itemtype for the item to have while on reserve (optional)",
3955
  `itype_enabled` tinyint(1) NOT NULL DEFAULT 0, -- indicates if itype should be changed while on course reserve
3955
  `itype_enabled` tinyint(1) NOT NULL DEFAULT 0 COMMENT "indicates if itype should be changed while on course reserve",
3956
  `itype_storage` varchar(10) DEFAULT NULL, -- a place to store the itype when item is on course reserve
3956
  `itype_storage` varchar(10) DEFAULT NULL COMMENT "a place to store the itype when item is on course reserve",
3957
  `ccode` varchar(80) DEFAULT NULL, -- new category code for the item to have while on reserve (optional)
3957
  `ccode` varchar(80) DEFAULT NULL COMMENT "new category code for the item to have while on reserve (optional)",
3958
  `ccode_enabled` tinyint(1) NOT NULL DEFAULT 0, -- indicates if ccode should be changed while on course reserve
3958
  `ccode_enabled` tinyint(1) NOT NULL DEFAULT 0 COMMENT "indicates if ccode should be changed while on course reserve",
3959
  `ccode_storage` varchar(80) DEFAULT NULL, -- a place to store the ccode when item is on course reserve
3959
  `ccode_storage` varchar(80) DEFAULT NULL COMMENT "a place to store the ccode when item is on course reserve",
3960
  `homebranch` varchar(10) DEFAULT NULL, -- new home branch for the item to have while on reserve (optional)
3960
  `homebranch` varchar(10) DEFAULT NULL COMMENT "new home branch for the item to have while on reserve (optional)",
3961
  `homebranch_enabled` tinyint(1) NOT NULL DEFAULT 0, -- indicates if homebranch should be changed while on course reserve
3961
  `homebranch_enabled` tinyint(1) NOT NULL DEFAULT 0 COMMENT "indicates if homebranch should be changed while on course reserve",
3962
  `homebranch_storage` varchar(10) DEFAULT NULL, -- a place to store the homebranch when item is on course reserve
3962
  `homebranch_storage` varchar(10) DEFAULT NULL COMMENT "a place to store the homebranch when item is on course reserve",
3963
  `holdingbranch` varchar(10) DEFAULT NULL, -- new holding branch for the item to have while on reserve (optional)
3963
  `holdingbranch` varchar(10) DEFAULT NULL COMMENT "new holding branch for the item to have while on reserve (optional)",
3964
  `holdingbranch_enabled` tinyint(1) NOT NULL DEFAULT 0, -- indicates if itype should be changed while on course reserve
3964
  `holdingbranch_enabled` tinyint(1) NOT NULL DEFAULT 0 COMMENT "indicates if itype should be changed while on course reserve",
3965
  `holdingbranch_storage` varchar(10) DEFAULT NULL, -- a place to store the holdingbranch when item is on course reserve
3965
  `holdingbranch_storage` varchar(10) DEFAULT NULL COMMENT "a place to store the holdingbranch when item is on course reserve",
3966
  `location` varchar(80) DEFAULT NULL, -- new shelving location for the item to have while on reseve (optional)
3966
  `location` varchar(80) DEFAULT NULL COMMENT "new shelving location for the item to have while on reseve (optional)",
3967
  `location_enabled` tinyint(1) NOT NULL DEFAULT 0, -- indicates if itype should be changed while on course reserve
3967
  `location_enabled` tinyint(1) NOT NULL DEFAULT 0 COMMENT "indicates if itype should be changed while on course reserve",
3968
  `location_storage` varchar(80) DEFAULT NULL, -- a place to store the location when the item is on course reserve
3968
  `location_storage` varchar(80) DEFAULT NULL COMMENT "a place to store the location when the item is on course reserve",
3969
  `enabled` enum('yes','no') NOT NULL DEFAULT 'no', -- if at least one enabled course has this item on reseve, this field will be 'yes', otherwise it will be 'no'
3969
  `enabled` enum('yes','no') NOT NULL DEFAULT 'no' COMMENT "if at least one enabled course has this item on reseve, this field will be 'yes', otherwise it will be 'no'",
3970
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
3970
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
3971
   PRIMARY KEY (`ci_id`),
3971
   PRIMARY KEY (`ci_id`),
3972
   UNIQUE KEY `itemnumber` (`itemnumber`),
3972
   UNIQUE KEY `itemnumber` (`itemnumber`),
Lines 3992-4001 ALTER TABLE `course_items` Link Here
3992
DROP TABLE IF EXISTS course_reserves;
3992
DROP TABLE IF EXISTS course_reserves;
3993
CREATE TABLE `course_reserves` (
3993
CREATE TABLE `course_reserves` (
3994
  `cr_id` int(11) NOT NULL AUTO_INCREMENT,
3994
  `cr_id` int(11) NOT NULL AUTO_INCREMENT,
3995
  `course_id` int(11) NOT NULL, -- foreign key to link to courses.course_id
3995
  `course_id` int(11) NOT NULL COMMENT "foreign key to link to courses.course_id",
3996
  `ci_id` int(11) NOT NULL, -- foreign key to link to courses_items.ci_id
3996
  `ci_id` int(11) NOT NULL COMMENT "foreign key to link to courses_items.ci_id",
3997
  `staff_note` LONGTEXT, -- staff only note
3997
  `staff_note` LONGTEXT COMMENT "staff only note",
3998
  `public_note` LONGTEXT, -- public, OPAC visible note
3998
  `public_note` LONGTEXT COMMENT "public, OPAC visible note",
3999
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
3999
  `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
4000
   PRIMARY KEY (`cr_id`),
4000
   PRIMARY KEY (`cr_id`),
4001
   UNIQUE KEY `pseudo_key` (`course_id`,`ci_id`),
4001
   UNIQUE KEY `pseudo_key` (`course_id`,`ci_id`),
Lines 4039-4052 CREATE TABLE `hold_fill_targets` ( Link Here
4039
4039
4040
DROP TABLE IF EXISTS `housebound_profile`;
4040
DROP TABLE IF EXISTS `housebound_profile`;
4041
CREATE TABLE `housebound_profile` (
4041
CREATE TABLE `housebound_profile` (
4042
  `borrowernumber` int(11) NOT NULL, -- Number of the borrower associated with this profile.
4042
  `borrowernumber` int(11) NOT NULL COMMENT "Number of the borrower associated with this profile.",
4043
  `day` MEDIUMTEXT NOT NULL,  -- The preferred day of the week for delivery.
4043
  `day` MEDIUMTEXT NOT NULL COMMENT "The preferred day of the week for delivery.",
4044
  `frequency` MEDIUMTEXT NOT NULL, -- The Authorised_Value definining the pattern for delivery.
4044
  `frequency` MEDIUMTEXT NOT NULL COMMENT "The Authorised_Value definining the pattern for delivery.",
4045
  `fav_itemtypes` MEDIUMTEXT default NULL, -- Free text describing preferred itemtypes.
4045
  `fav_itemtypes` MEDIUMTEXT default NULL COMMENT "Free text describing preferred itemtypes.",
4046
  `fav_subjects` MEDIUMTEXT default NULL, -- Free text describing preferred subjects.
4046
  `fav_subjects` MEDIUMTEXT default NULL COMMENT "Free text describing preferred subjects.",
4047
  `fav_authors` MEDIUMTEXT default NULL, -- Free text describing preferred authors.
4047
  `fav_authors` MEDIUMTEXT default NULL COMMENT "Free text describing preferred authors.",
4048
  `referral` MEDIUMTEXT default NULL, -- Free text indicating how the borrower was added to the service.
4048
  `referral` MEDIUMTEXT default NULL COMMENT "Free text indicating how the borrower was added to the service.",
4049
  `notes` MEDIUMTEXT default NULL, -- Free text for additional notes.
4049
  `notes` MEDIUMTEXT default NULL COMMENT "Free text for additional notes.",
4050
  PRIMARY KEY  (`borrowernumber`),
4050
  PRIMARY KEY  (`borrowernumber`),
4051
  CONSTRAINT `housebound_profile_bnfk`
4051
  CONSTRAINT `housebound_profile_bnfk`
4052
    FOREIGN KEY (`borrowernumber`)
4052
    FOREIGN KEY (`borrowernumber`)
Lines 4060-4071 CREATE TABLE `housebound_profile` ( Link Here
4060
4060
4061
DROP TABLE IF EXISTS `housebound_visit`;
4061
DROP TABLE IF EXISTS `housebound_visit`;
4062
CREATE TABLE `housebound_visit` (
4062
CREATE TABLE `housebound_visit` (
4063
  `id` int(11) NOT NULL auto_increment, -- ID of the visit.
4063
  `id` int(11) NOT NULL auto_increment COMMENT "ID of the visit.",
4064
  `borrowernumber` int(11) NOT NULL, -- Number of the borrower, & the profile, linked to this visit.
4064
  `borrowernumber` int(11) NOT NULL COMMENT "Number of the borrower, & the profile, linked to this visit.",
4065
  `appointment_date` date default NULL, -- Date of visit.
4065
  `appointment_date` date default NULL COMMENT "Date of visit.",
4066
  `day_segment` varchar(10),  -- Rough time frame: 'morning', 'afternoon' 'evening'
4066
  `day_segment` varchar(10) COMMENT "Rough time frame: 'morning', 'afternoon' 'evening'",
4067
  `chooser_brwnumber` int(11) default NULL, -- Number of the borrower to choose items  for delivery.
4067
  `chooser_brwnumber` int(11) default NULL COMMENT "Number of the borrower to choose items  for delivery.",
4068
  `deliverer_brwnumber` int(11) default NULL, -- Number of the borrower to deliver items.
4068
  `deliverer_brwnumber` int(11) default NULL COMMENT "Number of the borrower to deliver items.",
4069
  PRIMARY KEY  (`id`),
4069
  PRIMARY KEY  (`id`),
4070
  CONSTRAINT `houseboundvisit_bnfk`
4070
  CONSTRAINT `houseboundvisit_bnfk`
4071
    FOREIGN KEY (`borrowernumber`)
4071
    FOREIGN KEY (`borrowernumber`)
Lines 4087-4095 CREATE TABLE `housebound_visit` ( Link Here
4087
4087
4088
DROP TABLE IF EXISTS `housebound_role`;
4088
DROP TABLE IF EXISTS `housebound_role`;
4089
CREATE TABLE IF NOT EXISTS `housebound_role` (
4089
CREATE TABLE IF NOT EXISTS `housebound_role` (
4090
  `borrowernumber_id` int(11) NOT NULL, -- borrowernumber link
4090
  `borrowernumber_id` int(11) NOT NULL COMMENT "borrowernumber link",
4091
  `housebound_chooser` tinyint(1) NOT NULL DEFAULT 0, -- set to 1 to indicate this patron is a housebound chooser volunteer
4091
  `housebound_chooser` tinyint(1) NOT NULL DEFAULT 0 COMMENT "set to 1 to indicate this patron is a housebound chooser volunteer",
4092
  `housebound_deliverer` tinyint(1) NOT NULL DEFAULT 0, -- set to 1 to indicate this patron is a housebound deliverer volunteer
4092
  `housebound_deliverer` tinyint(1) NOT NULL DEFAULT 0 COMMENT "set to 1 to indicate this patron is a housebound deliverer volunteer",
4093
  PRIMARY KEY (`borrowernumber_id`),
4093
  PRIMARY KEY (`borrowernumber_id`),
4094
  CONSTRAINT `houseboundrole_bnfk`
4094
  CONSTRAINT `houseboundrole_bnfk`
4095
    FOREIGN KEY (`borrowernumber_id`)
4095
    FOREIGN KEY (`borrowernumber_id`)
Lines 4118-4124 CREATE TABLE `article_requests` ( Link Here
4118
  `patron_notes` MEDIUMTEXT,
4118
  `patron_notes` MEDIUMTEXT,
4119
  `status` enum('PENDING','PROCESSING','COMPLETED','CANCELED') NOT NULL DEFAULT 'PENDING',
4119
  `status` enum('PENDING','PROCESSING','COMPLETED','CANCELED') NOT NULL DEFAULT 'PENDING',
4120
  `notes` MEDIUMTEXT,
4120
  `notes` MEDIUMTEXT,
4121
  `created_on` timestamp NULL DEFAULT NULL, -- Be careful with two timestamps in one table not allowing NULL
4121
  `created_on` timestamp NULL DEFAULT NULL COMMENT "Be careful with two timestamps in one table not allowing NULL",
4122
  `updated_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
4122
  `updated_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
4123
  PRIMARY KEY (`id`),
4123
  PRIMARY KEY (`id`),
4124
  KEY `borrowernumber` (`borrowernumber`),
4124
  KEY `borrowernumber` (`borrowernumber`),
Lines 4213-4222 CREATE TABLE IF NOT EXISTS clubs ( Link Here
4213
4213
4214
CREATE TABLE IF NOT EXISTS club_holds (
4214
CREATE TABLE IF NOT EXISTS club_holds (
4215
    id        INT(11) NOT NULL AUTO_INCREMENT,
4215
    id        INT(11) NOT NULL AUTO_INCREMENT,
4216
    club_id   INT(11) NOT NULL, -- id for the club the hold was generated for
4216
    club_id   INT(11) NOT NULL COMMENT "id for the club the hold was generated for",
4217
    biblio_id INT(11) NOT NULL, -- id for the bibliographic record the hold has been placed against
4217
    biblio_id INT(11) NOT NULL COMMENT "id for the bibliographic record the hold has been placed against",
4218
    item_id   INT(11) NULL DEFAULT NULL, -- If item-level, the id for the item the hold has been placed agains
4218
    item_id   INT(11) NULL DEFAULT NULL COMMENT "If item-level, the id for the item the hold has been placed agains",
4219
    date_created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Timestamp for the placed hold
4219
    date_created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "Timestamp for the placed hold",
4220
    PRIMARY KEY (id),
4220
    PRIMARY KEY (id),
4221
    -- KEY club_id (club_id),
4221
    -- KEY club_id (club_id),
4222
    CONSTRAINT clubs_holds_ibfk_1 FOREIGN KEY (club_id)   REFERENCES clubs  (id) ON DELETE CASCADE ON UPDATE CASCADE,
4222
    CONSTRAINT clubs_holds_ibfk_1 FOREIGN KEY (club_id)   REFERENCES clubs  (id) ON DELETE CASCADE ON UPDATE CASCADE,
Lines 4352-4376 CREATE TABLE `borrower_relationships` ( Link Here
4352
4352
4353
DROP TABLE IF EXISTS `illrequests`;
4353
DROP TABLE IF EXISTS `illrequests`;
4354
CREATE TABLE illrequests (
4354
CREATE TABLE illrequests (
4355
    illrequest_id serial PRIMARY KEY,           -- ILL request number
4355
    illrequest_id serial PRIMARY KEY COMMENT "ILL request number",
4356
    borrowernumber integer DEFAULT NULL,        -- Patron associated with request
4356
    borrowernumber integer DEFAULT NULL COMMENT "Patron associated with request",
4357
    biblio_id integer DEFAULT NULL,             -- Potential bib linked to request
4357
    biblio_id integer DEFAULT NULL COMMENT "Potential bib linked to request",
4358
    branchcode varchar(50) NOT NULL,            -- The branch associated with the request
4358
    branchcode varchar(50) NOT NULL COMMENT "The branch associated with the request",
4359
    status varchar(50) DEFAULT NULL,            -- Current Koha status of request
4359
    status varchar(50) DEFAULT NULL COMMENT "Current Koha status of request",
4360
    status_alias varchar(80) DEFAULT NULL,      -- Foreign key to relevant authorised_values.authorised_value
4360
    status_alias varchar(80) DEFAULT NULL COMMENT "Foreign key to relevant authorised_values.authorised_value",
4361
    placed date DEFAULT NULL,                   -- Date the request was placed
4361
    placed date DEFAULT NULL COMMENT "Date the request was placed",
4362
    replied date DEFAULT NULL,                  -- Last API response
4362
    replied date DEFAULT NULL COMMENT "Last API response",
4363
    updated timestamp DEFAULT CURRENT_TIMESTAMP -- Last modification to request
4363
    updated timestamp DEFAULT CURRENT_TIMESTAMP -- Last modification to request
4364
      ON UPDATE CURRENT_TIMESTAMP,
4364
      ON UPDATE CURRENT_TIMESTAMP,
4365
    completed date DEFAULT NULL,                -- Date the request was completed
4365
    completed date DEFAULT NULL COMMENT "Date the request was completed",
4366
    medium varchar(30) DEFAULT NULL,            -- The Koha request type
4366
    medium varchar(30) DEFAULT NULL COMMENT "The Koha request type",
4367
    accessurl varchar(500) DEFAULT NULL,        -- Potential URL for accessing item
4367
    accessurl varchar(500) DEFAULT NULL COMMENT "Potential URL for accessing item",
4368
    cost varchar(20) DEFAULT NULL,              -- Quotes cost of request
4368
    cost varchar(20) DEFAULT NULL COMMENT "Quotes cost of request",
4369
    price_paid varchar(20) DEFAULT NULL,              -- Final cost of request
4369
    price_paid varchar(20) DEFAULT NULL COMMENT "Final cost of request",
4370
    notesopac MEDIUMTEXT DEFAULT NULL,                -- Patron notes attached to request
4370
    notesopac MEDIUMTEXT DEFAULT NULL COMMENT "Patron notes attached to request",
4371
    notesstaff MEDIUMTEXT DEFAULT NULL,               -- Staff notes attached to request
4371
    notesstaff MEDIUMTEXT DEFAULT NULL COMMENT "Staff notes attached to request",
4372
    orderid varchar(50) DEFAULT NULL,           -- Backend id attached to request
4372
    orderid varchar(50) DEFAULT NULL COMMENT "Backend id attached to request",
4373
    backend varchar(20) DEFAULT NULL,           -- The backend used to create request
4373
    backend varchar(20) DEFAULT NULL COMMENT "The backend used to create request",
4374
    CONSTRAINT `illrequests_bnfk`
4374
    CONSTRAINT `illrequests_bnfk`
4375
      FOREIGN KEY (`borrowernumber`)
4375
      FOREIGN KEY (`borrowernumber`)
4376
      REFERENCES `borrowers` (`borrowernumber`)
4376
      REFERENCES `borrowers` (`borrowernumber`)
Lines 4391-4400 CREATE TABLE illrequests ( Link Here
4391
4391
4392
DROP TABLE IF EXISTS `illrequestattributes`;
4392
DROP TABLE IF EXISTS `illrequestattributes`;
4393
CREATE TABLE illrequestattributes (
4393
CREATE TABLE illrequestattributes (
4394
    illrequest_id bigint(20) unsigned NOT NULL, -- ILL request number
4394
    illrequest_id bigint(20) unsigned NOT NULL COMMENT "ILL request number",
4395
    type varchar(200) NOT NULL,                 -- API ILL property name
4395
    type varchar(200) NOT NULL COMMENT "API ILL property name",
4396
    value MEDIUMTEXT NOT NULL,                  -- API ILL property value
4396
    value MEDIUMTEXT NOT NULL COMMENT "API ILL property value",
4397
    readonly tinyint(1) NOT NULL DEFAULT 1,     -- Is this attribute read only
4397
    readonly tinyint(1) NOT NULL DEFAULT 1 COMMENT "Is this attribute read only",
4398
    PRIMARY KEY  (`illrequest_id`, `type` (191)),
4398
    PRIMARY KEY  (`illrequest_id`, `type` (191)),
4399
    CONSTRAINT `illrequestattributes_ifk`
4399
    CONSTRAINT `illrequestattributes_ifk`
4400
      FOREIGN KEY (illrequest_id)
4400
      FOREIGN KEY (illrequest_id)
Lines 4408-4424 CREATE TABLE illrequestattributes ( Link Here
4408
4408
4409
DROP TABLE IF EXISTS `library_groups`;
4409
DROP TABLE IF EXISTS `library_groups`;
4410
CREATE TABLE library_groups (
4410
CREATE TABLE library_groups (
4411
    id INT(11) NOT NULL auto_increment,    -- unique id for each group
4411
    id INT(11) NOT NULL auto_increment COMMENT "unique id for each group",
4412
    parent_id INT(11) NULL DEFAULT NULL,   -- if this is a child group, the id of the parent group
4412
    parent_id INT(11) NULL DEFAULT NULL COMMENT "if this is a child group, the id of the parent group",
4413
    branchcode VARCHAR(10) NULL DEFAULT NULL, -- The branchcode of a branch belonging to the parent group
4413
    branchcode VARCHAR(10) NULL DEFAULT NULL COMMENT "The branchcode of a branch belonging to the parent group",
4414
    title VARCHAR(100) NULL DEFAULT NULL,     -- Short description of the goup
4414
    title VARCHAR(100) NULL DEFAULT NULL COMMENT "Short description of the goup",
4415
    description MEDIUMTEXT NULL DEFAULT NULL,    -- Longer explanation of the group, if necessary
4415
    description MEDIUMTEXT NULL DEFAULT NULL COMMENT "Longer explanation of the group, if necessary",
4416
    ft_hide_patron_info tinyint(1) NOT NULL DEFAULT 0, -- Turn on the feature "Hide patron's info" for this group
4416
    ft_hide_patron_info tinyint(1) NOT NULL DEFAULT 0 COMMENT "Turn on the feature "Hide patron's info" for this group",
4417
    ft_search_groups_opac tinyint(1) NOT NULL DEFAULT 0, -- Use this group for staff side search groups
4417
    ft_search_groups_opac tinyint(1) NOT NULL DEFAULT 0 COMMENT "Use this group for staff side search groups",
4418
    ft_search_groups_staff tinyint(1) NOT NULL DEFAULT 0, -- Use this group for opac side search groups
4418
    ft_search_groups_staff tinyint(1) NOT NULL DEFAULT 0 COMMENT "Use this group for opac side search groups",
4419
    ft_local_hold_group tinyint(1) NOT NULL DEFAULT 0, -- Use this group to identify libraries as pick up location for holds
4419
    ft_local_hold_group tinyint(1) NOT NULL DEFAULT 0 COMMENT "Use this group to identify libraries as pick up location for holds",
4420
    created_on TIMESTAMP NULL,             -- Date and time of creation
4420
    created_on TIMESTAMP NULL COMMENT "Date and time of creation",
4421
    updated_on TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, -- Date and time of last
4421
    updated_on TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT "Date and time of last",
4422
    PRIMARY KEY id ( id ),
4422
    PRIMARY KEY id ( id ),
4423
    FOREIGN KEY (parent_id) REFERENCES library_groups(id) ON UPDATE CASCADE ON DELETE CASCADE,
4423
    FOREIGN KEY (parent_id) REFERENCES library_groups(id) ON UPDATE CASCADE ON DELETE CASCADE,
4424
    FOREIGN KEY (branchcode) REFERENCES branches(branchcode) ON UPDATE CASCADE ON DELETE CASCADE,
4424
    FOREIGN KEY (branchcode) REFERENCES branches(branchcode) ON UPDATE CASCADE ON DELETE CASCADE,
Lines 4432-4440 CREATE TABLE library_groups ( Link Here
4432
4432
4433
DROP TABLE IF EXISTS `oauth_access_tokens`;
4433
DROP TABLE IF EXISTS `oauth_access_tokens`;
4434
CREATE TABLE `oauth_access_tokens` (
4434
CREATE TABLE `oauth_access_tokens` (
4435
    `access_token` VARCHAR(191) NOT NULL, -- generarated access token
4435
    `access_token` VARCHAR(191) NOT NULL COMMENT "generarated access token",
4436
    `client_id`    VARCHAR(191) NOT NULL, -- the client id the access token belongs to
4436
    `client_id`    VARCHAR(191) NOT NULL COMMENT "the client id the access token belongs to",
4437
    `expires`      INT NOT NULL,          -- expiration time in seconds
4437
    `expires`      INT NOT NULL COMMENT "expiration time in seconds",
4438
    PRIMARY KEY (`access_token`)
4438
    PRIMARY KEY (`access_token`)
4439
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
4439
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
4440
4440
Lines 4444-4454 CREATE TABLE `oauth_access_tokens` ( Link Here
4444
4444
4445
DROP TABLE IF EXISTS `illcomments`;
4445
DROP TABLE IF EXISTS `illcomments`;
4446
CREATE TABLE illcomments (
4446
CREATE TABLE illcomments (
4447
    illcomment_id int(11) NOT NULL AUTO_INCREMENT, -- Unique ID of the comment
4447
    illcomment_id int(11) NOT NULL AUTO_INCREMENT COMMENT "Unique ID of the comment",
4448
    illrequest_id bigint(20) unsigned NOT NULL,    -- ILL request number
4448
    illrequest_id bigint(20) unsigned NOT NULL COMMENT "ILL request number",
4449
    borrowernumber integer DEFAULT NULL,           -- Link to the user who made the comment (could be librarian, patron or ILL partner library)
4449
    borrowernumber integer DEFAULT NULL COMMENT "Link to the user who made the comment (could be librarian, patron or ILL partner library)",
4450
    comment text DEFAULT NULL,                     -- The text of the comment
4450
    comment text DEFAULT NULL COMMENT "The text of the comment",
4451
    timestamp timestamp DEFAULT CURRENT_TIMESTAMP, -- Date and time when the comment was made
4451
    timestamp timestamp DEFAULT CURRENT_TIMESTAMP COMMENT "Date and time when the comment was made",
4452
    PRIMARY KEY  ( illcomment_id ),
4452
    PRIMARY KEY  ( illcomment_id ),
4453
    CONSTRAINT illcomments_bnfk
4453
    CONSTRAINT illcomments_bnfk
4454
      FOREIGN KEY ( borrowernumber )
4454
      FOREIGN KEY ( borrowernumber )
Lines 4486-4496 CREATE TABLE `circulation_rules` ( Link Here
4486
4486
4487
DROP TABLE IF EXISTS stockrotationrotas;
4487
DROP TABLE IF EXISTS stockrotationrotas;
4488
CREATE TABLE stockrotationrotas (
4488
CREATE TABLE stockrotationrotas (
4489
    rota_id int(11) auto_increment,         -- Stockrotation rota ID
4489
    rota_id int(11) auto_increment COMMENT "Stockrotation rota ID",
4490
    title varchar(100) NOT NULL,            -- Title for this rota
4490
    title varchar(100) NOT NULL COMMENT "Title for this rota",
4491
    description text NOT NULL,              -- Description for this rota
4491
    description text NOT NULL COMMENT "Description for this rota",
4492
    cyclical tinyint(1) NOT NULL default 0, -- Should items on this rota keep cycling?
4492
    cyclical tinyint(1) NOT NULL default 0 COMMENT "Should items on this rota keep cycling?",
4493
    active tinyint(1) NOT NULL default 0,   -- Is this rota currently active?
4493
    active tinyint(1) NOT NULL default 0 COMMENT "Is this rota currently active?",
4494
    PRIMARY KEY (`rota_id`)
4494
    PRIMARY KEY (`rota_id`)
4495
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
4495
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
4496
4496
Lines 4500-4510 CREATE TABLE stockrotationrotas ( Link Here
4500
4500
4501
DROP TABLE IF EXISTS stockrotationstages;
4501
DROP TABLE IF EXISTS stockrotationstages;
4502
CREATE TABLE stockrotationstages (
4502
CREATE TABLE stockrotationstages (
4503
    stage_id int(11) auto_increment,     -- Unique stage ID
4503
    stage_id int(11) auto_increment COMMENT "Unique stage ID",
4504
    position int(11) NOT NULL,           -- The position of this stage within its rota
4504
    position int(11) NOT NULL COMMENT "The position of this stage within its rota",
4505
    rota_id int(11) NOT NULL,            -- The rota this stage belongs to
4505
    rota_id int(11) NOT NULL COMMENT "The rota this stage belongs to",
4506
    branchcode_id varchar(10) NOT NULL,  -- Branch this stage relates to
4506
    branchcode_id varchar(10) NOT NULL COMMENT "Branch this stage relates to",
4507
    duration int(11) NOT NULL default 4, -- The number of days items shoud occupy this stage
4507
    duration int(11) NOT NULL default 4 COMMENT "The number of days items shoud occupy this stage",
4508
    PRIMARY KEY (`stage_id`),
4508
    PRIMARY KEY (`stage_id`),
4509
    CONSTRAINT `stockrotationstages_rifk`
4509
    CONSTRAINT `stockrotationstages_rifk`
4510
      FOREIGN KEY (`rota_id`)
4510
      FOREIGN KEY (`rota_id`)
Lines 4522-4531 CREATE TABLE stockrotationstages ( Link Here
4522
4522
4523
DROP TABLE IF EXISTS stockrotationitems;
4523
DROP TABLE IF EXISTS stockrotationitems;
4524
CREATE TABLE stockrotationitems (
4524
CREATE TABLE stockrotationitems (
4525
    itemnumber_id int(11) NOT NULL,         -- Itemnumber to link to a stage & rota
4525
    itemnumber_id int(11) NOT NULL COMMENT "Itemnumber to link to a stage & rota",
4526
    stage_id int(11) NOT NULL,              -- stage ID to link the item to
4526
    stage_id int(11) NOT NULL COMMENT "stage ID to link the item to",
4527
    indemand tinyint(1) NOT NULL default 0, -- Should this item be skipped for rotation?
4527
    indemand tinyint(1) NOT NULL default 0 COMMENT "Should this item be skipped for rotation?",
4528
    fresh tinyint(1) NOT NULL default 0,    -- Flag showing item is only just added to rota
4528
    fresh tinyint(1) NOT NULL default 0 COMMENT "Flag showing item is only just added to rota",
4529
    PRIMARY KEY (itemnumber_id),
4529
    PRIMARY KEY (itemnumber_id),
4530
    CONSTRAINT `stockrotationitems_iifk`
4530
    CONSTRAINT `stockrotationitems_iifk`
4531
      FOREIGN KEY (`itemnumber_id`)
4531
      FOREIGN KEY (`itemnumber_id`)
Lines 4566-4583 CREATE TABLE itemtypes_branches( -- association table between authorised_values Link Here
4566
4566
4567
DROP TABLE IF EXISTS `return_claims`;
4567
DROP TABLE IF EXISTS `return_claims`;
4568
CREATE TABLE return_claims (
4568
CREATE TABLE return_claims (
4569
    id int(11) auto_increment,                             -- Unique ID of the return claim
4569
    id int(11) auto_increment COMMENT "Unique ID of the return claim",
4570
    itemnumber int(11) NOT NULL,                           -- ID of the item
4570
    itemnumber int(11) NOT NULL COMMENT "ID of the item",
4571
    issue_id int(11) NULL DEFAULT NULL,                    -- ID of the checkout that triggered the claim
4571
    issue_id int(11) NULL DEFAULT NULL COMMENT "ID of the checkout that triggered the claim",
4572
    borrowernumber int(11) NOT NULL,                       -- ID of the patron
4572
    borrowernumber int(11) NOT NULL COMMENT "ID of the patron",
4573
    notes MEDIUMTEXT DEFAULT NULL,                         -- Notes about the claim
4573
    notes MEDIUMTEXT DEFAULT NULL COMMENT "Notes about the claim",
4574
    created_on TIMESTAMP NULL,                             -- Time and date the claim was created
4574
    created_on TIMESTAMP NULL COMMENT "Time and date the claim was created",
4575
    created_by int(11) NULL DEFAULT NULL,                  -- ID of the staff member that registered the claim
4575
    created_by int(11) NULL DEFAULT NULL COMMENT "ID of the staff member that registered the claim",
4576
    updated_on TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP, -- Time and date of the latest change on the claim (notes)
4576
    updated_on TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP COMMENT "Time and date of the latest change on the claim (notes)",
4577
    updated_by int(11) NULL DEFAULT NULL,                  -- ID of the staff member that updated the claim
4577
    updated_by int(11) NULL DEFAULT NULL COMMENT "ID of the staff member that updated the claim",
4578
    resolution  varchar(80) NULL DEFAULT NULL,             -- Resolution code (RETURN_CLAIM_RESOLUTION AVs)
4578
    resolution  varchar(80) NULL DEFAULT NULL COMMENT "Resolution code (RETURN_CLAIM_RESOLUTION AVs)",
4579
    resolved_on TIMESTAMP NULL DEFAULT NULL,               -- Time and date the claim was resolved
4579
    resolved_on TIMESTAMP NULL DEFAULT NULL COMMENT "Time and date the claim was resolved",
4580
    resolved_by int(11) NULL DEFAULT NULL,                 -- ID of the staff member that resolved the claim
4580
    resolved_by int(11) NULL DEFAULT NULL COMMENT "ID of the staff member that resolved the claim",
4581
    PRIMARY KEY (`id`),
4581
    PRIMARY KEY (`id`),
4582
    KEY `itemnumber` (`itemnumber`),
4582
    KEY `itemnumber` (`itemnumber`),
4583
    CONSTRAINT UNIQUE `issue_id` ( issue_id ),
4583
    CONSTRAINT UNIQUE `issue_id` ( issue_id ),
Lines 4595-4610 CREATE TABLE return_claims ( Link Here
4595
4595
4596
DROP TABLE IF EXISTS `problem_reports`;
4596
DROP TABLE IF EXISTS `problem_reports`;
4597
CREATE TABLE `problem_reports` (
4597
CREATE TABLE `problem_reports` (
4598
    `reportid` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
4598
    `reportid` int(11) NOT NULL auto_increment COMMENT "unique identifier assigned by Koha",
4599
    `title` varchar(40) NOT NULL default '', -- report subject line
4599
    `title` varchar(40) NOT NULL default '' COMMENT "report subject line",
4600
    `content` varchar(255) NOT NULL default '', -- report message content
4600
    `content` varchar(255) NOT NULL default '' COMMENT "report message content",
4601
    `borrowernumber` int(11) NOT NULL default 0, -- the user who created the problem report
4601
    `borrowernumber` int(11) NOT NULL default 0 COMMENT "the user who created the problem report",
4602
    `branchcode` varchar(10) NOT NULL default '', -- borrower's branch
4602
    `branchcode` varchar(10) NOT NULL default '' COMMENT "borrower's branch",
4603
    `username` varchar(75) default NULL, -- OPAC username
4603
    `username` varchar(75) default NULL COMMENT "OPAC username",
4604
    `problempage` TEXT default NULL, -- page the user triggered the problem report form from
4604
    `problempage` TEXT default NULL COMMENT "page the user triggered the problem report form from",
4605
    `recipient` enum('admin','library') NOT NULL default 'library', -- the 'to-address' of the problem report
4605
    `recipient` enum('admin','library') NOT NULL default 'library' COMMENT "the 'to-address' of the problem report",
4606
    `created_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, -- timestamp of report submission
4606
    `created_on` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT "timestamp of report submission",
4607
    `status` varchar(6) NOT NULL default 'New', -- status of the report. New, Viewed, Closed
4607
    `status` varchar(6) NOT NULL default 'New' COMMENT "status of the report. New, Viewed, Closed",
4608
    PRIMARY KEY (`reportid`),
4608
    PRIMARY KEY (`reportid`),
4609
    CONSTRAINT `problem_reports_ibfk1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE,
4609
    CONSTRAINT `problem_reports_ibfk1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE CASCADE ON UPDATE CASCADE,
4610
    CONSTRAINT `problem_reports_ibfk2` FOREIGN KEY (`branchcode`) REFERENCES `branches` (`branchcode`) ON DELETE CASCADE ON UPDATE CASCADE
4610
    CONSTRAINT `problem_reports_ibfk2` FOREIGN KEY (`branchcode`) REFERENCES `branches` (`branchcode`) ON DELETE CASCADE ON UPDATE CASCADE
Lines 4616-4626 CREATE TABLE `problem_reports` ( Link Here
4616
4616
4617
DROP TABLE IF EXISTS advanced_editor_macros;
4617
DROP TABLE IF EXISTS advanced_editor_macros;
4618
CREATE TABLE advanced_editor_macros (
4618
CREATE TABLE advanced_editor_macros (
4619
    id INT(11) NOT NULL AUTO_INCREMENT,     -- Unique ID of the macro
4619
    id INT(11) NOT NULL AUTO_INCREMENT COMMENT "Unique ID of the macro",
4620
    name varchar(80) NOT NULL,              -- Name of the macro
4620
    name varchar(80) NOT NULL COMMENT "Name of the macro",
4621
    macro longtext NULL,                    -- The macro code itself
4621
    macro longtext NULL COMMENT "The macro code itself",
4622
    borrowernumber INT(11) default NULL,    -- ID of the borrower who created this macro
4622
    borrowernumber INT(11) default NULL COMMENT "ID of the borrower who created this macro",
4623
    shared TINYINT(1) default 0,            -- Bit to define if shared or private macro
4623
    shared TINYINT(1) default 0 COMMENT "Bit to define if shared or private macro",
4624
    PRIMARY KEY (id),
4624
    PRIMARY KEY (id),
4625
    CONSTRAINT borrower_macro_fk FOREIGN KEY ( borrowernumber ) REFERENCES borrowers ( borrowernumber ) ON UPDATE CASCADE ON DELETE CASCADE
4625
    CONSTRAINT borrower_macro_fk FOREIGN KEY ( borrowernumber ) REFERENCES borrowers ( borrowernumber ) ON UPDATE CASCADE ON DELETE CASCADE
4626
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
4626
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
4627
- 

Return to bug 26947