ObjectGroupData

class q2_sdk.hq.db.object_group.ObjectGroupDataRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

ObjectGroupID: str

ObjectGroupTypeID: int

ShortName: str

Data: str

Alias: str

UserID: int

ObjectGroupTypeID1: int

ShortName1: str

UiTextElementID1: int

class q2_sdk.hq.db.object_group.ObjectGroupData(logger, hq_credentials=None, ret_table_obj=None)[source]

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 = 'ObjectGroup'

REPRESENTATION_ROW_CLASS: alias of ObjectGroupDataRow

async get(user_id, object_group_type)[source]

Return type:: List[ObjectGroupDataRow]

async get_by_id(object_group_id)[source]

Return type:: List[ObjectGroupDataRow]

async add(short_name, object_group_type, alias, data, description=None, user_id=None, ui_text_element=None, customer_id=None)[source]

Return type:: None

async update(object_group_id, short_name=<DEFAULT_DB_PARAM>, object_group_type_id=<DEFAULT_DB_PARAM>, alias=<DEFAULT_DB_PARAM>, data=<DEFAULT_DB_PARAM>, user_id=<DEFAULT_DB_PARAM>)[source]