Migrating to an External Database

Skip to end of metadata
Go to start of metadata
You are viewing documentation of TeamCity 4.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.
Search

Searching TeamCity 4.x Documentation

Table of Contents

By default, TeamCity runs using an internal database that uses the HSQLDB database engine. The internal database suits evaluation purposes since it works out of the box and requires no additional setup. However, we strongly recommend using an external database as a back-end TeamCity database in a production environment.

External database is usually more reliable and provides better performance.

This section covers:

TeamCity supports the following external databases:

  • MySQL,
  • Oracle,
  • PostgreSQL,
  • Microsoft SQL 2005.

Please refer to Setting up an External Database page for the database-specific configuration steps. If you want to start using external database from the first TeamCity start, these are the only steps you need.

If you were using TeamCity with the internal storage engine, there are two ways to switch to an external database:

  • Switch with no data migration: build configurations settings will be preserved, but not the historical builds data or users.
  • Full Migration: all the data is preserved except Inspections and Duplicate build results (and any database-stored data provided by the third-party plugins).
Database migration cannot be combined with server upgrade. If you want to upgrade at the same time, you should first upgrade, run the new version of TeamCity, and then migrate to another database.

Switching to Another Database

To switch to another database without saving the build history or user data:

  1. Install and set up an external database.
  2. Shut down the TeamCity server.
  3. Create a backup copy of the <TeamCity Data Directory> used by the server
  4. Clean up the system folder: you must remove messages and artifacts folders from /system folder of your <TeamCity data directory>; you may delete old HSQLDB files: buildserver.* to remove the no longer needed internal storage data.
  5. Start the TeamCity server.

Full Migration

TeamCity supports HSQLDB, MySQL, Oracle, PostgreSQL and Microsoft SQL Server 2005; the migration tool can move data between any of these databases.

The target database must be empty before the migration process (it should NOT contain any tables).

To migrate all your existing data to a new external database:

  1. Set up an external database to be used by TeamCity. You can refer to Setting up an External Database for information on how to set up a TeamCity-specific. (At this point you should only create and configure the database, do not modify any TeamCity settings at this time).
  2. Shut the TeamCity server down.
  3. Create a backup copy of the <TeamCity Data Directory> used by the server
  4. If the database driver is not bundled with TeamCity (refer the database properties table below, and place the appropriate driver into the TeamCity WEB-INF/lib directory. The following instructions refer to the driver as <DRIVER_JAR_NAME>.
  5. Edit the <TeamCity home>/bin/dbMigration.properties file, entering correct values for the source and target database. Ensure all the properties are supplied and only the necessary lines are uncommented (single-line comments are designated by # character)
  6. Run the migration tool (see below)
  7. Upon the successful completion of the database migration, a database.properties file will be created. migrateDB script will automatically copy it into config directory of <TeamCity data directory>.
  8. Edit <TeamCity data directory>/config/database.properties file according to the settings of the target database as described in the appropriate section of Setting up an External Database page.
  9. Additionally a version.dat file will be created. migrateDB script will automatically copy it into system directory of <TeamCity data directory>.
  10. Start TeamCity server. This should be the same TeamCity version that was run last time (TeamCity upgrade should be performed as a separate procedure).

Databases Properties Table

Sample dbMigration.properties file residing in the bin directory contains sections for several databases.
DB Name Driver Class Name Driver jar Name Driver is Bundled JDBC URL format
MySQL com.mysql.jdbc.Driver mysql-connector-java-5.0.8-bin.jar no, download page jdbc:mysql://<host>[:<port>]/<database>
PostgreSQL org.postgresql.Driver postgresql-8.2-505.jdbc3.jar yes jdbc:postgresql://<host>[:<port>]/<database>
Oracle oracle.jdbc.driver.OracleDriver ojdbc14.jar no, download page jdbc:oracle:thin:@<host>:<port>:<database>
HSQLDB org.hsqldb.jdbcDriver hsqldb.jar yes jdbc:hsqldb:hsql://<host>[:<port>]/<database>
MS SQL net.sourceforge.jtds.jdbc.Driver jtds-1.2.2.jar no, download page jdbc:jtds:sqlserver://<host>[:<port>]/<database name>

Running the Migration Tool

You can use the migrateDB.bat/migrateDB.sh script located in the <TeamCity home>\bin directory. Just run the script and follow the instructions.

Generally, you would need to run the script with single migrate parameter to perform the migration and move the generated configuration files into <TeamCity data directory>.

Troubleshooting

  • Extended information during migration execution is logged into logs\teamcity-dbmt.log file. Also, logs\teamcity-dbmt-truncation.log contains extended information on possible data truncations during the migration process.
    In TeamCity versions previous to 4.5, information about DB migrating process is logged into bin/migration*.log file.
  • If you encounter an "out of memory" error, try increasing the number in the -Xmx512m parameter in the migrateDB script. On a 32-bit platform the maximum is about 1300 megabytes.

Alternative approach is to run HSQLDB in standalone mode via

and then running the Migration tool pointing to the database as the source: jdbc:hsqldb:hsql://localhost/buildserver sa ''

  • If you get "The input line is too long." error while running the tool (e.g. this can happen on Windows 2000), please change the script to use alternative classpath method.
    For migrateDB.bat, remove the lines below "Add all JARs from WEB-INF\lib to classpath" comment and uncomment the lines below "Alternative classpath: Add only necessary JARs" comment.



See Also:

Labels:

admin admin Delete
mysql mysql Delete
migrate migrate Delete
external external Delete
database database Delete
oracle oracle Delete
mssql mssql Delete
2005 2005 Delete
Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.
  1. Dec 04, 2008

    A few notes on windows 2003 to perform a db migration here so to save time for windows users.
    1)You need to download Java JDK here: http://java.sun.com/javase/downloads/index.jsp
    2)This needs to be done below so you avoid the No 'Server' jvm Error:
    1. Copy 'server' folder from the JDK's JRE's bin folder (example: C:\Program Files\Java\jdk1.6.0\jre\bin\server)
    2. Paste the 'server' folder to JRE's bin folder(example: C:\Program Files\Java\jre1.6.0\bin)
    --Credited for this is here:http://thiamteck.blogspot.com/2007/10/error-no-server-jvm-at.html
    3)In database.properties file make sure you change this line to your appropriate directory if you have changed the default directory:
    sourceURL=jdbc:hsqldb:file:<PATH/TO/.BuildServer>/system/buildserver

    Step 8 above is redundant and is not needed assuming step 7 works.

    Overall steps worked well, minus java problems I had.

  2. Jul 07, 2009

    On Windows, I think the environment variables need to exist, I couldn't get it to work otherwise:

    TEAMCITY_DATA_PATH  Path to BuildServer directory
    TEAMCITY_APP_DIR    Path to TeamCity application directory (default is <TeamCity_home>\webapps\ROOT)

    No need to download Java, it's already included in the <teamcity app dir>\jre, just add it to the PATH.

    You can add forceClean=true to the end of the dbMigration.properties file to DELETE all tables in the database if you have to retry the script a few times like I did.