Q2ConfigRegistry

class q2_sdk.hq.db.q2_config_registry.Q2ConfigParameters(extensionId=None, featureName=None, displayName=None, featureFlag=None, configUrl=None)

Bases: object

Q2ConfigParameters(extensionId: int = None, featureName: str = None, displayName: str = None, featureFlag: str = None, configUrl: str = None)

extensionId: int = None

featureName: str = None

displayName: str = None

featureFlag: str = None

configUrl: str = None

build_json_parameters()

enum q2_sdk.hq.db.q2_config_registry.Q2ConfigTable(value)

Bases: Enum

Valid values are as follows:

extension_id = <Q2ConfigTable.extension_id: 'ExtensionId'>

feature_name = <Q2ConfigTable.feature_name: 'FeatureName'>

display_name = <Q2ConfigTable.display_name: 'DisplayName'>

feature_flag = <Q2ConfigTable.feature_flag: 'FeatureFlag'>

config_url = <Q2ConfigTable.config_url: 'ConfigUrl'>

class q2_sdk.hq.db.q2_config_registry.Q2ConfigRegistryRow(element, row_class=None, rename_fields=None)

Bases: TableRow

ExtensionId: int

FeatureName: str

DisplayName: str

FeatureFlag: str

ConfigUrl: str

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

REPRESENTATION_ROW_CLASS

alias of Q2ConfigRegistryRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

serialize(data)

to_xml(json_data)

async get(serialize_for_cli=False)

Return type:

list[Q2ConfigRegistryRow]

async get_by_extension_id(extension_id)

Return type:

Q2ConfigRegistryRow

async create(endpoint_parameters)

async update(endpoint_parameters)

async delete(extension_id)