ReverseLookup

class q2_sdk.hq.db.reverse_lookup.ReverseLookupRow[source]

Bases: RepresentationRowBase

reverseLookupKeyID: IntElement = 'reverseLookupKeyID'
reverseLookupKeyName: StringElement = 'reverseLookupKeyName'
UserID_: IntElement = 'UserID_'
CustomerID_: IntElement = 'CustomerID_'
lookupValue: StringElement = 'lookupValue'
class q2_sdk.hq.db.reverse_lookup.ReverseLookup(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 = 'ReverseLookup'
REPRESENTATION_ROW_CLASS

alias of ReverseLookupRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(key_name, user_id=None, customer_id=None, no_trunc=False, serialize_for_cli=False)[source]
Return type:

List[ReverseLookupRow]

async get_by_value(key_name, key_value, no_trunc=False, serialize_for_cli=False)[source]
Return type:

List[ReverseLookupRow]

async add_update(customer_id, user_id, key_name, key_value)[source]
async delete(key_name, customer_id, user_id, key_value, online_session, online_user)[source]