From efbc83b4bb6999b77f9e7e764181d279b30d5823 Mon Sep 17 00:00:00 2001 From: miker Date: Tue, 5 Jul 2005 16:47:59 +0000 Subject: [PATCH] adding comments to objects git-svn-id: svn://svn.open-ils.org/ILS/trunk@1044 dcc99617-32d9-48b4-a31d-7c20da2025e4 --- Open-ILS/src/sql/Postgres/002.schema.config.sql | 289 +++++++++++++++++++++++- 1 file changed, 288 insertions(+), 1 deletion(-) diff --git a/Open-ILS/src/sql/Postgres/002.schema.config.sql b/Open-ILS/src/sql/Postgres/002.schema.config.sql index d528a99b56..05f932b51e 100644 --- a/Open-ILS/src/sql/Postgres/002.schema.config.sql +++ b/Open-ILS/src/sql/Postgres/002.schema.config.sql @@ -1,13 +1,60 @@ + DROP SCHEMA config CASCADE; BEGIN; CREATE SCHEMA config; +COMMENT ON SCHEMA config IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * The config schema holds static configuration data for the + * Open-ILS installation. + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + CREATE TABLE config.bib_source ( id SERIAL PRIMARY KEY, quality INT CHECK ( quality BETWEEN 0 AND 100 ), source TEXT NOT NULL UNIQUE ); +COMMENT ON TABLE config.bib_source IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Valid sources of MARC records + * + * This is table is used to set up the relative "quality" of each + * MARC source, such as OCLC. + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + INSERT INTO config.bib_source (quality, source) VALUES (90, 'OcLC'); INSERT INTO config.bib_source (quality, source) VALUES (10, 'System Local'); @@ -16,6 +63,32 @@ CREATE TABLE config.standing ( id SERIAL PRIMARY KEY, value TEXT NOT NULL UNIQUE ); +COMMENT ON TABLE config.standing IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Patron Standings + * + * This table contains the values that can be applied to a patron + * by a staff member. These values should not be changed, other + * that for translation, as the ID column is currently a "magic + * number" in the source. :( + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + INSERT INTO config.standing (value) VALUES ('Good'); INSERT INTO config.standing (value) VALUES ('Barred'); @@ -26,6 +99,32 @@ CREATE TABLE config.metabib_field ( name TEXT NOT NULL UNIQUE, xpath TEXT NOT NULL ); +COMMENT ON TABLE config.metabib_field IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * XPath used for WoRMing + * + * This table contains the XPath used to chop up MODS into it's + * indexable parts. Each XPath entry is named and assigned to + * a "class" of either title, subject, author, keyword or series. + * + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + INSERT INTO config.metabib_field ( field_class, name, xpath ) VALUES ( 'series', 'seriestitle', $$//mods:mods/mods:relatedItem[@type="series"]/mods:titleInfo$$ ); INSERT INTO config.metabib_field ( field_class, name, xpath ) VALUES ( 'title', 'abbreviated', $$//mods:mods/mods:titleInfo[mods:title and (@type='abreviated')]$$ ); @@ -47,6 +146,31 @@ CREATE TABLE config.identification_type ( id SERIAL PRIMARY KEY, name TEXT NOT NULL UNIQUE ); +COMMENT ON TABLE config.identification_type IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Types of valid patron identification. + * + * Each patron must display at least one valid form of identification + * in order to get a library card. This table lists those forms. + * + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + INSERT INTO config.identification_type ( name ) VALUES ( 'Drivers Licence' ); INSERT INTO config.identification_type ( name ) VALUES ( 'Voter Card' ); @@ -62,12 +186,61 @@ CREATE TABLE config.rule_circ_duration ( shrt INTERVAL NOT NULL, max_renewals INT NOT NULL ); +COMMENT ON TABLE config.rule_circ_duration IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Circulation Duration rules + * + * Each circulation is given a duration based on one of these rules. + * + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + CREATE TABLE config.rule_max_fine ( id SERIAL PRIMARY KEY, name TEXT NOT NULL UNIQUE CHECK ( name ~ '^\\w+$' ), amount NUMERIC(6,2) NOT NULL ); +COMMENT ON TABLE config.rule_max_fine IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Circulation Max Fine rules + * + * Each circulation is given a maximum fine based on one of + * these rules. + * + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + CREATE TABLE config.rule_recuring_fine ( id SERIAL PRIMARY KEY, @@ -77,19 +250,109 @@ CREATE TABLE config.rule_recuring_fine ( low NUMERIC(6,2) NOT NULL, recurance_interval INTERVAL NOT NULL DEFAULT '1 day'::INTERVAL ); +COMMENT ON TABLE config.rule_recuring_fine IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Circulation Recuring Fine rules + * + * Each circulation is given a recuring fine amount based on one of + * these rules. The recurance_interval should not be any shorter + * than the interval between runs of the fine_processor.pl script + * (which is run from CRON), or you could miss fines. + * + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + CREATE TABLE config.rule_age_hold_protect ( id SERIAL PRIMARY KEY, name TEXT NOT NULL UNIQUE CHECK ( name ~ '^\\w+$' ), age INTERVAL NOT NULL, - radius INT NOT NULL + prox INT NOT NULL ); +COMMENT ON TABLE config.rule_age_hold_protect IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Hold Item Age Protection rules + * + * A hold request can only capture new(ish) items when they are + * within a particular proximity of the home_ou of the requesting + * user. The proximity ('prox' column) is calculated by counting + * the number of tree edges beween the user's home_ou and the owning_lib + * of the copy that could fulfill the hold. + * + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + CREATE TABLE config.copy_status ( id SERIAL PRIMARY KEY, name TEXT NOT NULL UNIQUE, holdable BOOL NOT NULL DEFAULT 'F' ); +COMMENT ON TABLE config.copy_status IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Copy Statuses + * + * The available copy statuses, and whether a copy in that + * status is available for hold request capture. 0 (zero) is + * the only special number in this set, meaning that the item + * is available for imediate checkout, and is counted as available + * in the OPAC. + * + * Statuses with an ID below 100 are not removable, and have special + * meaning in the code. Do not change them except to translate the + * textual name. + * + * You may add and remove statuses above 100, and these can be used + * to remove items from normal circulation without affecting the rest + * of the copies values or it's location. + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + INSERT INTO config.copy_status (id,name,holdable) VALUES (0,'Available','t'); INSERT INTO config.copy_status (name,holdable) VALUES ('Checked out','t'); INSERT INTO config.copy_status (name) VALUES ('Bindery'); @@ -112,6 +375,30 @@ CREATE TABLE config.net_access_level ( id SERIAL PRIMARY KEY, name TEXT NOT NULL UNIQUE ); +COMMENT ON TABLE config.net_access_level IS $$ +/* + * Copyright (C) 2005 Georgia Public Library Service + * Mike Rylander + * + * Patron Network Access level + * + * This will be used to inform the in-library firewall of how much + * internet access the using patron should be allowed. + * + * **** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + */ +$$; + INSERT INTO config.net_access_level (name) VALUES ('Restricted'); INSERT INTO config.net_access_level (name) VALUES ('Full'); INSERT INTO config.net_access_level (name) VALUES ('None'); -- 2.11.0