データベースアップグレードツールの使用
Liferayデータベースアップグレードツールは、Liferay DXPデータベースおよびLiferay Portalデータベースをオフラインでアップグレードするためのクライアントプログラムです。
アップグレードする前に、必ず データとインストールを バックアップしてください。バックアップコピーでアップグレードプロセスをテストすることをお勧めします。
6.2以前からアップグレードする場合は、ファイルストアの構成を更新します。詳細については、 ファイル ストアの更新 を参照してください。
Liferayインスタンスから切り離している間にデータベースを修正することで、アップグレード操作用にデータベースをチューニングしたり、不要なデータを削除して(Webコンテンツやドキュメントなどの不要なバージョンなど)アップグレードのパフォーマンスを向上させたり、アップグレードの問題を解決したりすることができます。これらのアクティビティは、DXPをはじめとする大規模で重要なポータル環境を安全かつ迅速にアップグレードするために特に重要です。データベースのチューニングとプルーニングを行い、 Liferay のアップグレードで説明されている関連タスクを完了したら、新しいインストールをセットアップし、アップグレードツールを使用してデータベースをアップグレードする準備が整います。
新しいLiferay Dockerイメージにアップグレードし、アップグレードツールを使用する場合は、新しいLiferayバージョンのLiferay Tomcatバンドルからそのツールを実行してください。このツールは、バンドルのtools/portal-tools-db-upgrade-clientフォルダにあります。
新しい Liferay リリースをアプリケーション サーバーにインストールした場合は、 [Liferay Home]/tools/portal-tools-db-upgrade-client フォルダーを作成し、Liferay Tomcat バンドルからツールをそこにコピーします。
新規インストール時の設定
-
新しい Liferay インストールの
[Liferay Home]/dataフォルダを、[Liferay Home]/dataフォルダ( バックアップ から)に置き換えます。 -
DXP アクティベーション キー (サブスクリプション) と OSGi 設定ファイル を バックアップ から新しいインストール先にコピーします。
-
7.2 にアップグレードする場合は、新しいインストールの
[Liferay Home]/files/osgi/configs/フォルダーにある 構成ファイル を使用して検索インデックス作成を無効にします。例:cd liferay-homemkdir -p osgi/configsecho "indexReadOnly=\"true\"" >> osgi/configs/com.liferay.portal.search.configuration.IndexStatusManagerConfiguration.config注DXP/Portal 7.3以降は、検索インデックスが自動的に無効/再有効化されます。
-
Liferay Commerceをご利用の場合は、アップグレードの準備をしてください。詳細については、 Liferay Commerce のアップグレード を参照してください。
-
Liferayデータベースのアップグレードと一緒にマーケットプレイスアプリのデータをアップグレードする場合は、新しいLiferayバージョンの対象となる各アプリの最新バージョンをダウンロードして、
[Liferay Home]/deployフォルダにコピーします。それ以外の場合は、データベースのアップグレード後にアプリをインストールし、 アップグレード後の考慮事項に記載されているようにデータをアップグレードできます。 -
変更されたストレージ場所を使用して Advanced File System Store または Simple File System Store を使用している場合は、ファイル ストアの設定を
.configファイル にエクスポートし、それを新しい[Liferay Home]/osgi/configs/フォルダーにコピーします。重要Advanced File System Storeを使用している場合は、データベースをアップグレードする前に、新しいインストールで
.configファイルを使用して構成する必要があります。以下は、
com.liferay.portal.store.file.system.configuration.AdvancedFileSystemStoreConfiguration.configurationファイルの例で、rootDirパラメータが必要です:rootDir="data/document_library" -
データベースベンダーが推奨するJDBCドライバーを使用してください。例えば PostgreSQL を使用している場合は、
をportal-ext.propertiesファイルに設定し、アプリケーション サーバーが使用する PostgreSQL JDBC ドライバ JAR を置き換えます。詳細については、 データベースドライバ を参照してください。アップグレードツールのプロンプトに応答するか、アップグレードプロパティファイルを使用して、アップグレードを構成できます。
注新しいLiferay Dockerイメージにアップグレードする場合は、Docker環境変数の代わりにポータルプロパティを使用してデータベース接続を指定してください。ポータルプロパティリファレンス には、各Liferay環境変数に対応するポータルプロパティが一覧表示されます。
-
既存のインストールで
localesまたはlocales.enabledが上書きされている場合は、tools/portal-tools-db-upgrade-client/portal-upgrade-ext.propertiesファイルで同じ値を設定してください。これらのオーバーライドが欠落している場合に何が起こるかについては、 ロケール を参照してください。 -
(オプション) アップグレードレポート はデフォルトで有効になっています。オフにするには、
upgrade.report.enabled=falseを設定します。アップグレード レポートの出力ディレクトリを定義するには、upgrade.report.dir={your_directory}ポータル プロパティを設定します。何も設定されていない場合、tools/portal-tools-db-upgrade-client/reportsがデフォルトのレポートディレクトリになります。 -
(オプション) アップグレード ログ コンテキストを有効にするには、
tools/portal-tools-db-upgrade-client/portal-upgrade-ext.propertiesを設定します。ファイルでupgrade.log.context.enabled=true -
(オプション) 長時間実行中のクエリが停止しているのではなく進行していることを確認するには、
tools/portal-tools-db-upgrade-client/portal-upgrade-ext.propertiesを設定して、アップグレードの進行状況ログを有効にします。ファイルでupgrade.log.progress.enabled=true進行状況ログはステップが進んでいることを確認し、 アップグレード停止検出 はステップが進まない理由を報告します。
有効にすると、長時間実行される SELECT クエリは、
upgrade.log.progress.intervalで設定された最小間隔で進行状況メッセージをログに記録します (デフォルト:60000ミリ秒、つまり 60 秒)。各メッセージは、処理された行数と、カウントクエリが成功した場合の合計行数および割合を報告します。com.liferay.portal.upgrade.v7_0_0.UpgradePortletId {queryId=1} is still executing. Processed 50000 of 200000 rows. (25%)注進捗状況のログ記録を有効にすると、アップグレードにかかる総時間が長くなる場合があります。実行時間の長いクエリはそれぞれ、並列でカウントクエリを実行して合計行数を計算します。カウントクエリが10秒以内に完了しない場合、進捗状況のログ記録は行数のみのメッセージに切り替わります。
-
アップグレード停止検出 はデフォルトで有効になっています。しきい値を調整するには、
upgrade.query.monitor.lock.threshold(デフォルト:300000ミリ秒、つまり 5 分) とupgrade.query.monitor.long.running.threshold(デフォルト:600000ミリ秒、つまり 10 分) をに設定します。 tools/portal-tools-db-upgrade-client/portal-upgrade-ext.propertiesファイル。ロックしきい値を超えてリソースロックを待機しているクエリは、
WARNレベルでログに記録されます。Locked query "alter table AssetEntry add priority DOUBLE" with ID 4718 has been running for 372 seconds
アップグレードツールの実行
Liferay 7.4 U82/GA82 より前は、 db_upgrade_client.sh ファイルは db_upgrade.sh という名前でした。
アップグレードツールは、コマンドラインインターフェイスを介して、またはプロパティファイルを使用してによって構成されます。
db_upgrade_client.sh スクリプトは [Liferay Home]/tools/portal-tools-db-upgrade-client フォルダにあり、アップグレードツール (db_upgrade_client.bat を呼び出します。 --helpオプションは、ツールの使用状況を説明します。
./db_upgrade_client.sh --help
ここでは、アップグレードツールを使ってデータベースをアップグレードする方法を説明しています。
-
アップグレードツールを起動します。次にコマンドの例を示します。
cd liferay-home/tools/portal-tools-db-upgrade-client./db_upgrade_client.sh上記のコマンドはアップグレードツールを実行します。ファイルエンコーディング (
UTF-8)、タイムゾーン (GMT)、国、および言語はすべて、アプリケーションサーバーの設定と一致している必要があります。このツールはシステム環境に基づいてこれらを入力しますが、-jパラメータを使用することで、任意の JVM オプションを指定できます。このツールはデフォルトで最大ヒープメモリを4096MBに設定しています。 10 GB を超えるデータを持つデータベースの場合は、
-Xmxパラメーターを使用して追加のメモリを割り当てます。./db_upgrade_client.sh -j "-Xmx8192m" -
アップグレードが完了したら、 アップグレード レポート を確認して、データベースのアップグレードの失敗、エラー、または警告がないか確認してください。 Gogo Shell コマンド を使用して、問題のトラブルシューティングを行い、アップグレードを完了できます。
アップグレードプロパティファイルを使用してアップグレードを構成していない場合、アップグレードツールはいくつかの構成値の入力を求め、デフォルト値を括弧内に表示します。次に対話の例を示します。
$ ./db_upgrade_client.sh
Please enter your Liferay home (/opt/liferay):
[ jboss tomcat weblogic wildfly ]
Please enter your application server (tomcat):
Please enter your application server directory (/opt/liferay/tomcat):
Please enter your extra library directories in application server directory (./bin):
Please enter your global library directory in application server directory (./lib):
Please enter your portal directory in application server directory (./webapps/ROOT):
[ db2 mariadb mysql oracle postgresql sqlserver ]
Please enter your database (postgresql):
Please enter your database JDBC driver class name (org.postgresql.Driver):
Please enter your database JDBC driver protocol (jdbc:postgresql://):
Please enter your database host (localhost):
(etc.)
プロンプトに表示されるデフォルト値を使用する場合は、Enterキーを押します。入力された値は、ディレクトリパス、データベースホスト名の解決、データベースポート番号などを含め、入力時に検証されます。このツールは、 portal-ext.propertiesにある既存のデータベース構成を使用するため、それが構成されていることを確認してください。
Liferay DXP 2026.Q1
パフォーマンス上の理由から、このツールは実行中にバッチ挿入の最適化のためにJDBC URLを再構成します。例:
- MySQL/MariaDB:バッチ・ステートメントの書き換えを有効にする
rewriteBatchedStatements=trueを追加。 - PostgreSQL: バッチ挿入の最適化を有効にするために、
reWriteBatchedInserts=trueを追加します。 - SQL Server: バッチ操作の一括コピーを有効にするために、
useBulkCopyForBatchInsert=trueを追加します。
構成が完了すると、アップグレードが開始されます。このツールは、各アップグレード処理の開始と完了のログを記録します。
アップグレードツールでは、いくつかの設定項目のみを尋ねられます。アプリケーションにとって重要なものの多くは、 アップグレード プロパティ ファイル に設定する必要があります (例: dl.store.impl および module.framework.base.dir)。 portal-ext.properties 内のすべてのプロパティを portal-upgrade-ext.properties にコピーするのがベストプラクティスです。
データベースのアップグレードが完了し、問題が解決されました。
アップグレードされたデータベースのテスト
データベースのアップグレードが完了したので、テストしてみましょう。
-
新しいLiferay Dockerイメージにアップグレードしている場合は、イメージをアップグレードされたデータベースに指定し、Liferayをデータベースで検証します。詳細については、 Liferayコンテナの設定 を参照してください。
-
アップグレード後の考慮事項 を確認してください。
-
カスタムLiferay Homeファイルとアプリケーションサーバーファイルをバックアップから新しいインストールにコピーしてマージします。ファイルには次のものが含まれる場合がありますが、これらに限定されません。
/license/*:アクティベーションキー。(サブスクリプション)/log/*:ログファイル。/osgi/configs/*.config:OSGi設定ファイル。カスタム設定ファイルのみをコピーしてください。 Liferay によって生成された*-default.configファイルを含めないでください。portal-*.properties:portal-ext.propertiesのようなポータルプロパティファイル。- アプリケーションサーバーファイル:変更されたスクリプトと設定ファイル。
web.xml:ポータルWebアプリケーション記述子。
-
サーバーを起動し、アップグレードしたデータベースでLiferayを検証します。

データベースアップグレードツールを使用してLiferayデータベースをアップグレードしました。
これが試用版のアップグレードで、アップグレード時間を短縮したい場合は、データベースをアップグレード用に調整し(まだ行っていない場合)、データベースから不要なデータを削除してください。必要に応じてこの記事の手順を繰り返してください。
問題が発生した場合は、 アップグレード レポート を確認し、 アップグレードのトラブルシューティング を参照してください。