ThirdPartyDataShared

class q2_sdk.hq.db.third_party_data_shared.ThirdPartyDataSharedRow[source]

Bases: RepresentationRowBase

VendorID: IntElement = 'VendorID'
UserID: IntElement = 'UserID'
GroupID: IntElement = 'GroupID'
DataID: IntElement = 'DataID'
DataValue: StringElement = 'DataValue'
Name: StringElement = 'Name'
Description: StringElement = 'Description'
class q2_sdk.hq.db.third_party_data_shared.ThirdPartyDataShared(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)

NAME = 'ThirdPartyDataShared'
REPRESENTATION_ROW_CLASS

alias of ThirdPartyDataSharedRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, vendor_id, group_id=<DEFAULT_DB_PARAM>, serialize_for_cli=False)[source]
Return type:

List[ThirdPartyDataSharedRow]

async create(user_id, vendor_name, data_name, data_value)[source]
async update(user_id, vendor_name, data_name, data_value)[source]
async delete(user_id, vendor_name, data_name)[source]