HqSessionCache

class q2_sdk.hq.db.hq_session_cache.HqSessionCacheRow(HqSessionCacheID='UserID', Workstation='Workstation', ExpirationDate='ExpirationDate', SessionData='SessionData')

Bases: RepresentationRowBase

HqSessionCacheRow(HqSessionCacheID: ‘IntElement’ = ‘UserID’, Workstation: ‘StringElement’ = ‘Workstation’, ExpirationDate: ‘datetime’ = ‘ExpirationDate’, SessionData: ‘SessionData’ = ‘SessionData’)

HqSessionCacheID: IntElement = 'UserID'

Workstation: StringElement = 'Workstation'

ExpirationDate: datetime = 'ExpirationDate'

SessionData: SessionData = 'SessionData'

class q2_sdk.hq.db.hq_session_cache.SessionData(raw, SessionId, GroupId, CustomerId, UserId, UserLogonId)

Bases: object

SessionData(raw: ‘Element’, SessionId: ‘str’, GroupId: ‘int’, CustomerId: ‘int’, UserId: ‘int’, UserLogonId: ‘int’)

raw: Element

SessionId: str

GroupId: int

CustomerId: int

UserId: int

UserLogonId: int

static from_xml(inp)

Return type:

SessionData

class q2_sdk.hq.db.hq_session_cache.HqSessionCache(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)

NAME = 'HqSessionCache'

REPRESENTATION_ROW_CLASS

alias of HqSessionCacheRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(workstation, serialize_for_cli=False)

Return type:

list[HqSessionCacheRow]