Database Jobs
These ConfD jobs control the management of the database. For more details about a job, click on the job name.
| Job name | Description |
|---|---|
| db_add_reserve_nodes | Adds the specified nodes as reserve nodes for the given database. The nodes must already be added to the cluster and configured accordingly. |
| db_backup_abort | This job aborts a running database backup. |
| db_backup_add_schedule | This job adds a backup schedule to the given storage volume with the given level and expiration time. |
| db_backup_change_expiration | This job changes the expiration time of the given backup. |
| db_backup_delete_unusable | This job deletes all unusable backups for the given database. An unusable backup is a backup which cannot be read or used anymore, for example a level 1 backup without a corresponding level 0 backup. |
| db_backup_list | This job returns a list of available backups for the given database. |
| db_backup_modify_schedule | This job modifies the given backup schedule with new parameters. The database must be running to run this job. |
| db_backup_progress | This job returns the progress of the currently-running backup for a given database. |
| db_backup_remove_schedule | This job removes the given backup schedule. |
| db_backup_start | This job starts a backup of the given database to the given archive volume with given level and expiration time. The database must be running in order to write a backup. |
| db_backups_delete | This job deletes the specified backup(s). |
| db_configure | This job changes the configuration of a database. The database must be offline to change its configuration. |
| db_configure_kerberos | Sets parameters for DB Kerberos authentication. |
| db_create | Creates a new database. A database with this name or UUID must not already exist. |
| db_delete | This job deletes a database. The database being deleted must already exist. |
| db_enlarge | This job increases the number of active database nodes. The database must be stopped to run this job. The nodes to be added must be added already as reserve nodes. Afterwards, the database is started with the new nodes automatically. |
| db_info | Returns a dictionary with the main database and volume parameters. |
| db_list | This job returns the name of all created databases. |
| db_remove_reserve_nodes | This job removes the specified nodes as reserve nodes from the given database. The specified nodes must already be added as reserve nodes. |
| db_reset | This job resets the database. After performing this operation, the database will be empty and all data (including metadata) is deleted. The database must be offline to perform a reset. |
| db_restore | This job restores the given database from the given backup. The backup must meet certain prerequisites defined in documentation, such as originating from a database with the same number of nodes. The database must be offline to perform a restore. |
| db_resume_nodes | This job resumes the suspended nodes in the given database. |
| db_snapshot_backup_add_schedule | This job adds a database snapshot schedule for the given database. The database must be configured with a snapshot_sync_volume, which is used for the schedule. |
| db_snapshot_backup_list | This job returns a list of available snapshots for the given database. |
| db_snapshot_backup_modify_schedule | This job modifies the given snapshot schedule with new parameters. The database must be running to run this job. |
| db_snapshot_backup_remove_schedule | This job removes the given snapshot schedule. |
| db_snapshot_backup_start | This job starts a database snapshot with the given expiration time. The database must be running to run this job. |
| db_snapshot_backups_delete | This job deletes the given database snapshots. |
| db_start | Starts the database. The database must already exist and must not be running. |
| db_state | This job returns the current state of the given database. Some common states are 'Running' (meaning the database is online), 'Setup' (meaning the database is offline), 'Startup' (meaning the database is starting up), and 'Shutdown' (meaning the database is shutting down). |
| db_stop | Stops a running database. The database nodes will remain online and available. |
| db_suspend_nodes | This job suspends the given nodes in the given database. Suspending a node means that the node is marked as unavailable, even though it continues to run. This can be used to perform maintenance on a node. If this is done to an active node while the database is running, the database will shutdown and restart with a reserve node instead (if configured). |
