Open-ILS/src/sql/Pg/200.schema.acq.sql

   1 DROP SCHEMA acq CASCADE;
   2
   3 BEGIN;
   4
   5 CREATE SCHEMA acq;
   6
   7
   8 -- Tables
   9
  10
  11 CREATE TABLE acq.currency_type (
  12         code    TEXT PRIMARY KEY,
  13         label   TEXT
  14 );
  15
  16 -- Use the ISO 4217 abbreviations for currency codes
  17 INSERT INTO acq.currency_type (code, label) VALUES ('USD','US Dollars');
  18 INSERT INTO acq.currency_type (code, label) VALUES ('CAN','Canadian Dollars');
  19 INSERT INTO acq.currency_type (code, label) VALUES ('EUR','Euros');
  20
  21 CREATE TABLE acq.exchange_rate (
  22     id              SERIAL  PRIMARY KEY,
  23     from_currency   TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  24     to_currency     TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  25     ratio           NUMERIC NOT NULL,
  26     CONSTRAINT exchange_rate_from_to_once UNIQUE (from_currency,to_currency)
  27 );
  28
  29 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','CAN',1.2);
  30 INSERT INTO acq.exchange_rate (from_currency,to_currency,ratio) VALUES ('USD','EUR',0.5);
  31
  32 CREATE TABLE acq.provider (
  33     id                  SERIAL  PRIMARY KEY,
  34     name                TEXT    NOT NULL,
  35     owner               INT     NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
  36     currency_type       TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  37     code                TEXT    NOT NULL,
  38     holding_tag         TEXT,
  39     CONSTRAINT provider_name_once_per_owner UNIQUE (name,owner),
  40         CONSTRAINT code_once_per_owner UNIQUE (code, owner)
  41 );
  42
  43 CREATE TABLE acq.provider_holding_subfield_map (
  44     id          SERIAL  PRIMARY KEY,
  45     provider    INT     NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
  46     name        TEXT    NOT NULL, -- barcode, price, etc
  47     subfield    TEXT    NOT NULL,
  48     CONSTRAINT name_once_per_provider UNIQUE (provider,name)
  49 );
  50
  51 CREATE TABLE acq.provider_address (
  52         id              SERIAL  PRIMARY KEY,
  53         valid           BOOL    NOT NULL DEFAULT TRUE,
  54         address_type    TEXT,
  55     provider    INT     NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
  56         street1         TEXT    NOT NULL,
  57         street2         TEXT,
  58         city            TEXT    NOT NULL,
  59         county          TEXT,
  60         state           TEXT    NOT NULL,
  61         country         TEXT    NOT NULL,
  62         post_code       TEXT    NOT NULL
  63 );
  64
  65 CREATE TABLE acq.provider_contact (
  66         id              SERIAL  PRIMARY KEY,
  67     provider    INT NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
  68     name    TEXT NULL NULL,
  69     role    TEXT, -- free-form.. e.g. "our sales guy"
  70     email   TEXT,
  71     phone   TEXT
  72 );
  73
  74 CREATE TABLE acq.provider_contact_address (
  75         id                      SERIAL  PRIMARY KEY,
  76         valid                   BOOL    NOT NULL DEFAULT TRUE,
  77         address_type    TEXT,
  78         contact                 INT         NOT NULL REFERENCES acq.provider_contact (id) DEFERRABLE INITIALLY DEFERRED,
  79         street1                 TEXT    NOT NULL,
  80         street2                 TEXT,
  81         city                    TEXT    NOT NULL,
  82         county                  TEXT,
  83         state                   TEXT    NOT NULL,
  84         country                 TEXT    NOT NULL,
  85         post_code               TEXT    NOT NULL
  86 );
  87
  88
  89 CREATE TABLE acq.funding_source (
  90         id              SERIAL  PRIMARY KEY,
  91         name            TEXT    NOT NULL,
  92         owner           INT     NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
  93         currency_type   TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
  94         code            TEXT    UNIQUE,
  95         CONSTRAINT funding_source_name_once_per_owner UNIQUE (name,owner)
  96 );
  97
  98 CREATE TABLE acq.funding_source_credit (
  99         id      SERIAL  PRIMARY KEY,
 100         funding_source    INT     NOT NULL REFERENCES acq.funding_source (id) DEFERRABLE INITIALLY DEFERRED,
 101         amount  NUMERIC NOT NULL,
 102         note    TEXT
 103 );
 104
 105 CREATE TABLE acq.fund (
 106     id              SERIAL  PRIMARY KEY,
 107     org             INT     NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 108     name            TEXT    NOT NULL,
 109     year            INT     NOT NULL DEFAULT EXTRACT( YEAR FROM NOW() ),
 110     currency_type   TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
 111     code            TEXT,
 112     CONSTRAINT name_once_per_org_year UNIQUE (org,name,year),
 113     CONSTRAINT code_once_per_org_year UNIQUE (org, code, year)
 114 );
 115
 116 CREATE TABLE acq.fund_debit (
 117         id                      SERIAL  PRIMARY KEY,
 118         fund                    INT     NOT NULL REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
 119         origin_amount           NUMERIC NOT NULL,  -- pre-exchange-rate amount
 120         origin_currency_type    TEXT    NOT NULL REFERENCES acq.currency_type (code) DEFERRABLE INITIALLY DEFERRED,
 121         amount                  NUMERIC NOT NULL,
 122         encumbrance             BOOL    NOT NULL DEFAULT TRUE,
 123         debit_type              TEXT    NOT NULL,
 124         xfer_destination        INT     REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
 125         create_time     TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
 126 );
 127
 128 CREATE TABLE acq.fund_allocation (
 129     id          SERIAL  PRIMARY KEY,
 130     funding_source        INT     NOT NULL REFERENCES acq.funding_source (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 131     fund        INT     NOT NULL REFERENCES acq.fund (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 132     amount      NUMERIC,
 133     percent     NUMERIC CHECK (percent IS NULL OR percent BETWEEN 0.0 AND 100.0),
 134     allocator   INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 135     note        TEXT,
 136         create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
 137     CONSTRAINT allocation_amount_or_percent CHECK ((percent IS NULL AND amount IS NOT NULL) OR (percent IS NOT NULL AND amount IS NULL))
 138 );
 139 CREATE INDEX fund_alloc_allocator_idx ON acq.fund_allocation ( allocator );
 140
 141 CREATE TABLE acq.picklist (
 142         id              SERIAL                          PRIMARY KEY,
 143         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 144         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 145         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 146         org_unit        INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 147         name            TEXT                            NOT NULL,
 148         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 149         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 150         CONSTRAINT name_once_per_owner UNIQUE (name,owner)
 151 );
 152 CREATE INDEX acq_picklist_owner_idx   ON acq.picklist ( owner );
 153 CREATE INDEX acq_picklist_creator_idx ON acq.picklist ( creator );
 154 CREATE INDEX acq_picklist_editor_idx  ON acq.picklist ( editor );
 155
 156 CREATE TABLE acq.purchase_order (
 157         id              SERIAL                          PRIMARY KEY,
 158         owner           INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 159         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 160         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 161         ordering_agency INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 162         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 163         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 164         provider        INT                             NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 165         state                   TEXT                                    NOT NULL DEFAULT 'new',
 166         order_date              TIMESTAMP WITH TIME ZONE,
 167         name                    TEXT                                    NOT NULL
 168 );
 169 CREATE INDEX po_owner_idx ON acq.purchase_order (owner);
 170 CREATE INDEX po_provider_idx ON acq.purchase_order (provider);
 171 CREATE INDEX po_state_idx ON acq.purchase_order (state);
 172 CREATE INDEX po_creator_idx  ON acq.purchase_order ( creator );
 173 CREATE INDEX po_editor_idx   ON acq.purchase_order ( editor );
 174 CREATE INDEX acq_po_org_name_order_date_idx ON acq.purchase_order( ordering_agency, name, order_date );
 175
 176 -- The name should default to the id, as text.  We can't reference a column
 177 -- in a DEFAULT clause, so we use a trigger:
 178
 179 CREATE OR REPLACE FUNCTION acq.purchase_order_name_default () RETURNS TRIGGER
 180 AS $$
 181 BEGIN
 182         IF NEW.name IS NULL THEN
 183                 NEW.name := NEW.id::TEXT;
 184         END IF;
 185
 186         RETURN NEW;
 187 END;
 188 $$ LANGUAGE PLPGSQL;
 189
 190 CREATE TRIGGER po_name_default_trg
 191   BEFORE INSERT OR UPDATE ON acq.purchase_order
 192   FOR EACH ROW EXECUTE PROCEDURE acq.purchase_order_name_default ();
 193
 194 -- The order name should be unique for a given ordering agency on a given order date
 195 -- (truncated to midnight), but only where the order_date is not NULL.  Conceptually
 196 -- this rule requires a check constraint with a subquery.  However you can't have a
 197 -- subquery in a CHECK constraint, so we fake it with a trigger.
 198
 199 CREATE OR REPLACE FUNCTION acq.po_org_name_date_unique () RETURNS TRIGGER
 200 AS $$
 201 DECLARE
 202         collision INT;
 203 BEGIN
 204         --
 205         -- If order_date is not null, then make sure we don't have a collision
 206         -- on order_date (truncated to day), org, and name
 207         --
 208         IF NEW.order_date IS NULL THEN
 209                 RETURN NEW;
 210         END IF;
 211         --
 212         -- In the WHERE clause, we compare the order_dates without regard to time of day.
 213         -- We use a pair of inequalities instead of comparing truncated dates so that the
 214         -- query can do an indexed range scan.
 215         --
 216         SELECT 1 INTO collision
 217         FROM acq.purchase_order
 218         WHERE
 219                 ordering_agency = NEW.ordering_agency
 220                 AND name = NEW.name
 221                 AND order_date >= date_trunc( 'day', NEW.order_date )
 222                 AND order_date <  date_trunc( 'day', NEW.order_date ) + '1 day'::INTERVAL
 223                 AND id <> NEW.id;
 224         --
 225         IF collision IS NULL THEN
 226                 -- okay, no collision
 227                 RETURN NEW;
 228         ELSE
 229                 -- collision; nip it in the bud
 230                 RAISE EXCEPTION 'Colliding purchase orders: ordering_agency %, date %, name ''%''',
 231                         NEW.ordering_agency, NEW.order_date, NEW.name;
 232         END IF;
 233 END;
 234 $$ LANGUAGE PLPGSQL;
 235
 236 CREATE TRIGGER po_org_name_date_unique_trg
 237   BEFORE INSERT OR UPDATE ON acq.purchase_order
 238   FOR EACH ROW EXECUTE PROCEDURE acq.po_org_name_date_unique ();
 239
 240 CREATE TABLE acq.po_note (
 241         id              SERIAL                          PRIMARY KEY,
 242         purchase_order  INT                             NOT NULL REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
 243         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 244         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 245         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 246         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 247         value           TEXT                            NOT NULL
 248 );
 249 CREATE INDEX po_note_po_idx ON acq.po_note (purchase_order);
 250 CREATE INDEX acq_po_note_creator_idx  ON acq.po_note ( creator );
 251 CREATE INDEX acq_po_note_editor_idx   ON acq.po_note ( editor );
 252
 253 CREATE TABLE acq.lineitem (
 254         id                  BIGSERIAL                   PRIMARY KEY,
 255         creator             INT                         NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 256         editor              INT                         NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 257         selector            INT                         NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 258         provider            INT                         REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED,
 259         purchase_order      INT                         REFERENCES acq.purchase_order (id) DEFERRABLE INITIALLY DEFERRED,
 260         picklist            INT                         REFERENCES acq.picklist (id) DEFERRABLE INITIALLY DEFERRED,
 261         expected_recv_time  TIMESTAMP WITH TIME ZONE,
 262         create_time         TIMESTAMP WITH TIME ZONE    NOT NULL DEFAULT NOW(),
 263         edit_time           TIMESTAMP WITH TIME ZONE    NOT NULL DEFAULT NOW(),
 264         marc                TEXT                        NOT NULL,
 265         eg_bib_id           INT                         REFERENCES biblio.record_entry (id) DEFERRABLE INITIALLY DEFERRED,
 266         source_label        TEXT,
 267         item_count          INT                         NOT NULL DEFAULT 0,
 268         state               TEXT                        NOT NULL DEFAULT 'new',
 269     CONSTRAINT picklist_or_po CHECK (picklist IS NOT NULL OR purchase_order IS NOT NULL)
 270 );
 271 CREATE INDEX li_po_idx ON acq.lineitem (purchase_order);
 272 CREATE INDEX li_pl_idx ON acq.lineitem (picklist);
 273 CREATE INDEX li_creator_idx   ON acq.lineitem ( creator );
 274 CREATE INDEX li_editor_idx    ON acq.lineitem ( editor );
 275 CREATE INDEX li_selector_idx  ON acq.lineitem ( selector );
 276
 277 CREATE TABLE acq.lineitem_note (
 278         id              SERIAL                          PRIMARY KEY,
 279         lineitem        INT                             NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
 280         creator         INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 281         editor          INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 282         create_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 283         edit_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 284         value           TEXT                            NOT NULL
 285 );
 286 CREATE INDEX li_note_li_idx ON acq.lineitem_note (lineitem);
 287 CREATE INDEX li_note_creator_idx  ON acq.lineitem_note ( creator );
 288 CREATE INDEX li_note_editor_idx   ON acq.lineitem_note ( editor );
 289
 290 CREATE TABLE acq.lineitem_detail (
 291     id          BIGSERIAL       PRIMARY KEY,
 292     lineitem    INT         NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
 293     fund        INT         REFERENCES acq.fund (id) DEFERRABLE INITIALLY DEFERRED,
 294     fund_debit  INT         REFERENCES acq.fund_debit (id) DEFERRABLE INITIALLY DEFERRED,
 295     eg_copy_id  BIGINT      REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 296     barcode     TEXT,
 297     cn_label    TEXT,
 298     note        TEXT,
 299     collection_code TEXT,
 300     circ_modifier   TEXT    REFERENCES config.circ_modifier (code) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 301     owning_lib  INT         REFERENCES actor.org_unit (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 302     location    INT         REFERENCES asset.copy_location (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 303     recv_time   TIMESTAMP WITH TIME ZONE
 304 );
 305
 306 CREATE INDEX li_detail_li_idx ON acq.lineitem_detail (lineitem);
 307
 308 CREATE TABLE acq.lineitem_attr_definition (
 309         id              BIGSERIAL       PRIMARY KEY,
 310         code            TEXT            NOT NULL,
 311         description     TEXT            NOT NULL,
 312         remove          TEXT            NOT NULL DEFAULT '',
 313         ident           BOOL            NOT NULL DEFAULT FALSE
 314 );
 315
 316 CREATE TABLE acq.lineitem_marc_attr_definition (
 317         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 318         xpath           TEXT            NOT NULL
 319 ) INHERITS (acq.lineitem_attr_definition);
 320
 321 CREATE TABLE acq.lineitem_provider_attr_definition (
 322         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 323         xpath           TEXT            NOT NULL,
 324         provider        INT     NOT NULL REFERENCES acq.provider (id) DEFERRABLE INITIALLY DEFERRED
 325 ) INHERITS (acq.lineitem_attr_definition);
 326
 327 CREATE TABLE acq.lineitem_generated_attr_definition (
 328         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 329         xpath           TEXT            NOT NULL
 330 ) INHERITS (acq.lineitem_attr_definition);
 331
 332 CREATE TABLE acq.lineitem_usr_attr_definition (
 333         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq'),
 334         usr             INT     NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED
 335 ) INHERITS (acq.lineitem_attr_definition);
 336 CREATE INDEX li_usr_attr_def_usr_idx  ON acq.lineitem_usr_attr_definition ( usr );
 337
 338 CREATE TABLE acq.lineitem_local_attr_definition (
 339         id              BIGINT  PRIMARY KEY DEFAULT NEXTVAL('acq.lineitem_attr_definition_id_seq')
 340 ) INHERITS (acq.lineitem_attr_definition);
 341
 342 CREATE TABLE acq.lineitem_attr (
 343         id              BIGSERIAL       PRIMARY KEY,
 344         definition      BIGINT          NOT NULL,
 345         lineitem        BIGINT          NOT NULL REFERENCES acq.lineitem (id) DEFERRABLE INITIALLY DEFERRED,
 346         attr_type       TEXT            NOT NULL,
 347         attr_name       TEXT            NOT NULL,
 348         attr_value      TEXT            NOT NULL
 349 );
 350
 351 CREATE INDEX li_attr_li_idx ON acq.lineitem_attr (lineitem);
 352 CREATE INDEX li_attr_value_idx ON acq.lineitem_attr (attr_value);
 353 CREATE INDEX li_attr_definition_idx ON acq.lineitem_attr (definition);
 354
 355
 356 -- Seed data
 357
 358
 359 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('title','Title of work','//*[@tag="245"]/*[contains("abcmnopr",@code)]');
 360 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('author','Author of work','//*[@tag="100" or @tag="110" or @tag="113"]/*[contains("ad",@code)]');
 361 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('language','Language of work','//*[@tag="240"]/*[@code="l"][1]');
 362 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pagination','Pagination','//*[@tag="300"]/*[@code="a"][1]');
 363 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('isbn','ISBN','//*[@tag="020"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
 364 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath, remove ) VALUES ('issn','ISSN','//*[@tag="022"]/*[@code="a"]', $r$(?:-|\s.+$)$r$);
 365 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('price','Price','//*[@tag="020" or @tag="022"]/*[@code="c"][1]');
 366 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('identifier','Identifier','//*[@tag="001"]');
 367 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('publisher','Publisher','//*[@tag="260"]/*[@code="b"][1]');
 368 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('pubdate','Publication Date','//*[@tag="260"]/*[@code="c"][1]');
 369 INSERT INTO acq.lineitem_marc_attr_definition ( code, description, xpath ) VALUES ('edition','Edition','//*[@tag="250"]/*[@code="a"][1]');
 370
 371 INSERT INTO acq.lineitem_local_attr_definition ( code, description ) VALUES ('estimated_price', 'Estimated Price');
 372
 373
 374 CREATE TABLE acq.distribution_formula (
 375         id              SERIAL PRIMARY KEY,
 376         owner   INT NOT NULL
 377                         REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
 378         name    TEXT NOT NULL,
 379         skip_count      INT NOT NULL DEFAULT 0,
 380         CONSTRAINT acqdf_name_once_per_owner UNIQUE (name, owner)
 381 );
 382
 383 CREATE TABLE acq.distribution_formula_entry (
 384         id                      SERIAL PRIMARY KEY,
 385         formula         INTEGER NOT NULL REFERENCES acq.distribution_formula(id)
 386                                 ON DELETE CASCADE
 387                                 DEFERRABLE INITIALLY DEFERRED,
 388         position        INTEGER NOT NULL,
 389         item_count      INTEGER NOT NULL,
 390         owning_lib      INTEGER REFERENCES actor.org_unit(id)
 391                                 DEFERRABLE INITIALLY DEFERRED,
 392         location        INTEGER REFERENCES asset.copy_location(id),
 393         CONSTRAINT acqdfe_lib_once_per_formula UNIQUE( formula, position ),
 394         CONSTRAINT acqdfe_must_be_somewhere
 395                                 CHECK( owning_lib IS NOT NULL OR location IS NOT NULL )
 396 );
 397
 398 CREATE TABLE acq.fund_tag (
 399         id              SERIAL PRIMARY KEY,
 400         owner   INT NOT NULL
 401                         REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
 402         name    TEXT NOT NULL,
 403         CONSTRAINT acqft_tag_once_per_owner UNIQUE (name, owner)
 404 );
 405
 406 CREATE TABLE acq.fund_tag_map (
 407         id                      SERIAL PRIMARY KEY,
 408         fund            INTEGER NOT NULL REFERENCES acq.fund(id)
 409                                 DEFERRABLE INITIALLY DEFERRED,
 410         tag         INTEGER REFERENCES acq.fund_tag(id)
 411                                 ON DELETE CASCADE
 412                                 DEFERRABLE INITIALLY DEFERRED,
 413         CONSTRAINT acqftm_fund_once_per_tag UNIQUE( fund, tag )
 414 );
 415
 416 CREATE TABLE acq.fiscal_calendar (
 417         id              SERIAL         PRIMARY KEY,
 418         name            TEXT           NOT NULL
 419 );
 420
 421 CREATE TABLE acq.fiscal_year (
 422         id              SERIAL         PRIMARY KEY,
 423         calendar        INT            NOT NULL
 424                                        REFERENCES acq.fiscal_calendar
 425                                        ON DELETE CASCADE
 426                                        DEFERRABLE INITIALLY DEFERRED,
 427         year            INT            NOT NULL,
 428         year_begin      TIMESTAMPTZ    NOT NULL,
 429         year_end        TIMESTAMPTZ    NOT NULL,
 430         CONSTRAINT acq_fy_logical_key  UNIQUE ( calendar, year ),
 431     CONSTRAINT acq_fy_physical_key UNIQUE ( calendar, year_begin )
 432 );
 433
 434 -- Functions
 435
 436 CREATE TYPE acq.flat_lineitem_holding_subfield AS (lineitem int, holding int, subfield text, data text);
 437 CREATE OR REPLACE FUNCTION acq.extract_holding_attr_table (lineitem int, tag text) RETURNS SETOF acq.flat_lineitem_holding_subfield AS $$
 438 DECLARE
 439     counter INT;
 440     lida    acq.flat_lineitem_holding_subfield%ROWTYPE;
 441 BEGIN
 442
 443     SELECT  COUNT(*) INTO counter
 444       FROM  xpath_table(
 445                 'id',
 446                 'marc',
 447                 'acq.lineitem',
 448                 '//*[@tag="' || tag || '"]',
 449                 'id=' || lineitem
 450             ) as t(i int,c text);
 451
 452     FOR i IN 1 .. counter LOOP
 453         FOR lida IN
 454             SELECT  *
 455               FROM  (   SELECT  id,i,t,v
 456                           FROM  xpath_table(
 457                                     'id',
 458                                     'marc',
 459                                     'acq.lineitem',
 460                                     '//*[@tag="' || tag || '"][position()=' || i || ']/*/@code|' ||
 461                                         '//*[@tag="' || tag || '"][position()=' || i || ']/*[@code]',
 462                                     'id=' || lineitem
 463                                 ) as t(id int,t text,v text)
 464                     )x
 465         LOOP
 466             RETURN NEXT lida;
 467         END LOOP;
 468     END LOOP;
 469
 470     RETURN;
 471 END;
 472 $$ LANGUAGE PLPGSQL;
 473
 474 CREATE TYPE acq.flat_lineitem_detail AS (lineitem int, holding int, attr text, data text);
 475 CREATE OR REPLACE FUNCTION acq.extract_provider_holding_data ( lineitem_i int ) RETURNS SETOF acq.flat_lineitem_detail AS $$
 476 DECLARE
 477     prov_i  INT;
 478     tag_t   TEXT;
 479     lida    acq.flat_lineitem_detail%ROWTYPE;
 480 BEGIN
 481     SELECT provider INTO prov_i FROM acq.lineitem WHERE id = lineitem_i;
 482     IF NOT FOUND THEN RETURN; END IF;
 483
 484     SELECT holding_tag INTO tag_t FROM acq.provider WHERE id = prov_i;
 485     IF NOT FOUND OR tag_t IS NULL THEN RETURN; END IF;
 486
 487     FOR lida IN
 488         SELECT  lineitem_i,
 489                 h.holding,
 490                 a.name,
 491                 h.data
 492           FROM  acq.extract_holding_attr_table( lineitem_i, tag_t ) h
 493                 JOIN acq.provider_holding_subfield_map a USING (subfield)
 494           WHERE a.provider = prov_i
 495     LOOP
 496         RETURN NEXT lida;
 497     END LOOP;
 498
 499     RETURN;
 500 END;
 501 $$ LANGUAGE PLPGSQL;
 502
 503 -- select * from acq.extract_provider_holding_data(699);
 504
 505 CREATE OR REPLACE FUNCTION public.extract_acq_marc_field ( BIGINT, TEXT, TEXT) RETURNS TEXT AS $$
 506         SELECT public.extract_marc_field('acq.lineitem', $1, $2, $3);
 507 $$ LANGUAGE SQL;
 508
 509 /*
 510 CREATE OR REPLACE FUNCTION public.extract_bib_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
 511         SELECT public.extract_marc_field('biblio.record_entry', $1, $2);
 512 $$ LANGUAGE SQL;
 513
 514 CREATE OR REPLACE FUNCTION public.extract_authority_marc_field ( BIGINT, TEXT ) RETURNS TEXT AS $$
 515         SELECT public.extract_marc_field('authority.record_entry', $1, $2);
 516 $$ LANGUAGE SQL;
 517 */
 518 -- For example:
 519 -- INSERT INTO acq.lineitem_provider_attr_definition ( provider, code, description, xpath ) VALUES (1,'price','Price','//*[@tag="020" or @tag="022"]/*[@code="a"][1]');
 520
 521 /*
 522 Suggested vendor fields:
 523         vendor_price
 524         vendor_currency
 525         vendor_avail
 526         vendor_po
 527         vendor_identifier
 528 */
 529
 530 CREATE OR REPLACE FUNCTION public.ingest_acq_marc ( ) RETURNS TRIGGER AS $$
 531 DECLARE
 532         value           TEXT;
 533         atype           TEXT;
 534         prov            INT;
 535         adef            RECORD;
 536         xpath_string    TEXT;
 537 BEGIN
 538         FOR adef IN SELECT *,tableoid FROM acq.lineitem_attr_definition LOOP
 539
 540                 SELECT relname::TEXT INTO atype FROM pg_class WHERE oid = adef.tableoid;
 541
 542                 IF (atype NOT IN ('lineitem_usr_attr_definition','lineitem_local_attr_definition')) THEN
 543                         IF (atype = 'lineitem_provider_attr_definition') THEN
 544                                 SELECT provider INTO prov FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
 545                                 CONTINUE WHEN NEW.provider IS NULL OR prov <> NEW.provider;
 546                         END IF;
 547
 548                         IF (atype = 'lineitem_provider_attr_definition') THEN
 549                                 SELECT xpath INTO xpath_string FROM acq.lineitem_provider_attr_definition WHERE id = adef.id;
 550                         ELSIF (atype = 'lineitem_marc_attr_definition') THEN
 551                                 SELECT xpath INTO xpath_string FROM acq.lineitem_marc_attr_definition WHERE id = adef.id;
 552                         ELSIF (atype = 'lineitem_generated_attr_definition') THEN
 553                                 SELECT xpath INTO xpath_string FROM acq.lineitem_generated_attr_definition WHERE id = adef.id;
 554                         END IF;
 555
 556                         SELECT extract_acq_marc_field(id, xpath_string, adef.remove) INTO value FROM acq.lineitem WHERE id = NEW.id;
 557
 558                         IF (value IS NOT NULL AND value <> '') THEN
 559                                 INSERT INTO acq.lineitem_attr (lineitem, definition, attr_type, attr_name, attr_value)
 560                                         VALUES (NEW.id, adef.id, atype, adef.code, value);
 561                         END IF;
 562
 563                 END IF;
 564
 565         END LOOP;
 566
 567         RETURN NULL;
 568 END;
 569 $$ LANGUAGE PLPGSQL;
 570
 571 CREATE OR REPLACE FUNCTION public.cleanup_acq_marc ( ) RETURNS TRIGGER AS $$
 572 BEGIN
 573         IF TG_OP = 'UPDATE' THEN
 574                 DELETE FROM acq.lineitem_attr
 575                         WHERE lineitem = OLD.id AND attr_type IN ('lineitem_provider_attr_definition', 'lineitem_marc_attr_definition','lineitem_generated_attr_definition');
 576                 RETURN NEW;
 577         ELSE
 578                 DELETE FROM acq.lineitem_attr WHERE lineitem = OLD.id;
 579                 RETURN OLD;
 580         END IF;
 581 END;
 582 $$ LANGUAGE PLPGSQL;
 583
 584 CREATE TRIGGER cleanup_lineitem_trigger
 585         BEFORE UPDATE OR DELETE ON acq.lineitem
 586         FOR EACH ROW EXECUTE PROCEDURE public.cleanup_acq_marc();
 587
 588 CREATE TRIGGER ingest_lineitem_trigger
 589         AFTER INSERT OR UPDATE ON acq.lineitem
 590         FOR EACH ROW EXECUTE PROCEDURE public.ingest_acq_marc();
 591
 592 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( from_ex TEXT, to_ex TEXT ) RETURNS NUMERIC AS $$
 593 DECLARE
 594     rat NUMERIC;
 595 BEGIN
 596     IF from_ex = to_ex THEN
 597         RETURN 1.0;
 598     END IF;
 599
 600     SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = from_ex AND to_currency = to_ex;
 601
 602     IF FOUND THEN
 603         RETURN rat;
 604     ELSE
 605         SELECT ratio INTO rat FROM acq.exchange_rate WHERE from_currency = to_ex AND to_currency = from_ex;
 606         IF FOUND THEN
 607             RETURN 1.0/rat;
 608         END IF;
 609     END IF;
 610
 611     RETURN NULL;
 612
 613 END;
 614 $$ LANGUAGE PLPGSQL;
 615
 616 CREATE OR REPLACE FUNCTION acq.exchange_ratio ( TEXT, TEXT, NUMERIC ) RETURNS NUMERIC AS $$
 617     SELECT $3 * acq.exchange_ratio($1, $2);
 618 $$ LANGUAGE SQL;
 619
 620 CREATE OR REPLACE FUNCTION acq.find_bad_fy()
 621 /*
 622         Examine the acq.fiscal_year table, comparing successive years.
 623         Report any inconsistencies, i.e. years that overlap, have gaps
 624     between them, or are out of sequence.
 625 */
 626 RETURNS SETOF RECORD AS $$
 627 DECLARE
 628         first_row  BOOLEAN;
 629         curr_year  RECORD;
 630         prev_year  RECORD;
 631         return_rec RECORD;
 632 BEGIN
 633         first_row := true;
 634         FOR curr_year in
 635                 SELECT
 636                         id,
 637                         calendar,
 638                         year,
 639                         year_begin,
 640                         year_end
 641                 FROM
 642                         acq.fiscal_year
 643                 ORDER BY
 644                         calendar,
 645                         year_begin
 646         LOOP
 647                 --
 648                 IF first_row THEN
 649                         first_row := FALSE;
 650                 ELSIF curr_year.calendar    = prev_year.calendar THEN
 651                         IF curr_year.year_begin > prev_year.year_end THEN
 652                                 -- This ugly kludge works around the fact that older
 653                                 -- versions of PostgreSQL don't support RETURN QUERY SELECT
 654                                 FOR return_rec IN SELECT
 655                                         prev_year.id,
 656                                         prev_year.year,
 657                                         'Gap between fiscal years'::TEXT
 658                                 LOOP
 659                                         RETURN NEXT return_rec;
 660                                 END LOOP;
 661                         ELSIF curr_year.year_begin < prev_year.year_end THEN
 662                                 FOR return_rec IN SELECT
 663                                         prev_year.id,
 664                                         prev_year.year,
 665                                         'Overlapping fiscal years'::TEXT
 666                                 LOOP
 667                                         RETURN NEXT return_rec;
 668                                 END LOOP;
 669                         ELSIF curr_year.year < prev_year.year THEN
 670                                 FOR return_rec IN SELECT
 671                                         prev_year.id,
 672                                         prev_year.year,
 673                                         'Fiscal years out of order'::TEXT
 674                                 LOOP
 675                                         RETURN NEXT return_rec;
 676                                 END LOOP;
 677                         END IF;
 678                 END IF;
 679                 --
 680                 prev_year := curr_year;
 681         END LOOP;
 682         --
 683         RETURN;
 684 END;
 685 $$ LANGUAGE plpgsql;
 686
 687 CREATE OR REPLACE VIEW acq.funding_source_credit_total AS
 688     SELECT  funding_source,
 689             SUM(amount) AS amount
 690       FROM  acq.funding_source_credit
 691       GROUP BY 1;
 692
 693 CREATE OR REPLACE VIEW acq.funding_source_allocation_total AS
 694     SELECT  funding_source,
 695             SUM(amount)::NUMERIC(100,2) AS amount
 696       FROM (
 697             SELECT  funding_source,
 698                     SUM(a.amount)::NUMERIC(100,2) AS amount
 699               FROM  acq.fund_allocation a
 700               WHERE a.percent IS NULL
 701               GROUP BY 1
 702                             UNION ALL
 703             SELECT  funding_source,
 704                     SUM( (SELECT SUM(amount) FROM acq.funding_source_credit c WHERE c.funding_source = a.funding_source) * (a.percent/100.0) )::NUMERIC(100,2) AS amount
 705               FROM  acq.fund_allocation a
 706               WHERE a.amount IS NULL
 707               GROUP BY 1
 708         ) x
 709       GROUP BY 1;
 710
 711 CREATE OR REPLACE VIEW acq.funding_source_balance AS
 712     SELECT  COALESCE(c.funding_source, a.funding_source) AS funding_source,
 713             SUM(COALESCE(c.amount,0.0) - COALESCE(a.amount,0.0))::NUMERIC(100,2) AS amount
 714       FROM  acq.funding_source_credit_total c
 715             FULL JOIN acq.funding_source_allocation_total a USING (funding_source)
 716       GROUP BY 1;
 717
 718 CREATE OR REPLACE VIEW acq.fund_allocation_total AS
 719     SELECT  fund,
 720             SUM(amount)::NUMERIC(100,2) AS amount
 721       FROM (
 722             SELECT  fund,
 723                     SUM(a.amount * acq.exchange_ratio(s.currency_type, f.currency_type))::NUMERIC(100,2) AS amount
 724               FROM  acq.fund_allocation a
 725                     JOIN acq.fund f ON (a.fund = f.id)
 726                     JOIN acq.funding_source s ON (a.funding_source = s.id)
 727               WHERE a.percent IS NULL
 728               GROUP BY 1
 729                             UNION ALL
 730             SELECT  fund,
 731                     SUM( (SELECT SUM(amount) FROM acq.funding_source_credit c WHERE c.funding_source = a.funding_source) * acq.exchange_ratio(s.currency_type, f.currency_type) * (a.percent/100.0) )::NUMERIC(100,2) AS amount
 732               FROM  acq.fund_allocation a
 733                     JOIN acq.fund f ON (a.fund = f.id)
 734                     JOIN acq.funding_source s ON (a.funding_source = s.id)
 735               WHERE a.amount IS NULL
 736               GROUP BY 1
 737         ) x
 738       GROUP BY 1;
 739
 740 CREATE OR REPLACE VIEW acq.fund_debit_total AS
 741     SELECT  id AS fund,
 742             encumbrance,
 743             SUM(amount) AS amount
 744       FROM  acq.fund_debit
 745       GROUP BY 1,2;
 746
 747 CREATE OR REPLACE VIEW acq.fund_encumbrance_total AS
 748     SELECT  fund,
 749             SUM(amount) AS amount
 750       FROM  acq.fund_debit_total
 751       WHERE encumbrance IS TRUE
 752       GROUP BY 1;
 753
 754 CREATE OR REPLACE VIEW acq.fund_spent_total AS
 755     SELECT  fund,
 756             SUM(amount) AS amount
 757       FROM  acq.fund_debit_total
 758       WHERE encumbrance IS FALSE
 759       GROUP BY 1;
 760
 761 CREATE OR REPLACE VIEW acq.fund_combined_balance AS
 762     SELECT  c.fund,
 763             c.amount - COALESCE(d.amount,0.0) AS amount
 764       FROM  acq.fund_allocation_total c
 765             LEFT JOIN acq.fund_debit_total d USING (fund);
 766
 767 CREATE OR REPLACE VIEW acq.fund_spent_balance AS
 768     SELECT  c.fund,
 769             c.amount - COALESCE(d.amount,0.0) AS amount
 770       FROM  acq.fund_allocation_total c
 771             LEFT JOIN acq.fund_spent_total d USING (fund);
 772
 773 COMMIT;
 774
 775
 776
 777