8.1. ngeneahubctl

The ngeneahubctl command is the main command line administration tool for Ngenea Hub

8.1.1. database

The ngeneahubctl database sub-commands are used for managing the Ngenea Hub database.

The database these commands will affect is the one Ngenea Hub is currently configured to use. These commands will work regardless of whether the target database is ‘internal’ or external, and the behaviour will be equivalent.

8.1.1.1. database wipe

Delete all data from the Ngenea Hub database.

ngeneahubctl database wipe

Warning

This operation is not reversable.

You should always create a database backup before running ‘wipe’. See the Backup guide for more details on creating backups.

Ngenea Hub must be running to perform a database wipe. After executing the ‘wipe’ command, perform a full restart of Ngenea Hub to re-initialise the now empty database.

After performing ‘wipe’, it will be necessary to re-join all Ngenea workers.

To execute this command, you will be prompted to verify that the command is being run on the correct machine by typing in the hostname of the machine. You will also be prompted to confirm that the correct database is being wiped - either ‘internal’ or ‘external’.

If the target database is external, and that database contains data other than that used by Ngenea Hub, only the Ngenea Hub data will be deleted. Any other data in the database will not be affected.

This command differs from ngeneahubctl wipe, which drops all Ngenea Hub container volumes. Dropping container volumes will clear database data as a side-effect, and only if Ngenea Hub is configured to use an internal database. ngeneahubctl wipe cannot remove data from an external database.

8.1.2. wipe

Drop all Ngenea Hub internal container volumes.

ngeneahubctl wipe

Warning

This operation is not reversable.

Dropping volumes will clear all Ngenea Hub internal container data, including

  • database data (if internal)

  • persistent Redis data (if internal)

  • persistent RabbitMQ data (if used and internal)

  • SSL certificates for internal services

ngeneahubctl wipe cannot remove data or volumes for external services.

To delete only database data, or to delete data from an external database, use ngeneahubctl database wipe instead.

You should always create a database backup before running ‘wipe’. See the Backup guide for more details on creating backups.

After performing ‘wipe’, it will be necessary to re-join all Ngenea workers.