insertEntity.sql

/*
 * ** header v3.0
 * This file is a part of the CaosDB Project.
 *
 * Copyright (C) 2018 Research Group Biomedical Physics,
 * Max-Planck-Institute for Dynamics and Self-Organization Göttingen
 * Copyright (C) 2020 IndiScale GmbH <info@indiscale.com>
 * Copyright (C) 2020 Timm Fitschen <t.fitschen@indiscale
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * ** end header
 */


DROP PROCEDURE IF EXISTS db_2_0.insertEntity;
delimiter //
/* Insert an Entity

Parameters
==========

EntityName : VARCHAR(255)

EntityDesc : TEXT

EntityRole : VARCHAR(255)
Currently one of 'RECORDTYPE', 'RECORD', 'FILE', 'DOMAIN', 'PROPERTY',
'DATATYPE', 'ROLE', 'QUERYTEMPLATE'

ACL : VARBINARY(65525)

Select
======

A tuple (EntityID, Version)
*/
CREATE PROCEDURE db_2_0.insertEntity(
    in EntityName VARCHAR(255),
    in EntityDesc TEXT,
    in EntityRole VARCHAR(255),
    in ACL VARBINARY(65525)
)
BEGIN
    DECLARE NewEntityID INT UNSIGNED DEFAULT NULL;
    DECLARE NewACLID INT UNSIGNED DEFAULT NULL;
    DECLARE Hash VARBINARY(255) DEFAULT NULL;
    DECLARE Version VARBINARY(255) DEFAULT NULL;
    DECLARE Transaction VARBINARY(255) DEFAULT NULL;

    -- insert the acl. the new acl id is being written (c-style) into the
    -- variable NewACLID.
    call entityACL(NewACLID, ACL);

    -- insert the description, role, and acl into entities table...
    INSERT INTO entities (description, role, acl)
        VALUES (EntityDesc, EntityRole, NewACLID);

    -- ... and return the generated id
    SET NewEntityID = LAST_INSERT_ID();

    IF is_feature_config("ENTITY_VERSIONING", "ENABLED") THEN
        -- TODO this is transaction-scoped variable. Is this a good idea?
        SET Transaction = @SRID;
        SET Version = SHA1(UUID());
        CALL insert_single_child_version(NewEntityID, Hash, Version, Null, Transaction);
    END IF;

    -- insert the name of the entity into name_data table
    -- 20 is the (hard-coded) id of the 'name' property.
    IF EntityName IS NOT NULL THEN
        INSERT INTO name_data
            (domain_id, entity_id, property_id, value, status, pidx)
            VALUES (0, NewEntityID, 20, EntityName, "FIX", 0);
    END IF;

    SELECT NewEntityID as EntityID, Version as Version;

END;
//
delimiter ;