DataFeed

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

Bases: object

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

shortName: str

description: Optional[str] = None

enabled: Optional[bool] = None

wedgePathName: Optional[str] = None

wedgeJsonData: Optional[dict] = None

url: Optional[str] = None

config: Optional[dict] = None

build_params()

param_to_type(field_name)

class q2_sdk.hq.db.data_feed.DataFeedRow

Bases: BaseFormRow

DataFeedID: IntElement = 'DataFeedID'

ShortName: StringElement = 'ShortName'

Description: StringElement = 'Description'

Enabled: BoolElement = 'Enabled'

WedgePathName: StringElement = 'WedgePathName'

WedgeAddressID: IntElement = 'WedgeAddressID'

WedgeJsonData: StringElement = 'WedgeJsonData'

class q2_sdk.hq.db.data_feed.DataFeed(logger, hq_credentials=None, ret_table_obj=None)

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 (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 = 'ShortName'

NAME = 'DataFeed'

REPRESENTATION_ROW_CLASS

alias of DataFeedRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False, short_name=None, data_feed_id=None)

Return type:

List[DataFeedRow]

async create(short_name, description, wedge_path_name, wedge_json_config=None, is_customer_created=False, company=None)

async update(update_parameters)

async delete(short_name, remove_wedge_address=True)