ApiStoredProc

class q2_sdk.hq.db.api_stored_proc.ApiStoredProcRow(element, row_class=None, rename_fields=None)

Bases: TableRow

StoredProcShortName: str

Description: str

StoredProcName: str

class q2_sdk.hq.db.api_stored_proc.ApiStoredProc(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

Allows for Access to the Q2_ApiStoredProc table, which registers stored procedures to use within the SDK via ExecuteStoredProcedure calls

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)

REPRESENTATION_ROW_CLASS

alias of ApiStoredProcRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Return type:

list[ApiStoredProcRow]

async create(short_name, description=None, name=None, audit_action=None)

Creates row in Q2_ApiStoredProc table

Parameters:

• short_name – Unique name of the stored procedure

• description (Optional[str]) – (Optional) defaults to name

• name (Optional[str]) – (Optional) Defaults to short_name

• audit_action (Optional[str]) – (Optional) Defaults to NULL

async delete(short_name)

Note: this only works in the dev environment