Group

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

Bases: TableRow

GroupID: int

GroupDesc: str

DashboardProfileID: int

SecAlertProfileID: int

DefaultUiSelectionID: int

IsCommercial: bool

IsTreasury: bool

PolicyID: int

EdvProfileID: int

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

Bases: TableRow

GroupID: int

GroupDesc: str

class q2_sdk.hq.db.group.Group(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 = 'GroupDesc'

NAME = 'Group'

REPRESENTATION_ROW_CLASS: alias of GroupRow

add_arguments(parser)[source]: Hook for subclassed DbObjects to add custom arguments.

async get(show_deleted=False, serialize_for_cli=False)[source]

Return type:: List[GroupRow]

async get_by_id(group_id)[source]

Return type:: GroupRow

async get_central(serialize_for_cli=False)[source]

Return type:: List[CentralGroupRow]

async create(group_name)[source]

async update_group(group_id, sec_alert_profile_id=<DEFAULT_DB_PARAM>, is_commercial=<DEFAULT_DB_PARAM>, edv_profile_id=<DEFAULT_DB_PARAM>)[source]

async delete(group_name)[source]: Note: this only works in the dev environment