AdminUserPropertyDataElement

class q2_sdk.hq.db.admin_user_property_data_element.UserPropertyDataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Boolean = 'BOO'

String = 'STR'

Bit = 'BIT'

Integer = 'INT'

Double = 'DBL'

class q2_sdk.hq.db.admin_user_property_data_element.AdminUserPropertyDataElement(logger, hq_credentials=None, ret_table_obj=None)

Bases: UserPropertyDataElement

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)

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(property_name_prefix, no_trunc=False, serialize_for_cli=False)

async create(property_name, property_long_name, data_type=UserPropertyDataType.String, is_group_property=True, is_user_property=False)

async delete(property_name)

Note: this only works in the dev environment