Backlog スタンダード: PostgreSQL から MySQL への移行ガイド

このドキュメントでは PostgreSQL から MySQL へデータを移行する手順を説明いたします。PostgreSQL はバージョン 9.6 をもってサポートを終了とさせていただきますので、お早めの移行をお願いいたします。MySQL をご利用の場合はこのガイドは必要ありません。

1 システム要件

本ドキュメントは Backlog スタンダード 最新版がインストールされており、 その環境は Backlog スタンダード インストールガイド システム要件を満たしている事を前提とします。

移行元の PostgreSQL はバージョン 9.5 と 9.6 をサポートしています。

大量のデータを移行する場合、移行ツールの実行に時間がかかる場合があります。所要時間については以下目安にご利用ください。

2 MySQL のインストールと設定

[mysqld]
max_allowed_packet = 48M

[mysqld]
innodb_buffer_pool_size = 1024M
innodb_log_file_size = 512M

3 PostgreSQL の設定確認

backlog=> show bytea_output;
 bytea_output
--------------
 hex

4 作業ディレクトリ構成

次の2つの jar ファイルが同じディレクトリにあるものとし、このディレクトリを「作業ディレクトリ」と呼んで説明を続けます。

• mysql-connector-java-5.1.X-bin.jar

  ※「2.2 MySQL の設定」で「データベースドライバーのダウンロード」でダウンロードした jar ファイルを指します。

• db-migration-tool.jar

  ※ backlog-updater-1.12.2.tar.gz を解凍してください。backlog-updater-1.12.2.tar.gz がない場合は、ダウンロードサイトからダウンロードしてください。

5 データ移行ツールの実行（時間計測）

データ移行ツールは PostgreSQL からダンプファイルを生成し、そのファイルを元にMySQL へデータを移行します。データ量が多いほど時間がかかります。

完全なデータ移行には Backlog を停止する必要があるため、一度ツールを実行しておおよその時間を計測し、どのくらいのダウンタイムが必要であるかを把握しておくことをお勧めします。

時間計測の目的でデータ移行を実行する場合は Backlog を停止する必要はございません。データ移行ツールは MySQL へデータを移行するだけで、Backlog は PostgreSQL を利用した状態のままです。

作業ディレクトリに移動してデータ移行ツールを root 権限で起動してください。コマンドの先頭に time をつけると、最後に実行時間が表示され、時間の計測がしやすくなります。

# time java -jar db-migration-tool.jar

データ移行ツールを開始します。　　　　　　　　　　　　　　　　　　　　　　　　　　

起動中の Backlog を確認しました。
データ移行ツールを本番実行する前には Backlog を必ず停止してください。処理を続けますか？
( y<処理を続ける> / q<中断し終了する> )

Backlog が起動している場合は処理を続けるか聞かれますので、y を選択して処理を続行します。本番実行の場合にこのメッセージが出た場合は q を選択し、 Tomcat を停止してからやり直してください。

======================================================================
Backlog スタンダードエディションの設定ファイルからデータベース情報を取得します。
Backlog をインストールしているディレクトリを絶対パスで指定してください。
（通常は "Tomcatのインストールされているパス/webapps" を指定します。例：/usr/local/apache-tomcat/webapps）

例えば Backlogで使用している Tomcat のインストール先が /usr/local/apache-tomcat の場合、/usr/local/apache-tomcat/webapps を指定してください。

Backlog が利用しているデータベースの種類を確認しました。PostgreSQL

Backlog が利用しているデータベースの種類が表示されます。MySQLをご利用の場合はここでツールが終了します。

Backlog のバージョンを確認しました。1.12.2

ご利用のBacklog のバージョンが表示されます。バージョンが最新ではない場合はここでツールが終了します。

このデータ移行ツールを初めて実行された場合は、エンターキーを押して、次に進んでください。

２回以上実行された場合は PostgreSQL のダンプファイルが実行ディレクトリの配下に backlog.dmp という名前で存在します。処理を省略できますので backlog.dmp を相対パスもしくは絶対パスで指定してください。
( <Enter> / <backlog.dmpのパス> ) 

