UiConfigPropertyData

class q2_sdk.hq.db.ui_config_property_data.UiConfigPropertyDataRow(element, row_class=None, rename_fields=None)

Bases: TableRow

ConfigPropertyID: int

PropertyName: str

UiSource: str

PropertyDataType: str

PropertyValue: str

class q2_sdk.hq.db.ui_config_property_data.UiConfigPropertyData(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)

GET_BY_NAME_KEY = 'PropertyName'

NAME = 'UiConfigPropertyData'

REPRESENTATION_ROW_CLASS

alias of UiConfigPropertyDataRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(prefix, serialize_for_cli=False)

Return type:

List[UiConfigPropertyDataRow]

async create(property_name, property_data_type, property_value, is_central=False)

async delete(property_name)

async update(property_name, property_value, online_session, online_user, ui_source=None, config_property_id=None)