Open-ILS/src/sql/Pg/030.schema.metabib.sql

   1 /*
   2  * Copyright (C) 2004-2008  Georgia Public Library Service
   3  * Copyright (C) 2007-2008  Equinox Software, Inc.
   4  * Mike Rylander <miker@esilibrary.com>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  */
  17
  18 DROP SCHEMA metabib CASCADE;
  19
  20 BEGIN;
  21 CREATE SCHEMA metabib;
  22
  23 CREATE TABLE metabib.metarecord (
  24         id              BIGSERIAL       PRIMARY KEY,
  25         fingerprint     TEXT            NOT NULL,
  26         master_record   BIGINT,
  27         mods            TEXT
  28 );
  29 CREATE INDEX metabib_metarecord_master_record_idx ON metabib.metarecord (master_record);
  30 CREATE INDEX metabib_metarecord_fingerprint_idx ON metabib.metarecord (fingerprint);
  31
  32 CREATE TABLE metabib.title_field_entry (
  33         id              BIGSERIAL       PRIMARY KEY,
  34         source          BIGINT          NOT NULL,
  35         field           INT             NOT NULL,
  36         value           TEXT            NOT NULL,
  37         index_vector    tsvector        NOT NULL
  38 );
  39 CREATE TRIGGER metabib_title_field_entry_fti_trigger
  40         BEFORE UPDATE OR INSERT ON metabib.title_field_entry
  41         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('title');
  42
  43 CREATE INDEX metabib_title_field_entry_index_vector_idx ON metabib.title_field_entry USING GIST (index_vector);
  44
  45
  46 CREATE TABLE metabib.author_field_entry (
  47         id              BIGSERIAL       PRIMARY KEY,
  48         source          BIGINT          NOT NULL,
  49         field           INT             NOT NULL,
  50         value           TEXT            NOT NULL,
  51         index_vector    tsvector        NOT NULL
  52 );
  53 CREATE TRIGGER metabib_author_field_entry_fti_trigger
  54         BEFORE UPDATE OR INSERT ON metabib.author_field_entry
  55         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('author');
  56
  57 CREATE INDEX metabib_author_field_entry_index_vector_idx ON metabib.author_field_entry USING GIST (index_vector);
  58
  59
  60 CREATE TABLE metabib.subject_field_entry (
  61         id              BIGSERIAL       PRIMARY KEY,
  62         source          BIGINT          NOT NULL,
  63         field           INT             NOT NULL,
  64         value           TEXT            NOT NULL,
  65         index_vector    tsvector        NOT NULL
  66 );
  67 CREATE TRIGGER metabib_subject_field_entry_fti_trigger
  68         BEFORE UPDATE OR INSERT ON metabib.subject_field_entry
  69         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('subject');
  70
  71 CREATE INDEX metabib_subject_field_entry_index_vector_idx ON metabib.subject_field_entry USING GIST (index_vector);
  72 CREATE INDEX metabib_subject_field_entry_source_idx ON metabib.subject_field_entry (source);
  73
  74
  75 CREATE TABLE metabib.keyword_field_entry (
  76         id              BIGSERIAL       PRIMARY KEY,
  77         source          BIGINT          NOT NULL,
  78         field           INT             NOT NULL,
  79         value           TEXT            NOT NULL,
  80         index_vector    tsvector        NOT NULL
  81 );
  82 CREATE TRIGGER metabib_keyword_field_entry_fti_trigger
  83         BEFORE UPDATE OR INSERT ON metabib.keyword_field_entry
  84         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('keyword');
  85
  86 CREATE INDEX metabib_keyword_field_entry_index_vector_idx ON metabib.keyword_field_entry USING GIST (index_vector);
  87
  88
  89 CREATE TABLE metabib.series_field_entry (
  90         id              BIGSERIAL       PRIMARY KEY,
  91         source          BIGINT          NOT NULL,
  92         field           INT             NOT NULL,
  93         value           TEXT            NOT NULL,
  94         index_vector    tsvector        NOT NULL
  95 );
  96 CREATE TRIGGER metabib_series_field_entry_fti_trigger
  97         BEFORE UPDATE OR INSERT ON metabib.series_field_entry
  98         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('series');
  99
 100 CREATE INDEX metabib_series_field_entry_index_vector_idx ON metabib.series_field_entry USING GIST (index_vector);
 101
 102
 103 CREATE TABLE metabib.rec_descriptor (
 104         id              BIGSERIAL PRIMARY KEY,
 105         record          BIGINT,
 106         item_type       TEXT,
 107         item_form       TEXT,
 108         bib_level       TEXT,
 109         control_type    TEXT,
 110         char_encoding   TEXT,
 111         enc_level       TEXT,
 112         audience        TEXT,
 113         lit_form        TEXT,
 114         type_mat        TEXT,
 115         cat_form        TEXT,
 116         pub_status      TEXT,
 117         item_lang       TEXT,
 118         vr_format       TEXT,
 119         date1           TEXT,
 120         date2           TEXT
 121 );
 122 CREATE INDEX metabib_rec_descriptor_record_idx ON metabib.rec_descriptor (record);
 123 /* We may not need these...
 124
 125 CREATE INDEX metabib_rec_descriptor_item_type_idx ON metabib.rec_descriptor (item_type);
 126 CREATE INDEX metabib_rec_descriptor_item_form_idx ON metabib.rec_descriptor (item_form);
 127 CREATE INDEX metabib_rec_descriptor_bib_level_idx ON metabib.rec_descriptor (bib_level);
 128 CREATE INDEX metabib_rec_descriptor_control_type_idx ON metabib.rec_descriptor (control_type);
 129 CREATE INDEX metabib_rec_descriptor_char_encoding_idx ON metabib.rec_descriptor (char_encoding);
 130 CREATE INDEX metabib_rec_descriptor_enc_level_idx ON metabib.rec_descriptor (enc_level);
 131 CREATE INDEX metabib_rec_descriptor_audience_idx ON metabib.rec_descriptor (audience);
 132 CREATE INDEX metabib_rec_descriptor_lit_form_idx ON metabib.rec_descriptor (lit_form);
 133 CREATE INDEX metabib_rec_descriptor_cat_form_idx ON metabib.rec_descriptor (cat_form);
 134 CREATE INDEX metabib_rec_descriptor_pub_status_idx ON metabib.rec_descriptor (pub_status);
 135 CREATE INDEX metabib_rec_descriptor_item_lang_idx ON metabib.rec_descriptor (item_lang);
 136 CREATE INDEX metabib_rec_descriptor_vr_format_idx ON metabib.rec_descriptor (vr_format);
 137
 138 */
 139
 140 -- Use a sequence that matches previous version, for easier upgrading.
 141 CREATE SEQUENCE metabib.full_rec_id_seq;
 142
 143 CREATE TABLE metabib.real_full_rec (
 144         id                  BIGINT      NOT NULL DEFAULT NEXTVAL('metabib.full_rec_id_seq'::REGCLASS),
 145         record          BIGINT          NOT NULL,
 146         tag             CHAR(3)         NOT NULL,
 147         ind1            TEXT,
 148         ind2            TEXT,
 149         subfield        TEXT,
 150         value           TEXT            NOT NULL,
 151         index_vector    tsvector        NOT NULL
 152 );
 153 ALTER TABLE metabib.real_full_rec ADD PRIMARY KEY (id);
 154
 155 CREATE INDEX metabib_full_rec_tag_subfield_idx ON metabib.real_full_rec (tag,subfield);
 156 CREATE INDEX metabib_full_rec_value_idx ON metabib.real_full_rec (substring(value,1,1024));
 157 /* Enable LIKE to use an index for database clusters with locales other than C or POSIX */
 158 CREATE INDEX metabib_full_rec_value_tpo_index ON metabib.real_full_rec (substring(value,1,1024) text_pattern_ops);
 159 CREATE INDEX metabib_full_rec_record_idx ON metabib.real_full_rec (record);
 160 CREATE INDEX metabib_full_rec_index_vector_idx ON metabib.real_full_rec USING GIST (index_vector);
 161
 162 CREATE TRIGGER metabib_full_rec_fti_trigger
 163         BEFORE UPDATE OR INSERT ON metabib.real_full_rec
 164         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('default');
 165
 166 CREATE OR REPLACE VIEW metabib.full_rec AS
 167     SELECT  id,
 168             record,
 169             tag,
 170             ind1,
 171             ind2,
 172             subfield,
 173             SUBSTRING(value,1,1024) AS value,
 174             index_vector
 175       FROM  metabib.real_full_rec;
 176
 177 CREATE OR REPLACE RULE metabib_full_rec_insert_rule
 178     AS ON INSERT TO metabib.full_rec
 179     DO INSTEAD
 180     INSERT INTO metabib.real_full_rec VALUES (
 181         COALESCE(NEW.id, NEXTVAL('metabib.full_rec_id_seq'::REGCLASS)),
 182         NEW.record,
 183         NEW.tag,
 184         NEW.ind1,
 185         NEW.ind2,
 186         NEW.subfield,
 187         NEW.value,
 188         NEW.index_vector
 189     );
 190
 191 CREATE OR REPLACE RULE metabib_full_rec_update_rule
 192     AS ON UPDATE TO metabib.full_rec
 193     DO INSTEAD
 194     UPDATE  metabib.real_full_rec SET
 195         id = NEW.id,
 196         record = NEW.record,
 197         tag = NEW.tag,
 198         ind1 = NEW.ind1,
 199         ind2 = NEW.ind2,
 200         subfield = NEW.subfield,
 201         value = NEW.value,
 202         index_vector = NEW.index_vector
 203       WHERE id = OLD.id;
 204
 205 CREATE OR REPLACE RULE metabib_full_rec_delete_rule
 206     AS ON DELETE TO metabib.full_rec
 207     DO INSTEAD
 208     DELETE FROM metabib.real_full_rec WHERE id = OLD.id;
 209
 210 CREATE TABLE metabib.metarecord_source_map (
 211         id              BIGSERIAL       PRIMARY KEY,
 212         metarecord      BIGINT          NOT NULL,
 213         source          BIGINT          NOT NULL
 214 );
 215 CREATE INDEX metabib_metarecord_source_map_metarecord_idx ON metabib.metarecord_source_map (metarecord);
 216 CREATE INDEX metabib_metarecord_source_map_source_record_idx ON metabib.metarecord_source_map (source);
 217
 218 CREATE FUNCTION version_specific_xpath () RETURNS TEXT AS $wrapper_function$
 219 DECLARE
 220         out_text TEXT;
 221 BEGIN
 222
 223         IF REGEXP_REPLACE(VERSION(),E'^.+?(\\d+\\.\\d+).*?$',E'\\1')::FLOAT < 8.3 THEN
 224                 out_text := 'Creating XPath functions that work like the native XPATH function in 8.3+';
 225
 226                 EXECUTE $create_82_funcs$
 227
 228 CREATE OR REPLACE FUNCTION oils_xpath ( xpath TEXT, xml TEXT, ns ANYARRAY ) RETURNS TEXT[] AS $func$
 229 DECLARE
 230         node_text       TEXT;
 231         ns_regexp       TEXT;
 232         munged_xpath    TEXT;
 233 BEGIN
 234
 235         munged_xpath := xpath;
 236
 237         IF ns IS NOT NULL THEN
 238                 FOR namespace IN 1 .. array_upper(ns, 1) LOOP
 239                         munged_xpath := REGEXP_REPLACE(
 240                                 munged_xpath,
 241                                 E'(' || ns[namespace][1] || E'):(\\w+)',
 242                                 E'*[local-name() = "\\2" and namespace-uri() = "' || ns[namespace][2] || E'"]',
 243                                 'g'
 244                         );
 245                 END LOOP;
 246
 247                 munged_xpath := REGEXP_REPLACE( munged_xpath, E'\\]\\[(\\D)',E' and \\1', 'g');
 248         END IF;
 249
 250         node_text := xpath_nodeset(xml, munged_xpath, 'XXX_OILS_NODESET');
 251         node_text := REGEXP_REPLACE(node_text,'^<XXX_OILS_NODESET>', '');
 252         node_text := REGEXP_REPLACE(node_text,'</XXX_OILS_NODESET>$', '');
 253
 254         RETURN  STRING_TO_ARRAY(node_text, '</XXX_OILS_NODESET><XXX_OILS_NODESET>');
 255 END;
 256 $func$ LANGUAGE PLPGSQL;
 257
 258 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT ) RETURNS TEXT[] AS 'SELECT oils_xpath( $1, $2, NULL::TEXT[] );' LANGUAGE SQL;
 259
 260                 $create_82_funcs$;
 261         ELSE
 262                 out_text := 'Creating XPath wrapper functions around the native XPATH function in 8.3+';
 263
 264                 EXECUTE $create_83_funcs$
 265 -- 8.3 or after
 266 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT, ANYARRAY ) RETURNS TEXT[] AS 'SELECT XPATH( $1, $2::XML, $3 )::TEXT[];' LANGUAGE SQL;
 267 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT ) RETURNS TEXT[] AS 'SELECT XPATH( $1, $2::XML )::TEXT[];' LANGUAGE SQL;
 268
 269                 $create_83_funcs$;
 270
 271         END IF;
 272
 273         RETURN out_text;
 274 END;
 275 $wrapper_function$ LANGUAGE PLPGSQL;
 276
 277 SELECT version_specific_xpath();
 278 DROP FUNCTION version_specific_xpath();
 279
 280 CREATE TYPE metabib.field_entry_template AS (
 281         field_class     TEXT,
 282         field           INT,
 283         source          BIGINT,
 284         value           TEXT
 285 );
 286
 287 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( rid INT, default_joiner TEXT ) RETURNS SETOF metabib.field_entry_template AS $func$
 288 DECLARE
 289         bib             biblio.record_entry%ROWTYPE;
 290         idx             config.metabib_field%ROWTYPE;
 291         xfrm            config.xml_transform%ROWTYPE;
 292         prev_xfrm       TEXT;
 293         transformed_xml TEXT;
 294         xml_node        TEXT;
 295         xml_node_list   TEXT[];
 296         raw_text        TEXT;
 297         joiner          TEXT := default_joiner; -- XXX will index defs supply a joiner?
 298         output_row      metabib.field_entry_template%ROWTYPE;
 299 BEGIN
 300
 301         -- Get the record
 302         SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
 303
 304         -- Loop over the indexing entries
 305         FOR idx IN SELECT * FROM config.metabib_field ORDER BY format LOOP
 306
 307                 SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
 308
 309                 -- See if we can skip the XSLT ... it's expensive
 310                 IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
 311                         -- Can't skip the transform
 312                         IF xfrm.xslt <> '---' THEN
 313                                 transformed_xml := xslt_process(bib.marc,xfrm.xslt);
 314                         ELSE
 315                                 transformed_xml := bib.marc;
 316                         END IF;
 317
 318                         prev_xfrm := xfrm.name;
 319                 END IF;
 320
 321                 xml_node_list := oils_xpath( idx.xpath, transformed_xml, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 322
 323                 raw_text := NULL;
 324                 FOR xml_node IN SELECT x FROM explode_array(xml_node_list) AS x LOOP
 325                         IF raw_text IS NOT NULL THEN
 326                                 raw_text := raw_text || joiner;
 327                         END IF;
 328                         raw_text := COALESCE(raw_text,'') || ARRAY_TO_STRING(oils_xpath( '//text()', xml_node ), ' ');
 329                 END LOOP;
 330
 331                 CONTINUE WHEN raw_text IS NULL;
 332
 333                 output_row.field_class = idx.field_class;
 334                 output_row.field = idx.id;
 335                 output_row.source = rid;
 336                 output_row.value = BTRIM(REGEXP_REPLACE(raw_text, E'\\s+', ' ', 'gs'));
 337
 338                 RETURN NEXT output_row;
 339
 340         END LOOP;
 341
 342 END;
 343 $func$ LANGUAGE PLPGSQL;
 344
 345 -- default to a space joiner
 346 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( INT ) RETURNS SETOF metabib.field_entry_template AS $func$
 347         SELECT * FROM biblio.extract_metabib_field_entry($1, ' ');
 348 $func$ LANGUAGE SQL;
 349
 350 COMMIT;
 351