All Versions


DSpace Documentation


Page tree

Current Release

This documentation covers the latest release of DSpace, version 6.x. Looking for another version? See all documentation.

Skip to end of metadata
Go to start of metadata

This command can be used at any time to manage or upgrade the Database. It will also assist in troubleshooting PostgreSQL and Oracle connection issues with the database.

Command used:

[dspace]/bin/dspace database

Java class:

org.dspace.storage.rdbms.DatabaseUtils

Valid Arguments:

Description

testTest the database connection settings (in [dspace]/config/dspace.cfg or local.cfg) are OK and working properly.  This command also validates the database version is compatible with DSpace.
info

Provide detailed information about the DSpace database itself. This includes the database type, version, driver, schema, and any successful/failed/pending database migrations.

This command, along with "test", is very useful in debugging issues with your database.

migrate

Migrate the database to the latest version (if not already on the latest version). This uses FlywayDB along with embedded migrations scripts to automatically update your database to the latest version.

Optionally, you can run "migrate ignored" to also include any database migrations which are flagged as "Ignored" by the "info" command.

repair

Attempt to "repair" any migrations which are flagged as "Failed" by the "info" command and/or resolve failed checksum validation. This runs the FlywayDB repair command.

Please note however, this will NOT automatically repair corrupt or broken data in your database. It merely tries to re-run previously "Failed" migrations and/or realign the checksums of the applied migrations to the ones of the available migrations.

clean

Completely and permanently delete all tables and data in this database. WARNING: There is no turning back! If you run this command, you will lose your entire database and all its contents.

This command is only useful for testing or for reverting your database to a "fresh install" state (e.g. running "dspace database clean" followed by "dspace database migrate" will return your database to a fresh install state)

By default the 'clean' command is disabled (to avoid accidental data loss). In order to enable it, you must first set db.cleanDisabled=false in either your local.cfg or dspace.cfg.

validateValidate the checksums of all previously run database migrations. This runs the FlywayDB 'validate' command.
  • No labels