HeroEngine DB Migration Tool
|
Documentation on this page is intended for customers of HeroEngine managing their own server(s).
The HeroEngine DB Migration Tool is used for migrating database schemas between different versions of HeroEngine.
Installation
 |
Use with caution, as selecting the incorrect version to upgrade your world database tables beyond the desired version will cause many problems. Back up your database before beginning. |
Preconditions
- A properly configured developer workstation
- Oracle ODAC installed
- The correct 32-bit version of ODAC can be found at http://www.oracle.com/technetwork/database/windows/downloads/utilsoft-087491.html
- For example, for version of HeroEngine that are built against the Oracle 10.2.0 32-client, the OCAD1020221.exe file is the correct version.
- The correct 32-bit version of ODAC can be found at http://www.oracle.com/technetwork/database/windows/downloads/utilsoft-087491.html
Oracle 10g Release 2 ODAC Download the File ODAC1020221.exe 206 MB (216,841,603 bytes) Installation Instructions Important: If you are installing ODAC 10.2.0.2.21 on Windows Vista or Windows Server 2008, consult the installation instructions for installation steps on these operating systems. Download Includes Oracle Data Provider for .NET 1.x 10.2.0.2.20 Oracle Data Provider for .NET 2.0 10.2.0.2.20 Oracle Database Extensions for .NET 1.x 10.2.0.2.20 -- for upgrade only Oracle Database Extensions for .NET 2.0 10.2.0.2.20 -- for upgrade only Oracle Provider for OLE DB 10.2.0.2.20 Oracle Objects for OLE 10.2.0.2.20 Oracle Services for Microsoft Transaction Server 10.2.0.1.0
Download
The DB Migration Tool can be used only by licensees with full or source code licenses. The tool is available from the HeroEngine Downloads page, or can be built from source. The version of the tool available for download contains all valid releases.
Source
To build from source, access the product in the Perforce Depot, currently found at //depot/HeroEngineDBMigration/RELEASE/... .
The DB Migration Tool is built using Visual Studio 2013 (as of January 2014), opening up the RELEASE/<<Version>>/Migrate/Migrate.sln solution file. Set the run directory to be the solution directory in the Migrate project settings.
There is a "Migrate.ini" file located in the RELEASE directory which contains the "he_admin_password" and "servers" lines. Customize those for the licensee installation.
Usage
- Start the Database Migration Tool, from its current location on your system. Note that it will not be a Windows-installed app, so will need to be started directly from the appropriate folder.
Once opened, it can be seen that there are two tabs in the DMS Tool: "Databases" and "Files".
On the "Databases" tab, the available databases will be listed.
Adding databases
To add new databases, the Migrate.ini file must be modified directly, to add the desired databases on the "servers" line, each separated by a space.
Example ini file:
he_admin_password = ***** editor = notepad.exe scriptPath = Scripts servers = hjoracle opal bart evaldb evaldb2 onyx
Upgrading a database
From the "Databases" tab:
- Select a database by clicking on it, which will connect automatically to that database, and then populate the Schema List, which will appear in the lower lefthand portion of the panel.
- Release numbers for each schema will be one of three colors:
- Red: Must be upgraded to a newer version
- Yellow: Can be upgraded, but may not be necessary
- Green: Is using the current version
- Release numbers for each schema will be one of three colors:
- Select a Schema by clicking on it, and Upgrade Options will appear in the lower righthand corner of the panel.
- Upgrade options are:
- To Latest Release and Version
- To Latest Version of Current Release
- To Selected Release and Version
- With this last option, a "Release" dropdown menu appears, which allows you to choose which version to upgrade to.
Clicking on the Upgrade button accomplishes the upgrade of the specified schema, after which the release number in the "Schemas" list will switch to green, to indicate that it is up-to-date.
Files tab
(please expand)
