GTDataElement

class q2_sdk.hq.db.gt_data_element.GTDataElement(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:

• logger – Reference to calling request’s logger (self.logger in your extension)

• hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)

• ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

GET_BY_NAME_KEY = 'ShortName'

NAME = 'GTDataElement'

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

async create(short_name, display_name=None)

Creates row in Q2_GTDataElement table

Parameters:

• short_name – Unique name

• display_name – (Optional) defaults to short_name

async delete(short_name)

Note: this only works in the dev environment