データベースアップグレードツールの使用

Liferayデータベースアップグレードツールは、Liferay DXPデータベースおよびLiferay Portalデータベースをオフラインでアップグレードするためのクライアントプログラムです。

important

アップグレードする前に、必ずデータとインストールをバックアップしてください。バックアップコピーでアップグレードプロセスをテストすることをお勧めします。

important

6.2以前からアップグレードする場合は、ファイルストアの構成を更新します。詳細については、ファイルストアの更新を参照してください。

Liferayインスタンスから切り離された状態でデータベースを変更すると、データベースをアップグレード操作用に調整し、不要なデータ（Webコンテンツ、ドキュメントなどの不要なバージョンなど）を削除して、アップグレードのパフォーマンスを向上させ、アップグレードの問題を解決できます。これらのアクティビティは、DXPをはじめとする大規模で重要なポータル環境を安全かつ迅速にアップグレードするために特に重要です。データベースの調整と削除を考慮し、アップグレードの基本で説明されている関連タスクを完了すると、新しいインストールをセットアップし、アップグレードツールを使用してデータベースをアップグレードする準備が整います。

新しいLiferay Dockerイメージにアップグレードしていて、アップグレードツールを使用する場合は、新しいLiferayバージョンのLiferay Tomcat Bundleからそのツールを使用します。このツールは、バンドルのtools/portal-tools-db-upgrade-clientフォルダにあります。

新しいLiferayリリースをアプリケーションサーバーにインストールした場合は、[Liferay Home]/tools/portal-tools-db-upgrade-clientフォルダを作成し、アップグレードツールをダウンロードして、ツールを新しいフォルダにインストールします。

編集	ダウンロード手順
Liferay DXP（サブスクリプション）	ダウンロードページに移動し、DXPバージョンと製品/サービスパックのファイルタイプを選択します。表示されるリストで、 Liferay DXPアップグレードクライアント用の［ダウンロード］をクリックします。
Liferay Portal	ダウンロードページに移動します。［Liferay Portal］ダウンロードメニューで、［Other files］を選択して、［ダウンロード］をクリックします。最新のLiferay PortalのリリースアセットのGitHubページが表示されます。 `liferay-ce-portal-tools-[version].zip`をクリックします。

新規インストール時の設定

新しいLiferayインストールの[Liferay Home]/dataフォルダをバックアップの[Liferay Home]/dataフォルダに置き換えます。
DXPアクティベーションキー(Subscription)とOSGi設定ファイルをバックアップから新しいインストールにコピーします。
7.2にアップグレードする場合は、新しいインストールの[Liferay Home]/files/osgi/configigs/フォルダにある設定ファイルを使って検索インデックスを無効にします。例えば、こうだ、
```
cd liferay-home
```
```
mkdir -p osgi/configs
```
```
echo "indexReadOnly=\"true\"" >> osgi/configs/com.liferay.portal.search.configuration.IndexStatusManagerConfiguration.config
```
note

DXP/Portal 7.3以降は、検索インデックスが自動的に無効/再有効化されます。
Commerce を使用している場合は、Commerceをアップグレードする準備をしてください。詳細については、 Liferay Commerceのアップグレードを参照してください。
Liferayデータベースのアップグレードと一緒にマーケットプレイスアプリのデータをアップグレードする場合は、新しいLiferayバージョンの対象となる各アプリの最新バージョンをダウンロードして、[Liferay Home]/deployフォルダにコピーします。それ以外の場合は、アップグレード後の考慮事項で説明されているように、データベースのアップグレード後にアプリをインストールし、データをアップグレードできます。
高度なファイルシステムストアまたは簡易ファイルシステムストアを使用していて、保存場所を変更している場合は、ファイルストアの設定を .configファイルにエクスポートして、新しい[Liferay Home]/osgi/configs/フォルダにコピーします。

important

高度なファイルシステムストアを使用している場合は、データベースをアップグレードする前に、新しいインストールで.configファイルを使って設定する必要があります。

以下に例を示します。必要なrootDirパラメーターを含むcom.liferay.portal.store.file.system.configuration.AdvancedFileSystemStoreConfiguration.configファイル：

rootDir="data/document_library"
データベースベンダーが推奨するJDBCドライバーを使用してください。たとえば、MySQLを使用している場合は、portal-ext.propertiesファイルでjdbc.default.driverClassName=com.mysql.cj.jdbc.Driverを設定し、アプリケーションサーバーが使用するMySQL JDBCドライバーのJARを置き換えます。詳細は、データベースドライバーを参照してください。

アップグレードツールのプロンプトに応答するか、アップグレードプロパティファイルを使用して、アップグレードを構成できます。

note

