Bug 6716 - Document z3950servers table

This patch documents the z3950servers table in Koha.  There are two
fields marked as unused (icon and description) and two fields that
were left undocumented because they contain data, but I am unsure
of where the data is coming from (position and type). A follow up
patch will be necessary to document these fields.

Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
This commit is contained in:
Nicole C. Engard 2011-08-26 23:49:25 -04:00 committed by Chris Cormack
parent c590d8f882
commit 5d413a7a9b

View file

@ -1991,22 +1991,22 @@ CREATE TABLE `virtualshelfcontents` (
-- --
DROP TABLE IF EXISTS `z3950servers`; DROP TABLE IF EXISTS `z3950servers`;
CREATE TABLE `z3950servers` ( CREATE TABLE `z3950servers` ( -- connection information for the Z39.50 targets used in cataloging
`host` varchar(255) default NULL, `host` varchar(255) default NULL, -- target's host name
`port` int(11) default NULL, `port` int(11) default NULL, -- port number used to connect to target
`db` varchar(255) default NULL, `db` varchar(255) default NULL, -- target's database name
`userid` varchar(255) default NULL, `userid` varchar(255) default NULL, -- username needed to log in to target
`password` varchar(255) default NULL, `password` varchar(255) default NULL, -- password needed to log in to target
`name` mediumtext, `name` mediumtext, -- name given to the target by the library
`id` int(11) NOT NULL auto_increment, `id` int(11) NOT NULL auto_increment, -- unique identifier assigned by Koha
`checked` smallint(6) default NULL, `checked` smallint(6) default NULL, -- whether this target is checked by default (1 for yes, 0 for no)
`rank` int(11) default NULL, `rank` int(11) default NULL, -- where this target appears in the list of targets
`syntax` varchar(80) default NULL, `syntax` varchar(80) default NULL, -- marc format provided by this target
`icon` text, `icon` text, -- unused in Koha
`position` enum('primary','secondary','') NOT NULL default 'primary', `position` enum('primary','secondary','') NOT NULL default 'primary',
`type` enum('zed','opensearch') NOT NULL default 'zed', `type` enum('zed','opensearch') NOT NULL default 'zed',
`encoding` text default NULL, `encoding` text default NULL, -- characters encoding provided by this target
`description` text NOT NULL, `description` text NOT NULL, -- unused in Koha
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;