AdapterAddress
- class q2_sdk.hq.db.adapter_address.AdapterAddressRow(element, row_class=None, rename_fields=None)[source]
Bases:
TableRow
- class q2_sdk.hq.db.adapter_address.AdapterAddress(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 ifFalse
or TableRow objects from DB calls ifTrue
(Defaults to settings file)
- NAME = 'AdapterAddress'
- GET_BY_NAME_KEY = 'Address'
- REPRESENTATION_ROW_CLASS
alias of
AdapterAddressRow
- async get(address_id=None, http_only=True, address_value=None, processing_type_id=None, serialize_for_cli=False, suppress_messages=False)[source]
- Parameters:
address_id – Q2_AdapterAddresses.AddressID
http_only – If True, will only show addresses prefixed with http
serialize_for_cli – Used when running from the command line
- Return type: