State

class q2_sdk.hq.db.state.State(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

US State information from the Database

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)

GET_BY_NAME_KEY = 'StateName'

NAME = 'State'

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Pulls data from the Q2_State table

Parameters:

serialize_for_cli – Used when running from the command line