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