SystemPropertyData

class q2_sdk.hq.db.system_property_data.ZoneContext(zone_id=None)[source]

Bases: object

If there is a zone context at all, even with null zone_id, the response will include zone data

zone_id: Optional[int] = None
static from_zone_id(zone_id)[source]
Return type:

ZoneContext

async static from_group_id(group_id)[source]
Return type:

ZoneContext

class q2_sdk.hq.db.system_property_data.SystemPropertyDataRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

Data from the Q2_SystemPropertyData table

SystemPropertyDataID: int
PropertyID: int
PropertyValue: str
PropertyName: str
PropertyLongName: str
PropertyDataType: str
Weight: int
UISourceID: int
ProductTypeID: int
ProductID: int
GroupID: int
HADE_ID: int
class q2_sdk.hq.db.system_property_data.ZonedSystemPropertyDataRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

Data from the Q2_ZoneSystemPropertyData table

ZoneSystemPropertyDataID: int
SystemPropertyDataID: int
ZoneId: int
PropertyID: int
PropertyValue: str
PropertyName: str
PropertyLongName: str
PropertyDataType: str
Weight: int
UISourceID: int
ProductTypeID: int
ProductID: int
GroupID: int
HADE_ID: int
class q2_sdk.hq.db.system_property_data.SystemPropertyData(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 if False or TableRow objects from DB calls if True (Defaults to settings file)

GET_BY_NAME_KEY = 'PropertyName'
NAME = 'SystemPropertyData'
REPRESENTATION_ROW_CLASS

alias of SystemPropertyDataRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(name=None, group_id=None, hade_id=None, return_count=10, no_trunc=False, strict=False, zone_context=None, serialize_for_cli=False, **kwargs)[source]
Return type:

List[SystemPropertyDataRow]

async get_by_id(property_id, serialize_for_cli=False)[source]
async update(property_name, property_value, group_id=None)[source]
async add(property_name, property_value, product_type_name=None, serialize_for_cli=False)[source]
exception q2_sdk.hq.db.system_property_data.ZoneNotFoundError[source]

Bases: Exception

No zone found