Revision as of 07:56, 23 May 2020

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

This page is also available in text only format suitable for copying and pasting at How to Perform Database Repairs TEXT

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.

What is the "Trainz Database"?

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.

Why Would a Database Repair (DBR) Be Needed?

Quote from N3V

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.

A common, but not exclusive, cause of DB problems and even CTDs (crashes to desktops) 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 and/or TRS19.exe to your AV programs exclusion list can potentially resolve many of these issues by preventing the AV from accessing the Trainz database.

How to Perform a Database Repair (a DBR)

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.

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.

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

	Steps: From either the Launcher (left) or Content Manager (right):- open the Developer menu 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


2. Scanning for added asset files


3. Importing built in assets


4. Rebuilding cached asset data


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.

How to Perform an Extended Database Repair (an EDBR)

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

Notes: This 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 CM to display a list of faulty assets after an EDBR that were not shown as faulty before the EDBR was run

	Steps: From either the Launcher (left) or Content Manager (right):- open the Developer menu hold down the Ctrl key select the Rebuild Database option

A possible result of an EDBR.

How to Create a "Clean Database"

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

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

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.

Steps	Create a Container: use Windows File Explorer to create a new folder on your data drive (D: if you have one, C: if you don't) give the folder a meaningful and easy to remember name such as TRS19_Clean_Database
	In Trainz Launcher: click the Trainz Settings button click the Install tab write down the location of the Local Data Folder - you may need it again! click the button [...] next to the local folder display name browse to your new data folder created in Step 1: Create a Container above select (click on but do not open) your new data folder click the button [Select folder] close any open File Explorer windows You will see a progress bar as the built in assets are copied across to the new folder.
	Restart Trainz and Reconfigure Settings: restart Trainz when you are prompted to do so open the Trainz Settings again and click the Internet tab delete and re-enter your username and password when your username/password have been accepted, restart Trainz again open the Trainz Settings again and click the General tab adjust the settings to your preferred values click the Performance tab and adjust the settings to your preferred values exit Trainz Settings. Depending on which settings you have changed, you may be prompted to restart Trainz again click on Start Trainz 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.

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

Trainz Wiki

More Tutorials and Guides to Using Trainz How to Guides Driver Commands List Session Rules List (Alphabetical) with Parameters Session Rules List (Categories) With Parameters

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