How to Perform Database Repairs

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m (Trainz Wiki)
 
(31 intermediate revisions by one user not shown)
Line 1: Line 1:
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.<br>
+
<table width=1000>
<table cellpadding="4">
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:TextBtn.png|link=|alt=Text]]&nbsp;</td>
+
<td>The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''.<br>
 +
 
 +
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 will be required.</td>
 +
</tr>
 +
</table>
 +
 
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=375>
 +
__TOC__
 +
</td>
 
<td>
 
<td>
<span style="font-weight: 700; background-color: yellow;">This page is also available in text only format suitable for copying and pasting at </span> '''[[media:How_to_Perform_Database_Repairs_TEXT.txt|How to Perform Database Repairs TEXT]]'''
+
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>The section describing how to create a '''Clean Install''' (i.e. containing only '''Base''' and '''Built-in''' assets) has been moved to its own Wiki Page. This can be found at:-
 +
:'''[[How_to_Create_a_Clean_Install|How to Create a Clean Install]]'''
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
__TOC__
+
<table width=1000> <!-- BEGIN Nav Buttons Table -->
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.
+
<tr valign="top">
 +
<td width=729><span id="stepWhat"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>[[file:NextDown.png|link=#stepWhy|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
 
='''What is the "Trainz Database"?'''=
 
='''What is the "Trainz Database"?'''=
  
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>The '''Trainz Database''' contains all the installed assets</td>
 
<td>The '''Trainz Database''' contains all the installed assets</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<br>
+
 
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.
+
<table width=1000>
 +
<tr valign="top">
 +
<td>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.
 
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.
+
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.</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
<table width=100%>
+
<table width=1000>
 
<tr>
 
<tr>
<td>
+
<td>[[file:DBR_EDBR20.png|link=]]</td>
[[file:DBR_EDBR20.png|link=]]
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
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.
+
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<br>
+
<table width="100%">
+
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepWhy"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepWhat|alt=Next Up|Next Up]]</td>
 +
<td width=75>[[file:NextDown.png|link=#stepHow|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
='''Why Would a Database Repair (DBR) Be Needed?'''=
 +
 
 +
<span style="font-weight: 700; font-size: 15px;">A Quote from N3V</span>
 +
 
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
 +
<td>"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".</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>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.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 bgcolor=#000000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffe0>
 +
<tr valign="top">
 +
<td>[[file:PencilTips.PNG|link=]]</td>
 +
<td>A common, but not exclusive, cause of database problems and even '''CTD'''s (crashes to desktop) may be your antivirus program. Everytime '''Trainz''' accesses the database your AV program may perform a scan of the database.<br><br>
 +
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 database.
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepHow"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepWhy|alt=Next Up|Next Up]]</td>
 +
<td width=75>[[file:NextDown.png|link=#stepEDBR|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 
='''How to Perform a Database Repair (a DBR)'''=
 
='''How to Perform a Database Repair (a DBR)'''=
  
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>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.</td>
 
<td>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.</td>
 
</tr>
 
</tr>
Line 54: Line 121:
 
This is the simplest and (usually) the fastest option.<br>
 
This is the simplest and (usually) the fastest option.<br>
  
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffb0>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:NotePad.PNG|link=]]</td>
 
<td>[[file:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
----
 
Perform a '''DBR''' if you have:-
 
Perform a '''DBR''' if you have:-
*'''unexpected problems''' with missing content
+
<table>
*content errors with installed assets (particularly if those assets did not previously show any problems)
+
<tr valign="top">
A DBR process updates your database, revalidates the content and can often clear up any corruption that has occurred.
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
</td>
+
<td>'''unexpected problems''' with missing content</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>content '''errors with installed assets''' (particularly if those assets did not previously show any problems)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>A '''DBR''' updates your database, revalidates the content and can often clear up any corruption that has occurred.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
+
</td>
<table cellpadding="4" bgcolor=#ffffb0>
+
</tr>
 +
<tr valign="top">
 +
<td colspan=2>
 +
<table bgcolor=#ffffe0>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:PencilTips.PNG|link=]]</td>
 
<td>[[file:PencilTips.PNG|link=]]</td>
<td>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.</td>
+
<td>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.
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td colspan="2">
+
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span></td>
----</td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
<td><span style="font-size: 17px; font-weight: 700;">Open the Developer Menu</span>
<table cellpadding="4" bgcolor=#ffffff>
+
<table>
 +
<tr valign="top">
 +
<td colspan=2>From either the '''Launcher''' (below left) or '''Content Manager''' (below right) open the '''Developer''' menu and select the '''Rebuild Database''' option</td>
 +
</tr>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:DBR_EDBR01.png|link=]]</td>
 
<td>[[file:DBR_EDBR01.png|link=]]</td>
 
<td>[[file:DBR_EDBR02.png|link=]]</td>
 
<td>[[file:DBR_EDBR02.png|link=]]</td>
 
</tr>
 
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>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.
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
<td colspan="2">From either the '''Launcher''' (left) or '''Content Manager''' (right):-
+
<td width=25>[[image:DotPoint1Blue.png|link=]]</td>
#open the '''Developer''' menu
+
<td>'''Scanning for deleted asset files'''<br>
#select the '''Rebuild Database''' option</td>
+
[[file:DBR_EDBR03.png|link=]]</td>
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td>[[image:DotPoint2Blue.png|link=]]</td>
 +
<td>'''Scanning for added asset files'''<br>
 +
[[file:DBR_EDBR04.png|link=]]</td>
 
</tr>
 
</tr>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td>[[image:DotPoint3Blue.png|link=]]</td>
----</td>
+
<td>'''Importing built in assets'''<br>
 +
[[file:DBR_EDBR06.png|link=]]</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint4Blue.png|link=]]</td>
 +
<td>'''Rebuilding cached asset data'''<br>
 +
[[file:DBR_EDBR07.png|link=]]</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
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.<br><br>
+
</td>
1. '''Scanning for deleted asset files'''<br>
+
</tr>
[[file:DBR_EDBR03.png|link=]]<br><br>
+
2. '''Scanning for added asset files'''<br>
+
[[file:DBR_EDBR04.png|link=]]<br><br>
+
3. '''Importing built in assets'''<br>
+
[[file:DBR_EDBR06.png|link=]]<br><br>
+
4. '''Rebuilding cached asset data'''<br>
+
[[file:DBR_EDBR07.png|link=]]<br><br>
+
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.<br>
+
<br>
+
<table width="100%">
+
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td>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.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<br>
 +
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepEDBR"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepHow|alt=Next Up|Next Up]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
 
='''How to Perform an Extended Database Repair (an EDBR)'''=
 
='''How to Perform an Extended Database Repair (an EDBR)'''=
  
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 
<td>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</td>
 
<td>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</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
 
+
<table width=XXX bgcolor=#000000 cellpadding=2>
<table cellpadding="4" bgcolor=#ffffb0>
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>
 +
<table width=XXX-4 bgcolor=#ffffb0 cellpadding=2>
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
*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
+
 
</td>
 
</td>
 
</tr>
 
</tr>
</table>
 
 
<table cellpadding="4" bgcolor=#fcbcbc>
 
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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</td>
+
<td>An '''EDBR''' is a more complex, slower and potentially more troublesome repair process</td>
 
</tr>
 
</tr>
</table>
 
<br>
 
<table cellpadding="4" bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
<td colspan="2">
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
----</td>
+
<td>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</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
<td>Perform an '''EDBR''' if you have '''serious problems''' with your database that a DBR does not fix</td>
<table cellpadding="4" bgcolor=#ffffff>
+
<tr valign="top">
+
<td>[[file:DBR_EDBR01.png|link=]]</td>
+
<td>[[file:DBR_EDBR02.png|link=]]</td>
+
 
</tr>
 
</tr>
<tr valign="top">
+
</table>
<td colspan="2">From either the '''Launcher''' (left) or '''Content Manager''' (right):-
+
</td>
#open the '''Developer''' menu
+
#hold down the '''Ctrl''' key
+
#select the '''Rebuild Database''' option</td>
+
</tr>
+
</table></td>
+
</tr>
+
<tr>
+
<td colspan="2">
+
----</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
A possible result of an EDBR.<br>
+
<table bgcolor=#ff0000>
<table width=100%>
+
<tr valign="top">
<tr>
+
 
<td>
 
<td>
[[file:DBR_EDBR10.png|link=]]
+
<table bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td>[[file:Stop.PNG|link=]]</td>
 +
<td><span style="font-size: 15px; font-weight: 700;">CAUTION:</span><br>
 +
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
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table width="100%">
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span></td>
 
</tr>
 
</tr>
</table>
 
 
='''How to Create a "Clean Database"'''=
 
 
<table cellpadding="4" bgcolor=#c1e7e7>
 
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td>Creating a '''Clean Database''':-
+
<td><span style="font-size: 17px; font-weight: 700;">Open the Developer Menu</span></td>
*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</td>
+
 
</tr>
 
</tr>
</table>
 
 
<table cellpadding="4" bgcolor=#ffffb0>
 
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td colspan=2>
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
+
<table> <!-- BEGIN Step 1 table -->
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:-
+
<tr valign="top">
*'''DLS''' assets
+
<td>[[file:DBR_EDBR01.png|link=]]</td>
*'''DLC''' assets - these will have to be reinstalled if you want them back
+
<td>[[file:DBR_EDBR02.png|link=]]</td>
*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</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
+
<table>
<table cellpadding="4" bgcolor=#fcbcbc>
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
+
<td colspan=2>From either the '''Launcher''' (left) or '''Content Manager''' (right):-</td>
<td>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.</td>
+
 
</tr>
 
</tr>
</table>
+
<tr valign="top">
 
+
<td width=25>[[image:DotPoint1Blue.png|link=]]</td>
<table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table -->
+
<td>open the '''Developer''' menu</td>
<tr>
+
<td colspan="2">
+
----</td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]<br><br>
+
<td>[[image:DotPoint2Blue.png|link=]]</td>
<span style="font-size: 17px; font-weight: 700;">Steps</span></td>
+
<td>hold down the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Ctrl&#160;</span> key</td>
<td>[[file:DotPoint1.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Create a Container:</span><br>
+
<table> <!-- BEGIN Step 1 table -->
+
<tr valign="top">
+
<td>
+
#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'''<br>
+
</td>
+
<td>[[file:DBR_EDBR30.png|link=]]
+
</td>
+
</tr>
+
<tr>
+
<td colspan="2">
+
----</td>
+
</tr>
+
</table> <!-- END Step 1 table -->
+
</td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>&nbsp;</td>
+
<td>[[image:DotPoint3Blue.png|link=]]</td>
<td>[[file:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">In Trainz Launcher:</span><br>
+
<td>select the '''Rebuild Database''' option</td>
<table> <!-- BEGIN Step 2 table -->
+
<tr valign="top">
+
<td>
+
#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.
+
</td>
+
<td>[[file:DBR_EDBR31.png|link=]]
+
</td>
+
 
</tr>
 
</tr>
<tr>
+
</table>
<td colspan="2">
+
----</td>
+
</tr>
+
</table> <!-- END Step 2 table -->
+
</td>
+
</tr>
+
<tr valign="top">
+
<td>&nbsp;</td>
+
<td>[[file:DotPoint3.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Restart Trainz and Reconfigure Settings:</span><br>
+
<table> <!-- BEGIN Step 3 table -->
+
<tr valign="top">
+
<td colspan=2>
+
#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.
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 +
</table>
 +
<br>
 +
A possible result of an EDBR.<br>
 +
<table width=1000>
 
<tr>
 
<tr>
<td colspan="2">
+
<td>
----</td>
+
[[file:DBR_EDBR10.png|link=]]
</tr>
+
</table> <!-- END Step 3 table -->
+
</td>
+
</tr>
+
</table> <!-- END Steps Table -->
+
 
+
<table cellpadding="4" bgcolor=#ffffb0>
+
<tr valign="top">
+
<td>[[file:NotePad.PNG|link=]]</td>
+
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
+
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
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<table width="100%">
+
<br>
 +
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="bottom"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepEDBR|alt=Next Up|Next Up]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 
</tr>
 
</tr>
</table>
+
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----
 
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:TrainzWiki.png|link=]]</td>
+
<td>
 +
<table width=500 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=80>[[image:TrainzWiki.png|link=]]</td>
 
<td>
 
<td>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
Line 323: Line 344:
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
<td>
 +
<table width=500 cellpadding=4 bgcolor="aquamarine">
 +
<tr valign="top">
 +
<td width=50>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
<span style="font-size: 17px;">'''Related Links'''</span><br>
 +
*'''[[How to Create a Clean Install|How to Create a Clean Install and Alternative User Data Folders]]'''
 +
*'''[[Using Content Manager to Update Assets|Using Content Manager to Update Assets]]'''
 +
*'''[[Understand Content Manager Status Labels|Understand Content Manager Status Labels]]'''
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>

Latest revision as of 16:00, 20 November 2023

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 will be required.

Contents

LinkWiki.PNG The section describing how to create a Clean Install (i.e. containing only Base and Built-in assets) has been moved to its own Wiki Page. This can be found at:-
How to Create a Clean Install


  Top   Next Down Bottom

[edit] What is the "Trainz Database"?

BlueDot10x10.png 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

[edit] Why Would a Database Repair (DBR) Be Needed?

A 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. Everytime Trainz accesses the database your AV program may perform 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 database.


  Top Next Up Next Down Bottom

[edit] How to Perform a Database Repair (a DBR)

BlueDot10x10.png 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:-

DotPoint.JPG unexpected problems with missing content
DotPoint.JPG content errors with installed assets (particularly if those assets did not previously show any problems)
A DBR 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:
DotPoint1.JPG Open the Developer Menu
From either the Launcher (below left) or Content Manager (below right) open the Developer menu and select the Rebuild Database option
DBR EDBR01.png DBR EDBR02.png
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.
DotPoint1Blue.png Scanning for deleted asset files
DBR EDBR03.png
DotPoint2Blue.png Scanning for added asset files
DBR EDBR04.png
DotPoint3Blue.png Importing built in assets
DBR EDBR06.png
DotPoint4Blue.png 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   Bottom

[edit] How to Perform an Extended Database Repair (an EDBR)

BlueDot10x10.png 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:

DotPoint.JPG An EDBR is a more complex, slower and potentially more troublesome repair process
DotPoint.JPG 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
DotPoint.JPG Perform an EDBR if you have serious problems with your database that a DBR does not fix


Stop.PNG CAUTION:

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:
DotPoint1.JPG Open the Developer Menu
DBR EDBR01.png DBR EDBR02.png
From either the Launcher (left) or Content Manager (right):-
DotPoint1Blue.png open the Developer menu
DotPoint2Blue.png hold down the  Ctrl  key
DotPoint3Blue.png select the Rebuild Database option


A possible result of an EDBR.

DBR EDBR10.png


  Top Next Up    


[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

LinkWiki.PNG

Related Links


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


Personal tools