Skip to content

Commit

Permalink
Merge branch 'dev' into fundingtesting
Browse files Browse the repository at this point in the history
  • Loading branch information
@NickPhura
NickPhura authored Aug 22, 2023
2 parents 3984e99 + 87203be commit 31650e5
Show file tree
Hide file tree
Showing 2 changed files with 263 additions and 0 deletions.
191 changes: 191 additions & 0 deletions database/src/migrations/20230817000000_critter_observation_deployment_tables.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
import { Knex } from 'knex';

/**
* Added critter and observation tables with trigger to check if critter instances is less than observation.total_count
*
* @export
* @param {Knex} knex
* @return {*} {Promise<void>}
*
*/
export async function up(knex: Knex): Promise<void> {
await knex.raw(`--sql
----------------------------------------------------------------------------------------
-- Create Observation Table
----------------------------------------------------------------------------------------
set search_path=biohub;
CREATE TABLE observation(
observation_id integer GENERATED ALWAYS AS IDENTITY (START WITH 1 INCREMENT BY 1),
survey_id integer NOT NULL,
total_count integer NOT NULL CHECK(total_count > 0),
observation_date date,
create_date timestamptz(6) DEFAULT now() NOT NULL,
create_user integer NOT NULL,
update_date timestamptz(6),
update_user integer,
revision_count integer DEFAULT 0 NOT NULL,
CONSTRAINT observation_pk PRIMARY KEY (observation_id)
);
COMMENT ON COLUMN observation.observation_id IS 'System generated surrogate primary key identifier.';
COMMENT ON COLUMN observation.survey_id IS 'The id of the survey.';
COMMENT ON COLUMN observation.observation_date IS 'Date the observation occured.';
COMMENT ON COLUMN observation.total_count IS 'The number of individuals recorded in observation. Associated critters must be less than or equal.';
COMMENT ON COLUMN observation.create_date IS 'The datetime the record was created.';
COMMENT ON COLUMN observation.create_user IS 'The id of the user who created the record as identified in the system user table.';
COMMENT ON COLUMN observation.update_date IS 'The datetime the record was updated.';
COMMENT ON COLUMN observation.update_user IS 'The id of the user who updated the record as identified in the system user table.';
COMMENT ON COLUMN observation.revision_count IS 'Revision count used for concurrency control.';
COMMENT ON TABLE observation IS 'Information about taxon counts.';
-- Create audit and journal triggers
create trigger audit_observation before insert or update or delete on observation for each row execute procedure tr_audit_trigger();
create trigger journal_observation after insert or update or delete on observation for each row execute procedure tr_journal_trigger();
----------------------------------------------------------------------------------------
-- Create Critter table
----------------------------------------------------------------------------------------
CREATE TABLE critter(
critter_id integer GENERATED ALWAYS AS IDENTITY (START WITH 1 INCREMENT BY 1),
observation_id integer NOT NULL,
critterbase_critter_id uuid NOT NULL,
create_date timestamptz(6) DEFAULT now() NOT NULL,
create_user integer NOT NULL,
update_date timestamptz(6),
update_user integer,
revision_count integer DEFAULT 0 NOT NULL,
CONSTRAINT critter_pk PRIMARY KEY (critter_id)
);
COMMENT ON COLUMN critter.critter_id IS 'System generated surrogate primary key identifier.';
COMMENT ON COLUMN critter.observation_id IS 'The id of the observation';
COMMENT ON COLUMN critter.critterbase_critter_id IS 'The external system id of a Critterbase critter.';
COMMENT ON COLUMN critter.create_date IS 'The datetime the record was created.';
COMMENT ON COLUMN critter.create_user IS 'The id of the user who created the record as identified in the system user table.';
COMMENT ON COLUMN critter.update_date IS 'The datetime the record was updated.';
COMMENT ON COLUMN critter.update_user IS 'The id of the user who updated the record as identified in the system user table.';
COMMENT ON COLUMN critter.revision_count IS 'Revision count used for concurrency control.';
COMMENT ON TABLE critter IS 'Information about individual animals associated to specific observations.';
-- Add foreign key constraint from child table to parent table on observation_id
ALTER TABLE critter ADD CONSTRAINT critter_fk1
FOREIGN KEY (observation_id)
REFERENCES observation(observation_id);
-- Add foreign key index
CREATE INDEX critter_idx1 ON critter(observation_id);
-- Add unique constraint
CREATE UNIQUE INDEX critter_uk1 ON critter(observation_id, critterbase_critter_id);
-- Create audit and journal triggers
create trigger audit_critter before insert or update or delete on critter for each row execute procedure tr_audit_trigger();
create trigger journal_critter after insert or update or delete on critter for each row execute procedure tr_journal_trigger();
----------------------------------------------------------------------------------------
-- Create Deployment table
----------------------------------------------------------------------------------------
CREATE TABLE deployment(
deployment_id integer GENERATED ALWAYS AS IDENTITY (START WITH 1 INCREMENT BY 1),
critter_id integer NOT NULL,
bctw_deployment_id uuid NOT NULL,
create_date timestamptz(6) DEFAULT now() NOT NULL,
create_user integer NOT NULL,
update_date timestamptz(6),
update_user integer,
revision_count integer DEFAULT 0 NOT NULL,
CONSTRAINT deployment_pk PRIMARY KEY (deployment_id)
);
COMMENT ON COLUMN deployment.deployment_id IS 'System generated surrogate primary key identifier.';
COMMENT ON COLUMN deployment.critter_id IS 'The id of the critter. Internal Sims id.';
COMMENT ON COLUMN deployment.bctw_deployment_id IS 'The external system id of a BCTW deployment / collar->animal assignment.';
COMMENT ON COLUMN deployment.create_date IS 'The datetime the record was created.';
COMMENT ON COLUMN deployment.create_user IS 'The id of the user who created the record as identified in the system user table.';
COMMENT ON COLUMN deployment.update_date IS 'The datetime the record was updated.';
COMMENT ON COLUMN deployment.update_user IS 'The id of the user who updated the record as identified in the system user table.';
COMMENT ON COLUMN deployment.revision_count IS 'Revision count used for concurrency control.';
COMMENT ON TABLE deployment IS 'Information about individual critters associated to specific bctw deployments.';
-- Add foreign key constraint from child table to parent table on critter_id
ALTER TABLE deployment ADD CONSTRAINT deployment_fk1
FOREIGN KEY (critter_id)
REFERENCES critter(critter_id);
-- Add foreign key index
CREATE INDEX deployment_idx1 ON deployment(critter_id);
-- Add unique constraint
CREATE UNIQUE INDEX deployment_uk1 ON deployment(critter_id, bctw_deployment_id);
-- Create audit and journal triggers
create trigger audit_critter before insert or update or delete on deployment for each row execute procedure tr_audit_trigger();
create trigger journal_critter after insert or update or delete on deployment for each row execute procedure tr_journal_trigger();
----------------------------------------------------------------------------------------
-- Create Critter Observation count trigger
----------------------------------------------------------------------------------------
CREATE OR REPLACE FUNCTION biohub.tr_critter_observation_count()
RETURNS trigger
LANGUAGE plpgsql
AS $function$
-- *******************************************************************
-- Procedure: tr_critter_observation_count
-- Purpose: Validates amount of critters of a observation is less than or equal to observation count.
--
-- MODIFICATION HISTORY
-- Person Date Comments
-- ---------------- ----------- --------------------------------------
-- [email protected]
-- 2023-17-08 initial release
-- *******************************************************************
DECLARE
num_critters integer := (SELECT count(*) FROM critter WHERE critter.observation_id = NEW.observation_id);
observation_total_count integer := (SELECT total_count FROM observation WHERE observation.observation_id = NEW.observation_id);
BEGIN
IF (num_critters > observation_total_count) THEN
RAISE EXCEPTION 'More individual critters than specified by observation total count';
END IF;
RETURN NEW;
end;
$function$
;
COMMENT ON FUNCTION biohub.tr_critter_observation_count() IS 'Validates amount of individual critters in an observation is less than or equal to observation total count.';
-- Create observation count trigger
CREATE TRIGGER tr_critter_observation_count AFTER INSERT ON critter FOR EACH ROW EXECUTE PROCEDURE tr_critter_observation_count();
CREATE TRIGGER tr_critter_observation_count AFTER UPDATE ON observation FOR EACH ROW EXECUTE PROCEDURE tr_critter_observation_count();
----------------------------------------------------------------------------------------
-- Create views
----------------------------------------------------------------------------------------
set search_path=biohub_dapi_v1;
create or replace view observation as select * from biohub.observation;
create or replace view critter as select * from biohub.critter;
create or replace view deployment as select * from biohub.deployment;
`);
}

