Source code for q2_sdk.hq.db.gt_data_element

from argparse import _SubParsersAction
from functools import partial
from q2_sdk.core.dynamic_imports import (
    api_ExecuteStoredProcedure as ExecuteStoredProcedure,
)
from q2_sdk.tools.decorators import dev_only
from .db_object import DbObject




class GTDataElement(DbObject):
    GET_BY_NAME_KEY = "ShortName"
    NAME = "GTDataElement"



    def add_arguments(self, parser: _SubParsersAction):
        subparser = parser.add_parser("get_gt_data_elements")
        subparser.set_defaults(parser="get_gt_data_elements")
        subparser.set_defaults(func=partial(self.get, serialize_for_cli=True))

        subparser = parser.add_parser("add_gt_data_element")
        subparser.set_defaults(parser="add_gt_data_element")
        subparser.set_defaults(func=partial(self.create))
        subparser.add_argument("short_name", help="Q2_GTDataElement.ShortName")

        subparser = parser.add_parser("remove_gt_data_element")
        subparser.set_defaults(parser="remove_gt_data_element")
        subparser.set_defaults(func=partial(self.delete))
        subparser.add_argument("short_name", help="Q2_GTDataElement.ShortName")




    async def get(self, serialize_for_cli=False):
        response = await self.call_hq("sdk_GetGTDataElements")
        if serialize_for_cli:
            response = self.serialize_for_cli(response, ["ShortName", "DisplayName"])
        return response




    async def create(self, short_name, display_name=None):
        """
        Creates row in Q2_GTDataElement table

        :param short_name: Unique name
        :param display_name: (Optional) defaults to short_name
        """

        if not display_name:
            display_name = short_name
        return await self.call_hq(
            "sdk_AddGTDataElement",
            ExecuteStoredProcedure.SqlParameters([
                ExecuteStoredProcedure.SqlParam(
                    ExecuteStoredProcedure.DataType.VarChar,
                    "short_name",
                    short_name,
                ),
                ExecuteStoredProcedure.SqlParam(
                    ExecuteStoredProcedure.DataType.VarChar,
                    "display_name",
                    display_name,
                ),
            ]),
        )




    @dev_only
    async def delete(self, short_name):
        """Note: this only works in the dev environment"""
        return await self.call_hq(
            "sdk_RemoveGTDataElement",
            ExecuteStoredProcedure.SqlParameters([
                ExecuteStoredProcedure.SqlParam(
                    ExecuteStoredProcedure.DataType.VarChar,
                    "short_name",
                    short_name,
                )
            ]),
        )