LogonData

class q2_sdk.hq.db.logon_data.LogonData(logger, hq_credentials=None, ret_table_obj=None)

Bases: UserLogon

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)

async get(user_id=None, logon_name=None, serialize_for_cli=False, admin=False, include_deleted=False)

Return type:

List[UserLogonRow]