Merge pull request #58 from DiamondLightSource/IspybScmApi

Stored procedures for the IspybScmApi interface of gda-ispyb-api
DiamondLightSource · Dec 4, 2020 · 32be5ec · 32be5ec
2 parents d372b08 + a097dd3
commit 32be5ec
Show file tree

Hide file tree

Showing 6 changed files with 1,248 additions and 0 deletions.
diff --git a/schema/stored_programs/sp_retrieve_scm_container.sql b/schema/stored_programs/sp_retrieve_scm_container.sql
@@ -0,0 +1,164 @@
+/* Tests:
+CALL retrieve_scm_container(34888, False, NULL)\G
+CALL retrieve_scm_container(34888, False, 'boaty')\G
+CALL retrieve_scm_container(34888, True, NULL)\G
+CALL retrieve_scm_container(34888, True, 'boaty')\G
+*/
+
+DELIMITER ;;
+
+CREATE OR REPLACE DEFINER=`ispyb_root`@`%` PROCEDURE `retrieve_scm_container`(p_id int unsigned, p_useContainerSession boolean, p_authLogin varchar(45)) 
+READS SQL DATA
+COMMENT 'Returns a single-row result-set with the container for the given ID'
+BEGIN
+
+ IF p_id IS NOT NULL THEN
+
+ IF p_useContainerSession = True THEN
+
+ IF p_authLogin IS NOT NULL THEN
+ -- Authorise only if the person (p_authLogin) is a member of a session on the proposal.
+
+ SELECT DISTINCT c.containerId "containerId",
+ c.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ bs.visit_number "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN BLSession bs ON bs.sessionId = c.sessionId
+ JOIN Proposal p ON p.proposalId = bs.proposalId
+ JOIN BLSession bs2 ON bs2.proposalId = p.proposalId
+ JOIN Session_has_Person shp ON shp.sessionId = bs2.sessionId
+ JOIN Person per on per.personId = shp.personId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.containerId = p_id AND per.login = p_authLogin;
+
+ ELSE
+
+ SELECT c.containerId "containerId",
+ c.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ bs.visit_number "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN BLSession bs ON bs.sessionId = c.sessionId
+ JOIN Proposal p ON p.proposalId = bs.proposalId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.containerId = p_id;
+
+
+ END IF;
+
+ ELSE
+
+ IF p_authLogin IS NOT NULL THEN
+ -- Authorise only if the person (p_authLogin) is a member of a session on the proposal.
+
+ SELECT DISTINCT c.containerId "containerId",
+ d.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ NULL "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN Dewar d ON c.dewarId = d.dewarId
+ JOIN Shipping s ON s.shippingId = d.shippingId
+ JOIN Proposal p ON p.proposalId = s.proposalId
+ JOIN BLSession bs2 ON bs2.proposalId = p.proposalId
+ JOIN Session_has_Person shp ON shp.sessionId = bs2.sessionId
+ JOIN Person per on per.personId = shp.personId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.containerId = p_id AND per.login = p_authLogin;
+
+ ELSE
+
+ SELECT c.containerId "containerId",
+ d.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ NULL "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN Dewar d ON c.dewarId = d.dewarId
+ JOIN Shipping s ON s.shippingId = d.shippingId
+ JOIN Proposal p ON p.proposalId = s.proposalId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.containerId = p_id;
+
+ END IF;
+
+ END IF;
+
+ ELSE
+ SIGNAL SQLSTATE '45000' SET MYSQL_ERRNO=1644, MESSAGE_TEXT='Mandatory argument p_id can not be NULL';
+ END IF;
+
+END;;
+
+DELIMITER ;
diff --git a/schema/stored_programs/sp_retrieve_scm_container_for_barcode.sql b/schema/stored_programs/sp_retrieve_scm_container_for_barcode.sql
@@ -0,0 +1,165 @@
+/* Tests:
+
+CALL retrieve_scm_container_for_barcode('VMXiSim-001', False, NULL)\G
+CALL retrieve_scm_container_for_barcode('VMXiSim-001', False, 'boaty')\G
+CALL retrieve_scm_container_for_barcode('VMXiSim-001', True, NULL)\G
+CALL retrieve_scm_container_for_barcode('VMXiSim-001', True, 'boaty')\G
+
+*/
+
+DELIMITER ;;
+
+CREATE OR REPLACE DEFINER=`ispyb_root`@`%` PROCEDURE `retrieve_scm_container_for_barcode`(p_barcode varchar(45), p_useContainerSession boolean, p_authLogin varchar(45)) 
+READS SQL DATA
+COMMENT 'Returns a single-row result-set with the container for the given barcode'
+BEGIN
+
+ IF p_barcode IS NOT NULL THEN
+
+ IF p_useContainerSession = True THEN
+
+ IF p_authLogin IS NOT NULL THEN
+ -- Authorise only if the person (p_authLogin) is a member of a session on the proposal.
+
+ SELECT DISTINCT c.containerId "containerId",
+ c.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ bs.visit_number "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN BLSession bs ON bs.sessionId = c.sessionId
+ JOIN Proposal p ON p.proposalId = bs.proposalId
+ JOIN BLSession bs2 ON bs2.proposalId = p.proposalId
+ JOIN Session_has_Person shp ON shp.sessionId = bs2.sessionId
+ JOIN Person per on per.personId = shp.personId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.barcode = p_barcode AND per.login = p_authLogin;
+
+ ELSE
+
+ SELECT c.containerId "containerId",
+ c.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ bs.visit_number "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN BLSession bs ON bs.sessionId = c.sessionId
+ JOIN Proposal p ON p.proposalId = bs.proposalId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.barcode = p_barcode;
+
+ END IF;
+
+ ELSE
+
+ IF p_authLogin IS NOT NULL THEN
+ -- Authorise only if the person (p_authLogin) is a member of a session on the proposal.
+
+ SELECT DISTINCT c.containerId "containerId",
+ d.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ NULL "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN Dewar d ON c.dewarId = d.dewarId
+ JOIN Shipping s ON s.shippingId = d.shippingId
+ JOIN Proposal p ON p.proposalId = s.proposalId
+ JOIN BLSession bs2 ON bs2.proposalId = p.proposalId
+ JOIN Session_has_Person shp ON shp.sessionId = bs2.sessionId
+ JOIN Person per on per.personId = shp.personId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.barcode = p_barcode AND per.login = p_authLogin;
+
+ ELSE
+
+ SELECT c.containerId "containerId",
+ d.dewarId "dewarId",
+ c.sessionId "sessionId",
+ p.proposalId "proposalId",
+ c.ownerId "ownerId",
+ per2.login "ownerUsername",
+ c.code "name",
+ c.containerType "type",
+ c.barcode "barcode",
+ c.beamlineLocation "beamline",
+ c.sampleChangerLocation "location",
+ c.containerStatus "status",
+ c.capacity "capacity",
+ c.storageTemperature "storageTemperature",
+
+ p.proposalCode "proposalCode",
+ p.proposalNumber "proposalNumber",
+ NULL "sessionNumber",
+
+ c.comments "comments",
+ et.name "experimentType"
+ FROM Container c
+ JOIN Dewar d ON c.dewarId = d.dewarId
+ JOIN Shipping s ON s.shippingId = d.shippingId
+ JOIN Proposal p ON p.proposalId = s.proposalId
+ LEFT JOIN Person per2 ON per2.personId = c.ownerId
+ LEFT JOIN ExperimentType et ON et.experimentTypeId = c.experimentTypeId
+ WHERE c.barcode = p_barcode;
+
+ END IF;
+
+ END IF;
+
+ ELSE
+ SIGNAL SQLSTATE '45000' SET MYSQL_ERRNO=1644, MESSAGE_TEXT='Mandatory argument p_barcode can not be NULL';
+ END IF;
+
+END;;
+
+DELIMITER ;