HqSessionCache

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

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)[source]
Return type:

SessionData

class q2_sdk.hq.db.hq_session_cache.HqSessionCacheRow(HqSessionCacheID, Workstation, ExpirationDate, SessionData)[source]

Bases: object

HqSessionCacheRow(HqSessionCacheID: ‘int’, Workstation: ‘str’, ExpirationDate: ‘datetime’, SessionData: ‘SessionData’)

HqSessionCacheID: int
Workstation: str
ExpirationDate: datetime
SessionData: SessionData
class q2_sdk.hq.db.hq_session_cache.HqSessionCache(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)

NAME = 'HqSessionCache'
REPRESENTATION_ROW_CLASS

alias of _HqSessionCacheRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(workstation, serialize_for_cli=False)[source]
Return type:

list[HqSessionCacheRow]