新しいLiferay Dockerイメージにアップグレードする場合は、Docker環境変数の代わりにポータルプロパティファイルを使用してデータベース接続を指定してください。ポータルプロパティリファレンスには、各Liferay環境変数に対応するポータルプロパティが一覧表示されています。
(オプショナル）アップグレード報告を有効にするには、 tools/portal-tools-db-upgrade-client/portal-upgrade-ext.properties ファイルで upgrade.report.enabled=true を設定します。
(オプショナル）アップグレードログコンテキストを有効にするには、 /tools/portal-tools-db-upgrade-client/portal-upgrade-ext.properties ファイルで、 upgrade.log.context.enabled=true を設定します。

バッチインサートのプロパティ

portal-upgrade-database.propertiesファイルで、JDBC構成のバッチインサートプロパティを有効にすることができます。これは、INSERTステートメントのバッチ処理により実行を高速化することにより、パフォーマンスを向上させるものです。ベンダーのプロパティパラメータについては、以下の表を参照してください。この機能は、DB2およびOracleデータベースでは使用できません。

データベースプロバイダー	プロパティ
MariaDB	`rewriteBatchedStatements=true`
MySQL	`rewriteBatchedStatements=true`
PostgreSQL	`reWriteBatchedInserts=true`
SQL Server	`useBulkCopyForBatchInsert=true`

note

バッチインサートプロパティは、Liferay 7.4 U60+/GA60+ の portal-upgrade-database.properties ファイルに含まれています。

アップグレードツールの実行

important

Liferay 7.4 U82/GA82 以降では、db_upgrade.sh ファイルの名前が db_upgrade_client.sh に変更されました。

アップグレードツールの設定は、コマンドラインインターフェイスで行うか、プロパティファイルを使って行います。

[Liferay Home]/tools/portal-tools-db-upgrade-client フォルダにある db_upgrade_client.sh スクリプトがアップグレードツールを起動します (db_upgrade_client.bat on Windows)。 --helpオプションは、ツールの使用状況を説明します。

./db_upgrade_client.sh --help

ここでは、アップグレードツールを使ってデータベースをアップグレードする方法を説明しています。

アップグレードツールを起動します。次にコマンドの例を示します。
```
cd liferay-home/tools/portal-tools-db-upgrade-client
```
```
./db_upgrade_client.sh -j "-Dfile.encoding=UTF-8 -Duser.timezone=GMT -Xmx4096m"
```
上記のコマンドは、アプリケーションサーバーで推奨されているのと同じ JVM オプションでアップグレードツールを実行します。ファイルエンコーディング (UTF-8)、タイムゾーン (GMT)、国、言語、メモリ設定 (-Xmx value) はすべてアプリケーションサーバーの設定に合わせる必要があります。データが 10 GB を超えるデータベースについては、-Xmx オプションを使用して追加のメモリを割り当ててください。

アップグレードのプロパティファイルを使用してアップグレードの設定を行っていない場合、アップグレードツールは設定値の入力を促し、カッコ内にデフォルト値を表示します。以下は対話の例です：
```
Please enter your application server (tomcat):
tomcat

Please enter your application server directory (../../tomcat-9.0.17):

Please enter your extra library directories (../../tomcat-9.0.17/bin):

Please enter your global library directory (../../tomcat-9.0.17/lib):

Please enter your portal directory (../../tomcat-9.0.17/webapps/ROOT):

[ db2 mariadb mysql oracle postgresql sqlserver sybase ]
Please enter your database (mysql):
mariadb

Please enter your database host (localhost):

(etc.)
```
プロンプトに表示されたデフォルト値を使用する場合は、Enter キーを押します。

設定が完了すると、アップグレードが開始されます。このツールは、アップグレード処理の開始と完了をそれぞれログに記録します。
アップグレードが完了したら、アップグレードレポートにデータベースのアップグレードの失敗、エラー、警告がないか確認します。 Gogo Shellコマンドを使用して、それらの問題をトラブルシューティングし、アップグレードを完了できます。

データベースのアップグレードが完了し、問題が解決されました。

アップグレードされたデータベースのテスト

データベースのアップグレードが完了したので、テストしてみましょう。

新しいLiferay Dockerイメージにアップグレードしている場合は、イメージをアップグレードされたデータベースに指定し、Liferayをデータベースで検証します。詳しくは、Liferayコンテナの設定を参照してください。
アップグレード後の検討事項を調べます。
カスタム Liferay Homeのファイルとアプリケーションサーバーのファイルをバックアップから新規インストールにコピーしてマージします。ファイルには次のものが含まれる場合がありますが、これらに限定されません。
- /license/*：アクティベーションキー。 (サブスクリプション)
- /log/*：ログファイル。
- /osgi/configs/*.config：OSGi設定ファイル。
- portal-*.properties：portal-ext.propertiesのようなポータルプロパティファイル。
- アプリケーションサーバーファイル：変更されたスクリプトと設定ファイル。
- web.xml：ポータルWebアプリケーション記述子。
新しいインストール先でポータルのプロパティを更新します。
サーバーを起動し、アップグレードしたデータベースでLiferayを検証します。

データベースアップグレードツールを使用してLiferayデータベースをアップグレードしました。

これが試用版のアップグレードで、アップグレード時間を短縮したい場合は、データベースをアップグレード用に調整し（まだ行っていない場合）、データベースから不要なデータを削除してください。必要に応じてこの記事の手順を繰り返してください。

問題が発生した場合は、アップグレードレポートを確認し、アップグレードのトラブルシューティングを参照してください。

次のステップ

アップグレードの基本を再確認して、アップグレードに必要な残りの作業について確認してください。