DbPlan

class q2_sdk.core.install_steps.db_plan.DbPlan(allow_prompts=True)

Bases: object

Base class containing all possible configuration settings for installed forms. Extensions overwrite these attributes to set extension-specific settings.

async install(logger, hq_credentials, extension_name, custom_only=False, base_assets_url=None, force_update=False, is_central=False)

Install all items, unless custom_only flag is set to true. In which case only the custom install_steps will be run

Return type:

None

async uninstall(logger, hq_credentials, extension_name, custom_only=False)

Remove all items, unless custom_only flag is set to true. In which case only the custom install_steps will be removed

Return type:

None

hydrate(updated_install_vars_json)

Create install vars class from a json string

Parameters:

updated_install_vars_json (list) – List of dictionaries that will be turned into InstallStep objects

Return type:

None

classmethod from_json(db_plan_json)

A compliment to the to_json method. The JSON that to_json` outputs is not compatible with what the hydrate method accepts. from_json, however, can be called with the output of to_json.

Return type:

DbPlan