Open-ILS/src/sql/Pg/reporter-schema.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 reporter CASCADE;
  19
  20 BEGIN;
  21
  22 CREATE SCHEMA reporter;
  23
  24 CREATE TABLE reporter.template_folder (
  25         id              SERIAL                          PRIMARY KEY,
  26         parent          INT                             REFERENCES reporter.template_folder (id) DEFERRABLE INITIALLY DEFERRED,
  27         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
  28         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
  29         name            TEXT                            NOT NULL,
  30         shared          BOOL                            NOT NULL DEFAULT FALSE,
  31         share_with      INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
  32 );
  33 CREATE INDEX rpt_tmpl_fldr_owner_idx ON reporter.template_folder (owner);
  34 CREATE UNIQUE INDEX rpt_template_folder_once_parent_idx ON reporter.template_folder (name,parent);
  35 CREATE UNIQUE INDEX rpt_template_folder_once_idx ON reporter.template_folder (name,owner) WHERE parent IS NULL;
  36
  37 CREATE TABLE reporter.report_folder (
  38         id              SERIAL                          PRIMARY KEY,
  39         parent          INT                             REFERENCES reporter.report_folder (id) DEFERRABLE INITIALLY DEFERRED,
  40         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
  41         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
  42         name            TEXT                            NOT NULL,
  43         shared          BOOL                            NOT NULL DEFAULT FALSE,
  44         share_with      INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
  45 );
  46 CREATE INDEX rpt_rpt_fldr_owner_idx ON reporter.report_folder (owner);
  47 CREATE UNIQUE INDEX rpt_report_folder_once_parent_idx ON reporter.report_folder (name,parent);
  48 CREATE UNIQUE INDEX rpt_report_folder_once_idx ON reporter.report_folder (name,owner) WHERE parent IS NULL;
  49
  50 CREATE TABLE reporter.output_folder (
  51         id              SERIAL                          PRIMARY KEY,
  52         parent          INT                             REFERENCES reporter.output_folder (id) DEFERRABLE INITIALLY DEFERRED,
  53         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
  54         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
  55         name            TEXT                            NOT NULL,
  56         shared          BOOL                            NOT NULL DEFAULT FALSE,
  57         share_with      INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
  58 );
  59 CREATE INDEX rpt_output_fldr_owner_idx ON reporter.output_folder (owner);
  60 CREATE UNIQUE INDEX rpt_output_folder_once_parent_idx ON reporter.output_folder (name,parent);
  61 CREATE UNIQUE INDEX rpt_output_folder_once_idx ON reporter.output_folder (name,owner) WHERE parent IS NULL;
  62
  63
  64 CREATE TABLE reporter.template (
  65         id              SERIAL                          PRIMARY KEY,
  66         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
  67         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
  68         name            TEXT                            NOT NULL,
  69         description     TEXT                            NOT NULL,
  70         data            TEXT                            NOT NULL,
  71         folder          INT                             NOT NULL REFERENCES reporter.template_folder (id) DEFERRABLE INITIALLY DEFERRED
  72 );
  73 CREATE INDEX rpt_tmpl_owner_idx ON reporter.template (owner);
  74 CREATE INDEX rpt_tmpl_fldr_idx ON reporter.template (folder);
  75 CREATE UNIQUE INDEX rtp_template_folder_once_idx ON reporter.template (name,folder);
  76
  77 CREATE TABLE reporter.report (
  78         id              SERIAL                          PRIMARY KEY,
  79         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
  80         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
  81         name            TEXT                            NOT NULL DEFAULT '',
  82         description     TEXT                            NOT NULL DEFAULT '',
  83         template        INT                             NOT NULL REFERENCES reporter.template (id) DEFERRABLE INITIALLY DEFERRED,
  84         data            TEXT                            NOT NULL,
  85         folder          INT                             NOT NULL REFERENCES reporter.report_folder (id) DEFERRABLE INITIALLY DEFERRED,
  86         recur           BOOL                            NOT NULL DEFAULT FALSE,
  87         recurance       INTERVAL
  88 );
  89 CREATE INDEX rpt_rpt_owner_idx ON reporter.report (owner);
  90 CREATE INDEX rpt_rpt_fldr_idx ON reporter.report (folder);
  91 CREATE UNIQUE INDEX rtp_report_folder_once_idx ON reporter.report (name,folder);
  92
  93 CREATE TABLE reporter.schedule (
  94         id              SERIAL                          PRIMARY KEY,
  95         report          INT                             NOT NULL REFERENCES reporter.report (id) DEFERRABLE INITIALLY DEFERRED,
  96         folder          INT                             NOT NULL REFERENCES reporter.output_folder (id) DEFERRABLE INITIALLY DEFERRED,
  97         runner          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
  98         run_time        TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
  99         start_time      TIMESTAMP WITH TIME ZONE,
 100         complete_time   TIMESTAMP WITH TIME ZONE,
 101         email           TEXT,
 102         excel_format    BOOL                            NOT NULL DEFAULT TRUE,
 103         html_format     BOOL                            NOT NULL DEFAULT TRUE,
 104         csv_format      BOOL                            NOT NULL DEFAULT TRUE,
 105         chart_pie       BOOL                            NOT NULL DEFAULT FALSE,
 106         chart_bar       BOOL                            NOT NULL DEFAULT FALSE,
 107         chart_line      BOOL                            NOT NULL DEFAULT FALSE,
 108         error_code      INT,
 109         error_text      TEXT
 110 );
 111 CREATE INDEX rpt_sched_runner_idx ON reporter.schedule (runner);
 112 CREATE INDEX rpt_sched_folder_idx ON reporter.schedule (folder);
 113
 114 CREATE OR REPLACE VIEW reporter.simple_record AS
 115 SELECT  r.id,
 116         s.metarecord,
 117         r.fingerprint,
 118         r.quality,
 119         r.tcn_source,
 120         r.tcn_value,
 121         title.value AS title,
 122         uniform_title.value AS uniform_title,
 123         author.value AS author,
 124         publisher.value AS publisher,
 125         SUBSTRING(pubdate.value FROM $$\d+$$) AS pubdate,
 126         series_title.value AS series_title,
 127         series_statement.value AS series_statement,
 128         summary.value AS summary,
 129         ARRAY_ACCUM( SUBSTRING(isbn.value FROM $$^\S+$$) ) AS isbn,
 130         ARRAY_ACCUM( SUBSTRING(issn.value FROM $$^\S+$$) ) AS issn,
 131         ARRAY((SELECT DISTINCT value FROM metabib.full_rec WHERE tag = '650' AND subfield = 'a' AND record = r.id)) AS topic_subject,
 132         ARRAY((SELECT DISTINCT value FROM metabib.full_rec WHERE tag = '651' AND subfield = 'a' AND record = r.id)) AS geographic_subject,
 133         ARRAY((SELECT DISTINCT value FROM metabib.full_rec WHERE tag = '655' AND subfield = 'a' AND record = r.id)) AS genre,
 134         ARRAY((SELECT DISTINCT value FROM metabib.full_rec WHERE tag = '600' AND subfield = 'a' AND record = r.id)) AS name_subject,
 135         ARRAY((SELECT DISTINCT value FROM metabib.full_rec WHERE tag = '610' AND subfield = 'a' AND record = r.id)) AS corporate_subject,
 136         ARRAY((SELECT value FROM metabib.full_rec WHERE tag = '856' AND subfield IN ('3','y','u') AND record = r.id ORDER BY CASE WHEN subfield IN ('3','y') THEN 0 ELSE 1 END)) AS external_uri
 137   FROM  biblio.record_entry r
 138         JOIN metabib.metarecord_source_map s ON (s.source = r.id)
 139         LEFT JOIN metabib.full_rec uniform_title ON (r.id = uniform_title.record AND uniform_title.tag = '240' AND uniform_title.subfield = 'a')
 140         LEFT JOIN metabib.full_rec title ON (r.id = title.record AND title.tag = '245' AND title.subfield = 'a')
 141         LEFT JOIN metabib.full_rec author ON (r.id = author.record AND author.tag = '100' AND author.subfield = 'a')
 142         LEFT JOIN metabib.full_rec publisher ON (r.id = publisher.record AND publisher.tag = '260' AND publisher.subfield = 'b')
 143         LEFT JOIN metabib.full_rec pubdate ON (r.id = pubdate.record AND pubdate.tag = '260' AND pubdate.subfield = 'c')
 144         LEFT JOIN metabib.full_rec isbn ON (r.id = isbn.record AND isbn.tag IN ('024', '020') AND isbn.subfield IN ('a','z'))
 145         LEFT JOIN metabib.full_rec issn ON (r.id = issn.record AND issn.tag = '022' AND issn.subfield = 'a')
 146         LEFT JOIN metabib.full_rec series_title ON (r.id = series_title.record AND series_title.tag IN ('830','440') AND series_title.subfield = 'a')
 147         LEFT JOIN metabib.full_rec series_statement ON (r.id = series_statement.record AND series_statement.tag = '490' AND series_statement.subfield = 'a')
 148         LEFT JOIN metabib.full_rec summary ON (r.id = summary.record AND summary.tag = '520' AND summary.subfield = 'a')
 149   GROUP BY 1,2,3,4,5,6,7,8,9,10,11,12,13,14;
 150
 151 CREATE OR REPLACE VIEW reporter.old_super_simple_record AS
 152 SELECT  r.id,
 153         r.fingerprint,
 154         r.quality,
 155         r.tcn_source,
 156         r.tcn_value,
 157         title.value AS title,
 158         FIRST(author.value) AS author,
 159         publisher.value AS publisher,
 160         SUBSTRING(pubdate.value FROM $$\d+$$) AS pubdate,
 161         ARRAY_ACCUM( SUBSTRING(isbn.value FROM $$^\S+$$) ) AS isbn,
 162         ARRAY_ACCUM( SUBSTRING(issn.value FROM $$^\S+$$) ) AS issn
 163   FROM  biblio.record_entry r
 164         LEFT JOIN metabib.full_rec title ON (r.id = title.record AND title.tag = '245' AND title.subfield = 'a')
 165         LEFT JOIN metabib.full_rec author ON (r.id = author.record AND author.tag IN ('100','110','111') AND author.subfield = 'a')
 166         LEFT JOIN metabib.full_rec publisher ON (r.id = publisher.record AND publisher.tag = '260' AND publisher.subfield = 'b')
 167         LEFT JOIN metabib.full_rec pubdate ON (r.id = pubdate.record AND pubdate.tag = '260' AND pubdate.subfield = 'c')
 168         LEFT JOIN metabib.full_rec isbn ON (r.id = isbn.record AND isbn.tag IN ('024', '020') AND isbn.subfield IN ('a','z'))
 169         LEFT JOIN metabib.full_rec issn ON (r.id = issn.record AND issn.tag = '022' AND issn.subfield = 'a')
 170   GROUP BY 1,2,3,4,5,6,8,9;
 171
 172 CREATE TABLE reporter.materialized_simple_record AS SELECT * FROM reporter.old_super_simple_record WHERE 1=0;
 173 ALTER TABLE reporter.materialized_simple_record ADD PRIMARY KEY (id);
 174
 175 CREATE VIEW reporter.super_simple_record AS SELECT * FROM reporter.materialized_simple_record;
 176
 177 CREATE OR REPLACE FUNCTION reporter.simple_rec_update (r_id BIGINT, deleted BOOL) RETURNS BOOL AS $$
 178 DECLARE
 179     new_data    RECORD;
 180 BEGIN
 181
 182     DELETE FROM reporter.materialized_simple_record WHERE id = r_id;
 183
 184     IF NOT deleted THEN
 185         INSERT INTO reporter.materialized_simple_record SELECT DISTINCT ON (id) * FROM reporter.old_super_simple_record WHERE id = NEW.record;
 186     END IF;
 187
 188     RETURN TRUE;
 189
 190 END;
 191 $$ LANGUAGE PLPGSQL;
 192
 193 CREATE OR REPLACE FUNCTION reporter.simple_rec_update (r_id BIGINT) RETURNS BOOL AS $$
 194     SELECT reporter.simple_rec_update($1, FALSE);
 195 $$ LANGUAGE SQL;
 196
 197 CREATE OR REPLACE FUNCTION reporter.simple_rec_delete (r_id BIGINT) RETURNS BOOL AS $$
 198     SELECT reporter.simple_rec_update($1, TRUE);
 199 $$ LANGUAGE SQL;
 200
 201 CREATE OR REPLACE FUNCTION reporter.simple_rec_sync () RETURNS TRIGGER AS $$
 202 DECLARE
 203     r_id        BIGINT;
 204     deleted     BOOL;
 205 BEGIN
 206     IF TG_OP IN ('DELETE') THEN
 207         r_id := OLD.record;
 208         deleted := TRUE;
 209     ELSE
 210         r_id := NEW.record;
 211         deleted := FALSE;
 212     END IF;
 213
 214     PERFORM reporter.simple_rec_update(r_id, deleted);
 215
 216     IF deleted THEN
 217         RETURN OLD;
 218     ELSE
 219         RETURN NEW;
 220     END IF;
 221
 222 END;
 223 $$ LANGUAGE PLPGSQL;
 224
 225 --
 226 -- Disabling this by default for now, but we'll keep it around
 227 --
 228 --CREATE TRIGGER zzz_update_materialized_simple_record_tgr
 229 --    AFTER INSERT OR UPDATE OR DELETE ON metabib.real_full_rec
 230 --    FOR EACH ROW EXECUTE PROCEDURE reporter.simple_rec_sync();
 231
 232 CREATE OR REPLACE FUNCTION reporter.simple_rec_bib_sync () RETURNS TRIGGER AS $$
 233 BEGIN
 234     IF NEW.deleted THEN
 235         DELETE FROM reporter.materialized_simple_record WHERE id = NEW.id;
 236         RETURN NEW;
 237     ELSE
 238         RETURN NEW;
 239     END IF;
 240 END;
 241 $$ LANGUAGE PLPGSQL;
 242
 243 CREATE TRIGGER zzz_update_materialized_simple_rec_delete_tgr
 244     AFTER UPDATE ON biblio.record_entry
 245     FOR EACH ROW EXECUTE PROCEDURE reporter.reporter.simple_rec_bib_sync();
 246
 247
 248 CREATE OR REPLACE FUNCTION reporter.disable_materialized_simple_record_trigger () RETURNS VOID AS $$
 249     DROP TRIGGER zzz_update_materialized_simple_record_tgr ON metabib.real_full_rec;
 250 $$ LANGUAGE SQL;
 251
 252 CREATE OR REPLACE FUNCTION reporter.enable_materialized_simple_record_trigger () RETURNS VOID AS $$
 253
 254     TRUNCATE TABLE reporter.materialized_simple_record;
 255
 256     INSERT INTO reporter.materialized_simple_record
 257         (id,fingerprint,quality,tcn_source,tcn_value,title,author,publisher,pubdate,isbn,issn)
 258         SELECT DISTINCT ON (id) * FROM reporter.old_super_simple_record;
 259
 260     CREATE TRIGGER zzz_update_materialized_simple_record_tgr
 261         AFTER INSERT OR UPDATE OR DELETE ON metabib.real_full_rec
 262         FOR EACH ROW EXECUTE PROCEDURE reporter.simple_rec_sync();
 263
 264 $$ LANGUAGE SQL;
 265
 266 CREATE OR REPLACE FUNCTION reporter.refresh_materialized_simple_record () RETURNS VOID AS $$
 267     SELECT reporter.disable_materialized_simple_record_trigger();
 268     SELECT reporter.enable_materialized_simple_record_trigger();
 269 $$ LANGUAGE SQL;
 270
 271 CREATE OR REPLACE VIEW reporter.demographic AS
 272 SELECT  u.id,
 273         u.dob,
 274         CASE
 275                 WHEN u.dob IS NULL
 276                         THEN 'Adult'
 277                 WHEN AGE(u.dob) > '18 years'::INTERVAL
 278                         THEN 'Adult'
 279                 ELSE 'Juvenile'
 280         END AS general_division
 281   FROM  actor.usr u;
 282
 283 CREATE OR REPLACE VIEW reporter.circ_type AS
 284 SELECT  id,
 285         CASE WHEN opac_renewal OR phone_renewal OR desk_renewal
 286                 THEN 'RENEWAL'
 287                 ELSE 'CHECKOUT'
 288         END AS "type"
 289   FROM  action.circulation;
 290
 291 CREATE OR REPLACE VIEW reporter.hold_request_record AS
 292 SELECT  id,
 293         target,
 294         hold_type,
 295         CASE
 296                 WHEN hold_type = 'T'
 297                         THEN target
 298                 WHEN hold_type = 'V'
 299                         THEN (SELECT cn.record FROM asset.call_number cn WHERE cn.id = ahr.target)
 300                 WHEN hold_type = 'C'
 301                         THEN (SELECT cn.record FROM asset.call_number cn JOIN asset.copy cp ON (cn.id = cp.call_number) WHERE cp.id = ahr.target)
 302                 WHEN hold_type = 'M'
 303                         THEN (SELECT mr.master_record FROM metabib.metarecord mr WHERE mr.id = ahr.target)
 304         END AS bib_record
 305   FROM  action.hold_request ahr;
 306
 307 CREATE OR REPLACE VIEW reporter.xact_billing_totals AS
 308 SELECT  b.xact,
 309         SUM( CASE WHEN b.voided THEN 0 ELSE amount END ) as unvoided,
 310         SUM( CASE WHEN b.voided THEN amount ELSE 0 END ) as voided,
 311         SUM( amount ) as total
 312   FROM  money.billing b
 313   GROUP BY 1;
 314
 315 CREATE OR REPLACE VIEW reporter.xact_paid_totals AS
 316 SELECT  b.xact,
 317         SUM( CASE WHEN b.voided THEN 0 ELSE amount END ) as unvoided,
 318         SUM( CASE WHEN b.voided THEN amount ELSE 0 END ) as voided,
 319         SUM( amount ) as total
 320   FROM  money.payment b
 321   GROUP BY 1;
 322
 323 CREATE OR REPLACE VIEW reporter.overdue_circs AS
 324 SELECT  *
 325   FROM  "action".circulation
 326   WHERE checkin_time is null
 327         AND (stop_fines NOT IN ('LOST','CLAIMSRETURNED') OR stop_fines IS NULL)
 328         AND due_date < now();
 329
 330 CREATE OR REPLACE VIEW reporter.overdue_reports AS
 331  SELECT s.id, c.barcode AS runner_barcode, r.name, s.run_time, s.run_time - now() AS scheduled_wait_time
 332    FROM reporter.schedule s
 333    JOIN reporter.report r ON r.id = s.report
 334    JOIN actor.usr u ON s.runner = u.id
 335    JOIN actor.card c ON c.id = u.card
 336   WHERE s.start_time IS NULL AND s.run_time < now();
 337
 338 CREATE OR REPLACE VIEW reporter.pending_reports AS
 339  SELECT s.id, c.barcode AS runner_barcode, r.name, s.run_time, s.run_time - now() AS scheduled_wait_time
 340    FROM reporter.schedule s
 341    JOIN reporter.report r ON r.id = s.report
 342    JOIN actor.usr u ON s.runner = u.id
 343    JOIN actor.card c ON c.id = u.card
 344   WHERE s.start_time IS NULL;
 345
 346 CREATE OR REPLACE VIEW reporter.currently_running AS
 347  SELECT s.id, c.barcode AS runner_barcode, r.name, s.run_time, s.run_time - now() AS scheduled_wait_time
 348    FROM reporter.schedule s
 349    JOIN reporter.report r ON r.id = s.report
 350    JOIN actor.usr u ON s.runner = u.id
 351    JOIN actor.card c ON c.id = u.card
 352   WHERE s.start_time IS NOT NULL AND s.complete_time IS NULL;
 353
 354 COMMIT;
 355