初めてツールを実行された場合は、エンターキーを押してください。

再実行した場合で、PostgreSQL のダンプファイルがある場合は処理を省略できます。 作業ディレクトリの下に存在するダンプファイル （backlog.dmp）のパスを指定してください。

※ Backlog を停止せずに実行したときのダンプファイルはデータの漏れがあるので 本番では使用しないでください。

次の内容を利用して PostgreSQL のデータをダンプします。
サーバーホスト        [localhost]
ポート番号        [5432]
ユーザー        [backlog]
パスワード        [*****]

Backlog が利用しているデータベースの情報が表示されます。

PostgreSQL のデータダンプ用のコマンドが実行可能であることを確認しました。

ダンプに必要な pg_dump コマンドがあると上のメッセージが表示されます。

PostgreSQL のバージョンチェックを開始します。

PostgreSQL のバージョンが Backlog スタンダード インストールガイドの データベースに記載されているものであるか確認します。

PostgreSQL のダンプを開始しました。
PostgreSQL のダンプファイル dump_work_20200912230031/backlog.dmp を保存しました。

データベースのダンプに成功すると、上のメッセージが表示されます。

======================================================================
PostgreSQL のデータを MySQL へ移行します。

使用するJDBCドライバーを選択してください。
 1:mysql-connector-java-5.1.49-bin.jar
1

 1:mysql-connector-java-5.1.49-bin.jar が選択されました。

作業ディレクトリに存在する MySQL の JDBC ドライバー名が表示されます。JDBC ドライバー名の前に表示されている番号を指定してください。上では 1 を選択した状態を記載しています。

MySQL サーバーのホスト名を指定してください [localhost]

MySQL サーバーのホスト名を指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

MySQL サーバーのポート番号を指定してください [3306]

MySQL サーバーのポート番号を指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

MySQL のユーザーを指定してください [backlog]

MySQL のユーザーを指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

MySQL のユーザーのパスワードを入力してください [Backlog@1]

MySQL のユーザーのパスワードを指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

次の設定内容でデータ移行を行います。

サーバーホスト        [localhost]
ポート番号        [3306]
ユーザー        [backlog]
パスワード        [Backlog@1]

よろしいですか？
( y<続ける> / r<やり直し> )

MySQL の設定が表示されます。 y を選択すると MySQL への移行処理を続行します。r を選択すると、MySQL サーバーのホスト名の指定からやり直せます。

MySQL のバージョンチェックを開始します。

MySQL のバージョンが Backlog スタンダード インストールガイドの データベースに記載されているものであるか確認します。さらに、MySQL の backlog データベースにデータがあるかどうか確認し、もしデータがある場合はエラーメッセージが表示されツールが中断します。

テーブルの新規作成を開始します。
:
:
テーブルの新規作成が終了しました。

Backlog のテーブルの作成が成功すると、上のメッセージが表示されます。すでにテーブルが作成済みの場合は、作成処理をスキップすることができます。

PostgreSQL の設定値を調べています。

PostgreSQL の設定値の確認が始まると、上のメッセージが表示されます。

ダンプファイルの変換を開始しました。
ダンプファイルの変換に成功しました。

MySQL 用へダンプファイルの変換に成功すると、上のメッセージが表示されます。

MySQL へデータ移行しています。
MySQL へデータを移行しました。

MySQL へデータの移行が成功すると、上のメッセージが表示されます。データ量が多いほど時間がかかります。移行したあとも PostgreSQL 側にデータは残ります。

データベースの型変換をしています。
データベースの型変換が終了しました。

MySQL にデータを移行したあと、一部のデータの型変換が成功すると、上のメッセージが表示されます。データ量が多いほど時間がかかります。

終了
設定が完了しました。

データの移行が完了しました。
※ 実際にデータベースを切り替える場合にのみ、以下のコマンドを実行し Backlog が使用するデータベースをPostgreSQLからMySQLへ変更してください。
java -jar db-migration-tool.jar --switch-db

完了メッセージが表示され、データ移行ツールが終了します。

計測した時間はメンテナンスの計画にご利用ください。

