UserPropertyCategory

class q2_sdk.hq.db.user_property_category.UserPropertyCategoryRow

Bases: RepresentationRowBase

CategoryID: IntElement = 'CategoryID'

ShortName: StringElement = 'ShortName'

Description: StringElement = 'Description'

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

REPRESENTATION_ROW_CLASS

alias of UserPropertyCategoryRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async create(shortname, description, serialize_for_cli=False)

Return type:

List[UserPropertyCategoryRow]

async get(serialize_for_cli=False)

async get_category_by_shortname(shortname, serialize_for_cli=False)

Return type:

List[UserPropertyCategoryRow]