DataFeed

class q2_sdk.hq.db.data_feed.UpdateDataFeed(shortName, description=None, enabled=None, wedgePathName=None, wedgeJsonData=None, url=None, config=None)[source]

Bases: object

UpdateDataFeed(shortName: str, description: str | None = None, enabled: bool | None = None, wedgePathName: str | None = None, wedgeJsonData: dict | None = None, url: str | None = None, config: dict | None = None)

shortName: str
description: str | None = None
enabled: bool | None = None
wedgePathName: str | None = None
wedgeJsonData: dict | None = None
url: str | None = None
config: dict | None = None
build_params()[source]
param_to_type(field_name)[source]
class q2_sdk.hq.db.data_feed.DataFeedRow(element, row_class=None, rename_fields=None)[source]

Bases: BaseFormRow

DataFeedID: int
ShortName: str
Description: str
Enabled: bool
WedgePathName: str
WedgeAddressID: int
WedgeJsonData: str
class q2_sdk.hq.db.data_feed.DataFeed(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: InstallerObj

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 (HqCredentials | None) – HQ Connectivity Information (Defaults to settings file)

  • ret_table_obj (bool | None) – 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 = 'ShortName'
NAME = 'DataFeed'
REPRESENTATION_ROW_CLASS

alias of DataFeedRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False, short_name=None, data_feed_id=None)[source]
Return type:

List[DataFeedRow]

async create(short_name, description, wedge_path_name, wedge_json_config=None, is_customer_created=False, company=None)[source]
async update(update_parameters)[source]
async delete(short_name, remove_wedge_address=True)[source]