Group

class q2_sdk.hq.db.group.GroupRow

Bases: RepresentationRowBase

GroupID: IntElement = 'GroupID'

GroupDesc: StringElement = 'GroupDesc'

DashboardProfileID: IntElement = 'DashboardProfileID'

SecAlertProfileID: IntElement = 'SecAlertProfileID'

DefaultUiSelectionID: IntElement = 'DefaultUiSelectionID'

IsCommercial: BoolElement = 'IsCommercial'

IsTreasury: BoolElement = 'IsTreasury'

PolicyID: IntElement = 'PolicyID'

EdvProfileID: IntElement = 'EDVProfileID'

class q2_sdk.hq.db.group.CentralGroupRow

Bases: RepresentationRowBase

GroupID: IntElement = 'GroupID'

GroupDesc: StringElement = 'GroupDesc'

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

NAME = 'Group'

REPRESENTATION_ROW_CLASS

alias of GroupRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(show_deleted=False, serialize_for_cli=False)

Return type:

List[GroupRow]

async get_by_id(group_id)

Return type:

GroupRow

async get_central(serialize_for_cli=False)

Return type:

List[CentralGroupRow]

async create(group_name)

async update_group(group_id, sec_alert_profile_id=<DEFAULT_DB_PARAM>, is_commercial=<DEFAULT_DB_PARAM>, edv_profile_id=<DEFAULT_DB_PARAM>)

async delete(group_name)

Note: this only works in the dev environment