How to Perform Database Repairs

From TrainzOnline
Jump to: navigation, search

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.

This guide will take you through the process of performing manual database repairs and clean database installs. Trainz will automatically perform database repairs when it detects corruption in the Trainz database but sometimes a manual repair or even a manual clean install of the database is required.


  Top   Next Down Bottom

What is the "Trainz Database"?

DotPoint.JPG The Trainz Database contains all the installed assets

In the earliest Trainz versions all the assets that came installed with Trainz, or that you installed from the DLS or downloaded as .cdp files, were stored as separate folders on your designated data drive. This made it easy to access the assets for editing and other operations. However the penalty was that each time you started Trainz it had to scan the assets to check their integrity and the more assets you had the longer the startup took. This led to a great many complaints from users.

Today, all installed Trainz assets are added as records in an asset database which has significantly sped up the startup process and has reduced the possibility of accidental data corruption by users. The penalty is that users can no longer access the installed assets by using Windows Explorer. Access to the assets in the database for editing and examination is through the Content Manager program.

Because it is a database manager, Content Manager also provides users with many more search, display and management options than were ever previously possible. Each entry in the display shown below is a single record in the Trainz database. Each entry can be easily opened for editing, it can be deleted, copied (cloned) and updated. New assets can be manually created or installed from other sources.

DBR EDBR20.png

  Top Next Up Next Down Bottom

Why Would a Database Repair (DBR) Be Needed?

Quote from N3V

     "In terms of DB repairs, it should only be necessary if the program is updated or crashes. My understanding of the additional repairs are for things that are done outside the program function [i.e. outside of Content Manager and Surveyor] (like manually adding content into the local data folder) so in that case the db repair 'discovers' the new content".

When Trainz is operating there is a great deal of database activity going on with records being opened and closed, and data being read and written. Corruption of the data is always possible, particularly if the power supply is interrupted or the program is suddenly terminated (a "crash") while records are open or being written. For this reason, Content Manager comes equipped with automatic and manual database repair tools.

PencilTips.PNG A common, but not exclusive, cause of database problems and even CTDs (crashes to desktop) may be your Antivirus program. Each time Trainz accesses the database your AV program may be performing a scan of the database.

Adding TANE.exe, TRS19.exe and TRS22.exe to your AV programs real time scan exclusion list can potentially resolve many of these issues by preventing the AV from accessing the Trainz database.

  Top Next Up Next Down Bottom

How to Perform a Database Repair (a DBR)

DotPoint.JPG A DBR performs a "surface scan" of the database detecting missing content and content errors. It will update your database and can clean up some corrupted data.

This is the simplest and (usually) the fastest option.

NotePad.PNG Notes:

Perform a DBR if you have:-

  • unexpected problems with missing content
  • content errors with installed assets (particularly if those assets did not previously show any problems)

A DBR process updates your database, revalidates the content and can often clear up any corruption that has occurred.

PencilTips.PNG If you have installed a new asset that Content Manager reports has having missing or unknown assets then a DBR is very unlikely to find those missing assets.

Steps.PNG Steps:
DBR EDBR01.png DBR EDBR02.png
From either the Launcher (left) or Content Manager (right):-
  1. open the Developer menu
  2. select the Rebuild Database option

The process will proceed automatically and unaided through a number of steps, only some of which are shown below. The time required for each step will vary enormously (some will take much longer than others) and the total time involved will depend on the number of assets installed, the speed of your system and other factors.

1. Scanning for deleted asset files
DBR EDBR03.png

2. Scanning for added asset files
DBR EDBR04.png

3. Importing built in assets
DBR EDBR06.png

4. Rebuilding cached asset data
DBR EDBR07.png

The Rebuilding Trainz Asset Database window will disappear if the DBR process has been successfully completed without finding any errors. If errors have been found then the window will remain on the screen to report on the number of errors and warnings.

  Top Next Up Next Down Bottom

How to Perform an Extended Database Repair (an EDBR)

DotPoint.JPG An EDBR performs a "deep scan" of the database and checks that the data in every asset conforms to the rules for that type of asset

NotePad.PNG Notes:

  • An EDBR is a more complex, slower and potentially more troublesome repair process
  • An EDBR puts every single asset in the database through the same error and compliance checks that are run when a new asset is installed
  • Perform a EDBR if you have serious problems with your database that a DBR does not fix


It is not unusual for Content Manager to display a list of faulty assets after an EDBR that were not shown as faulty before the EDBR was run

Steps.PNG Steps:
DBR EDBR01.png DBR EDBR02.png
From either the Launcher (left) or Content Manager (right):-
  1. open the Developer menu
  2. hold down the Ctrl key
  3. select the Rebuild Database option

A possible result of an EDBR.

DBR EDBR10.png

  Top Next Up   Bottom

How to Create a "Clean Database"

DotPoint.JPG Creating a Clean Database:-
  • will return your Trainz database to its original, newly installed, condition
  • is usually performed when the Trainz Database contains faulty installed assets that are causing crashes and other major problems
  • does not destroy your original database

NotePad.PNG Notes:

This process will create a new Trainz database containing only the built in and base assets that came with the original Trainz installation (a "clean" database). Use this option if you want to remove from your Trainz install all:-

  • DLS assets
  • DLC assets - these will have to be reinstalled if you want them back
  • third party assets
  • assets you have created yourself (e.g. routes, sessions, etc) - but make sure that you have the original data files backed up somewhere

Stop.PNG You will be creating another copy of the database but without any downloaded content. You will need enough space on your selected data drive to hold the data.

Your original database will not be affected and will remain in its current location until you choose to delete, move or restore it.


DotPoint1.JPG Create a Container:
  1. use Windows File Explorer to create a new folder on your data drive (D: if you have one, C: if you don't)
  2. give the folder a meaningful and easy to remember name such as TRS19_Clean_Database
DBR EDBR30.png

  DotPoint2.JPG In Trainz Launcher:
  1. click the Trainz Settings button
  2. click the Install tab
  3. write down the location of the Local Data Folder - you may need it again!
  4. click the button [...] next to the local folder display name
  5. browse to your new data folder created in Step 1: Create a Container above
  6. select (click on but do not open) your new data folder
  7. click the button [Select folder]
  8. close any open File Explorer windows

You will see a progress bar as the built in assets are copied across to the new folder.

DBR EDBR31.png

  DotPoint3.JPG Restart Trainz and Reconfigure Settings:
  1. restart Trainz when you are prompted to do so
  2. open the Trainz Settings again and click the Internet tab. In TRS19 SP3 and later the Internet tab has been renamed to MyTrainz
  3. delete and re-enter your username and password
  4. when your username/password have been accepted, restart Trainz again
  5. open the Trainz Settings again and click the General tab
  6. adjust the settings to your preferred values
  7. click the Performance tab and adjust the settings to your preferred values
  8. exit Trainz Settings. Depending on which settings you have changed, you may be prompted to restart Trainz again
  9. click on Start Trainz

In TANE you will be prompted to download any DLC assets that you may have previously purchased. You can install them now or delay their install until later.

In TRS19/22 the Content Store, accessed from the Trainz Launcher, will allow you to select and install any previously purchased DLC assets.

NotePad.PNG Notes:

Your original database is still on your system at the location you recorded in Step 2 above. You may choose to:-

  • leave it there (it will take up many GBs of space)
  • archive or move it to offline storage
  • delete it

  Top Next Up    

Trainz Wiki


More Tutorials and Guides to Using Trainz

This page was created by Trainz user pware in January 2019 and was last updated as shown below.

Personal tools