export async function down(knex: Knex): Promise<void> {
await knex.raw(``);
}
72 changes: 72 additions & 0 deletions database/src/migrations/20230818000000_survey_stratum.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import { Knex } from 'knex';

/**
* Added new survey stratum table
*
* @export
* @param {Knex} knex
* @return {*} {Promise<void>}
*/
export async function up(knex: Knex): Promise<void> {
await knex.raw(`--sql
----------------------------------------------------------------------------------------
-- Create Survey Stratum Table
----------------------------------------------------------------------------------------
set search_path=biohub;
CREATE TABLE survey_stratum(
survey_stratum_id integer GENERATED ALWAYS AS IDENTITY (START WITH 1 INCREMENT BY 1),
survey_id integer NOT NULL,
name varchar(50) NOT NULL,
description varchar(250) NOT NULL,
create_date timestamptz(6) DEFAULT now() NOT NULL,
create_user integer NOT NULL,
update_date timestamptz(6),
update_user integer,
revision_count integer DEFAULT 0 NOT NULL,
CONSTRAINT survey_stratum_pk PRIMARY KEY (survey_stratum_id)
);
COMMENT ON COLUMN survey_stratum.survey_stratum_id IS 'System generated surrogate primary key identifier.';
COMMENT ON COLUMN survey_stratum.survey_id IS 'The id of the survey.';
COMMENT ON COLUMN survey_stratum.name IS 'The name of the stratum.';
COMMENT ON COLUMN survey_stratum.description IS 'Additional details of the stratum.';
COMMENT ON COLUMN survey_stratum.create_date IS 'The datetime the record was created.';
COMMENT ON COLUMN survey_stratum.create_user IS 'The id of the user who created the record as identified in the system user table.';
COMMENT ON COLUMN survey_stratum.update_date IS 'The datetime the record was updated.';
COMMENT ON COLUMN survey_stratum.update_user IS 'The id of the user who updated the record as identified in the system user table.';
COMMENT ON COLUMN survey_stratum.revision_count IS 'Revision count used for concurrency control.';
COMMENT ON TABLE survey_stratum IS 'Information about survey stratums';
-- Add foreign key constraint from child table to parent table on survey_id
ALTER TABLE survey_stratum ADD CONSTRAINT survey_stratum_fk1
FOREIGN KEY (survey_id)
REFERENCES survey(survey_id);
-- Add foreign key index
CREATE INDEX surve_stratum_idx1 ON survey_stratum(survey_id);
-- Add unique constraint
CREATE UNIQUE INDEX survey_stratum_uk1 ON survey_stratum(survey_id, name);
-- Create audit and journal triggers
create trigger audit_observation before insert or update or delete on survey_stratum for each row execute procedure tr_audit_trigger();
create trigger journal_observation after insert or update or delete on survey_stratum for each row execute procedure tr_journal_trigger();
----------------------------------------------------------------------------------------
-- Create views
----------------------------------------------------------------------------------------
set search_path=biohub_dapi_v1;
create or replace view survey_stratum as select * from biohub.survey_stratum;
`);
}

export async function down(knex: Knex): Promise<void> {
await knex.raw(``);
}

0 comments on commit 31650e5

Please sign in to comment.