4.6. Data model tool

Data model tool not yet integrated in TEKSI wastewater

The plugin contains a data model tool capable of initializing and upgrading a TWW database.

It is aimed at system administrators and power users, and should not be used by end users, as it could lead to data loss if not used properly.

For advanced cases, it is also possible to upgrade your database manually

4.6.1. Setup

The data model tool is hidden by default. To make it visible, you must first enable Admin mode in the plugin settings :

  • Go to Plugin > TWW > Settings

  • Switch to the Developer options tab

  • Check Admin mode

  • Restart QGIS

The data model tool should now appear under Plugin > TWW > Data model tool

4.6.2. Usage

4.6.2.1. Main dialog

The main dialog looks like this.

../../_images/datamodel-tool.png

  • Release:

    • Version: the version to retrieve the files from. Unless developer mode is enabled in the TWW settings, only the latest stable version is available. Selecting anything different from the latest stable version should only ever be used on a testing database, as it could upgrade the database to an inconsistent state.

  • Dependencies:

    • Python requirements: If there are missing python requirements, click on the install button to try to install them automatically. Note that this will not work on all systems. If it fails, you can try to start QGIS with administrator privileges, or install the dependencies manually.

  • Postgres service configurations:

    • File location: shows the location of the pg_service.conf file being used

    • PG Config: allows to select the postgres service configuration of the database on which you want to operate. WARNING: by default, the first entry is selected, which may not match the database used by your currently open TWW project.

    • ``+`` button: opens an utility to add or edit entries from your pg_service.conf file directly.

    Refer to the installation guide to know more about the pg_service.conf file.

  • Data model

    • Current version: shows the current version of the datamodel found in the selected database

    • SRID: allows to customize the SRID (this is only supported on database initialization)

    • Action: allows to initialize or upgrade a datamodel to a specific version. WARNING: this will alter the datamodel in the specified database. Make sure you have a full and working backup of your database before performing an upgrade.

  • QGIS project

    • Load: opens the template QGIS project, already configured to work on the database selected above

4.6.2.2. Troubleshooting

In case you encounter issues or errors when using the data model tool, make sure to look at the TWW tab in the logs, as it may contain useful information (including errors returned by underlying tools).

Make sure to include this information if submitting a bug report or asking for support.