6 Tomcat の停止

データ移行ツールを本番実行する前に Tomcat を停止してください。Tomcat を停止せずに Backlog が利用されると、正しくデータが移行されない可能性があります。

ps コマンド などで Tomcat のプロセスが停止していることを確認してください。

ps aux | grep tomcat

Tomcat のプロセスが停止しない場合がありますので、kill コマンド等で停止させて下さい。

kill TomcatのプロセスID

7 データ移行ツールの実行

「4. データ移行ツールの実行（時間計測）」と手順は同じです。詳細は「4. データ移行ツールの実行（時間計測）」をご参照ください。

計測時の MySQL のデータは消してから実行してください。

8 データベース切替ツールの実行

データ移行ツールが完了しましたら、次にデータベース切替ツールを実行します。このツールは Backlog がアクセスするデータベースを MySQL へ切り替えるためのものです。

作業ディレクトリに移動してデータベース切替ツールを root 権限で起動してください。

# java -jar db-migration-tool.jar --switch-db

データベース切替を開始します。

Backlog が停止していることを確認しました。
Backlog スタンダードエディションの設定ファイルからデータベース情報を取得します。
Backlog をインストールしているディレクトリを絶対パスで指定してください。
（通常は "Tomcatのインストールされているパス/webapps" を指定します。例：/usr/local/apache-tomcat/webapps）

例えば Backlogで使用しているTomcatのインストール先が /usr/local/apache-tomcat の場合、/usr/local/apache-tomcat/webapps を指定してください。

Backlog のバージョンを確認しました。1.12.2

ご利用の Backlog のバージョンを確認します。バージョンが最新ではない場合はここでツールが終了します。

現在のデータベースの設定は以下の通りです。

データベース        [PostgreSQL]
サーバーホスト        [localhost]
ポート番号        [5432]
ユーザー        [backlog]
パスワード        [*****]

現在 Backlog が利用中のデータベースの設定が表示されます。

切替先のデータベースを選択してください
( m<MySQL> / p<PostgreSQL> )

切り替えるデータベースを選択します。MySQL を選択したとして手順の説明を続けます。

MySQL サーバーのホスト名を指定してください [localhost]

MySQL サーバーのホスト名を指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

MySQL サーバーのポート番号を指定してください [3306]

MySQL サーバーのポート番号を指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

MySQL のユーザーを指定してください [backlog]

MySQL のユーザーを指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

MySQL のユーザーのパスワードを入力してください [Backlog@1]

MySQL のユーザーのパスワードを指定してください。メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

次の設定内容でデータベース切換を行います。

データベース        [MySQL]
サーバーホスト        [localhost]
ポート番号        [3306]
ユーザー        [backlog]
パスワード        [Backlog@1]

よろしいですか？
( y<続ける> / r<やり直し> )

切替先のデータベースの設定が表示されます。 y を選択すると Backlog の設定ファイルの書き換えが始まります（MySQLを選択した場合は、JDBCドライバーの設定も行います）。

r を選択すると、切り替え先のデータベースの選択からやり直せます。

使用するJDBCドライバーを選択してください。
 1:mysql-connector-java-5.1.49-bin.jar
1

 1:mysql-connector-java-5.1.49-bin.jar が選択されました。

作業ディレクトリに存在する MySQL の JDBC ドライバー名が表示されます。JDBC ドライバー名の前に表示されている番号を指定してください。上では 1 を選択した状態を記載しています。

終了
設定が完了しました。

上記のメッセージが表示され、データベース切替ツールが終了します。

9 Backlog の起動

Tomcatを起動して、Backlog にログインできるか確認をしてください。

MySQLに切り替わったかどうかを確認する方法は以下があります。

• PostgreSQL を停止する
• Backlog を操作して backlog データベースレコードに変更があるかを確認する

正常に動作していることを確認したら my.cnf の設定値を以下のように元に戻して、MySQL サーバーを再起動してください。

修正箇所

[mysqld]
max_allowed_packet = 16M

削除箇所

[mysqld]
innodb_buffer_pool_size = 1024M
innodb_log_file_size = 512M