TectonConfig

class q2_sdk.hq.db.tecton_config.TectonConfig(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)

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False, return_raw=False)[source]
async create(feature_name, feature_manifest)[source]
Return type:

dict

async update(feature_name, feature_manifest)[source]
Return type:

dict

static get_tecton_config(extension, short_name)[source]
Return type:

Optional[dict]

async delete(feature_name)[source]

Returns True if successful

Return type:

bool

async upsert(config)[source]
Return type:

dict