BuildForge Help

Migration Script Reference

The migration scripts convert version 3.8 data to the new schema and create new data objects.

Overview

Two migration scripts are provided to upgrade from a 3.8 installation:
  • bfmigrate performs initial conversion for any 3.8 installation. It has several command-line options, at least one of which must be used. The file is bfmigrate.exe for Windows, bfmigrate.pl for UNIX or Linux.
  • bfdbmigrate performs conversions on a MySQL database (provided with Build Forge version 3.8) to a DB Express database (provided with Build Forge 7.0 and later). It has no options.

The migration scripts are in the Build Forge installation directory. Execute them from a command line.

bfmigrate Reference

Syntax:

bfmigrate -[h|v|m|d|u|r]
This command converts a 3.8 database to the new schema.
Note: Your database must be running before you run the bfmigrate command. If your 3.8 installation used MySQL on Windows®, for example, you can issue the following commands to start MySQL (and if MySQL is already running, the system ignores the command).
cd "c:\Program Files\BuildForge\Apache\mysql\bin"
mysqld --standalone
Options
-h
Displays help text.
-v
Displays the version number.
-m
Migrates a 3.8 database to version 7.0 or later schema. The system renames existing tables (bf_users becomes b3_users, and so on), then creates a new set of bf_ tables. The system converts all data in the 3.8 tables to version 7.0 or later formats, as well as creating some new data objects. The migration produces a stream of status messages as it converts tables; some tables may take 30 minutes or more to convert, depending on the size of your database. When the migration is complete, the script displays the following message:
Migration: 4156: Successfully migrated v3.8 data to v7.0
Note: After a migration, you must update the License Server system configuration setting, which will be set to your old 3.8 license key. Set it to the machine name for your license server.
-d
Deletes tables saved from a 3.8 installation, by deleting all tables in the database whose names start with b3_.
-u
Undo a migration by dropping version 7.0 or later tables. You are left with a database with no 7.0 or later tables; if you preserved your 3.8 tables, they remain, but are not used (because they have been renamed to b3_ names). The engine automatically creates new, blank 7.0 or later tables when it is next started, so the result is an empty version 7.0 or later database.
-r
Roll back a migration. This option drops the 7.0 or later tables, then renames the b3_ tables to bf_ names. After a rollback, you can retry an upgrade from version 3.8 to version 7.0 or later.

bfdbmigrate Reference

Windows only. Use this command only after performing a bfmigrate conversion, if and only if your 3.8 installation used the MySQL database installed by the system (if you installed your own, separate MySQL database, do not use this script). To run it, issue the following command from your installation directory:
bfdbmigrate 
The script creates a schema in the DB2 Express database. As with the bfmigrate script, you should wait until the script completes. The script generates a series of messages as it converts various tables, ending with the following message, and a successful migration does not generate any error messages.
Migration: 5148: Successfully migrated from old db to new

Data Created by bfmigrate

In addition to migrating your existing data objects, the script derives some new ones from your database. You can modify these data objects after migration. The script: