AdapterInterface

class q2_sdk.hq.db.adapter_interface.AdapterInterfaceRow

Bases: RepresentationRowBase

InterfaceID: IntElement = 'InterfaceID'

ProductTypeID: IntElement = 'ProductTypeID'

RequestTypeID: IntElement = 'RequestTypeID'

AddressID: IntElement = 'AddressID'

FailoverInterfaceID: IntElement = 'FailoverInterfaceID'

Description: StringElement = 'Description'

BaseTimeoutSeconds: IntElement = 'BaseTimeoutSeconds'

PerRecordTimeoutSeconds: IntElement = 'PerRecordTimeoutSeconds'

IsEnabled: BoolElement = 'IsEnabled'

AdditionalConfigVendorID: IntElement = 'AdditionalConfigVendorID'

class q2_sdk.hq.db.adapter_interface.AdapterInterface(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 = 'AdapterInterface'

GET_BY_NAME_KEY = 'Description'

REPRESENTATION_ROW_CLASS

alias of AdapterInterfaceRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Return type:

List[AdapterInterfaceRow]

async get_by_request_type_name(request_type_name)

async update(short_name, address_id, product_type_id, enabled=1, vendor_id=None, serialize_for_cli=False)

async add(request_type_short_name, address_id, description, product_type_name=None, additional_config_vendor_name=None, serialize_for_cli=False)