TeamCity On-Premises 2026.2 Help

maintainDB コマンドラインツールによるバックアップの作成

TeamCity .tar.gz および .exe ディストリビューション は、 maintainDB.bat|sh ユーティリティを <TeamCity ホーム>/バイナリ ディレクトリに配置して提供します。 このコマンドラインツールを使用すると、サーバーデータのバックアップ、 復元 、および 異なるデータベース間の移行を行うことができます。 また、 UI を使用してデータをバックアップすることもできます。

バックアップする前に

データをバックアップする前に、すべてのビルドをバックアップに含めるため、TeamCity サーバーをシャットダウンすることをお勧めします。 バックアッププロセスが TeamCity サーバーの稼働中に開始された場合、実行中およびキュー内のビルドはバックアップに含まれません。

バックアップファイルの場所と形式

バックアップファイルのデフォルトディレクトリは <TeamCity データディレクトリ>\backup です。

バックアップファイル名のデフォルト形式は TeamCity_Backup_<タイムスタンプ>.zip です。 <タイムスタンプ> サフィックスは YYYYMMDD_HHMMSS 形式で追加されます。

maintainDB ユーティリティによる TeamCity データバックアップの実行

このセクションでは、 maintainDB オプションのいくつかについて説明します。 使用可能なすべてのオプションの完全なリストについては、パラメーターなしでコマンドラインから maintainDB を実行してください。

データバックアップファイルを作成する は、コマンドラインから maintainDB ユーティリティを backup コマンドで起動します。

maintainDB.[cmd|sh] backup

TeamCity データバックアップには いくつかの制限があります。 デフォルトでは、オプションのパラメーターなしで maintainDB ユーティリティを実行すると、データベース、サーバー設定、プロジェクトとビルド構成、プラグインと補足データ (設定履歴、トリガーの状態、プラグインのデータなど) のみがバックアップされ、ビルドログと個人の変更は省略されます。

バックアップスコープの設定

バックアップファイルに含めるデータの範囲を構成するには、次のオプションを使用します。

  • -C または --include-config — ビルド構成設定が含まれます

  • -D または --include-database — データベースを含む

  • -L または --include-build-logs — ビルドログが含まれます

  • -P または --include-personal-changes — 個人的な変更が含まれます

  • -U または --include-supplementary-data — 補足(プラグイン)データが含まれます

上記のオプションのさまざまな組み合わせを指定すると、バックアップファイルの内容を制御できます。 例: サポートされているすべてのタイプのデータでバックアップを作成する

maintainDB backup -C -D -L -P -U

データバックアップ用の maintainDB 使用例

カスタムのお名前でバックアップファイルを作成する は、 -F または --backup-file オプションを指定して maintainDB を実行し、拡張子なしで目的のバックアップファイル名を指定します。

maintainDB.cmd backup -F <backup file custom name> or maintainDB.cmd backup --backup-file <backup file custom name>

上記のコマンドを実行すると、デフォルトのバックアップディレクトリに指定された名前の新しい ZIP ファイルが作成されます。

カスタムファイル名にタイムスタンプのサフィックスを追加する は、 -M または --timestamp-suffix オプションを追加します。

maintainDB.cmd backup -F <backup file custom name> -M or maintainDB.cmd backup -F <backup file custom name> --timestamp-suffix

カスタムディレクトリにバックアップファイルを作成する は、 -F オプションを指定して、maintainDB を実行します。

maintainDB backup -F <absolute path to the custom backup directory> or maintainDB backup --data-dir <absolute path to the custom backup directory>

maintainDB 起動オプション

TeamCity サーバーの起動オプションを TEAMCITY_SERVER_OPTS/TEAMCITY_SERVER_MEM_OPTS 環境変数でカスタマイズする場合、またはカスタム JDK インストールを使用してサーバーを実行する場合は、 maintainDB スクリプトを、関連するオプションを TEAMCITY_MAINTAINDB_OPTS/TEAMCITY_MAINTAINDB_MEM_OPTS 環境変数に追加したうえで実行し、TeamCity サーバーとまったく同じ環境でそのスクリプトを実行して、同じ JVM が使用されるようにする必要がある場合があります。

2026 年 9 月 11 日