データベースアップグレードツールの使用
Liferayデータベースアップグレードツールは、Liferay DXPデータベースおよびLiferay Portalデータベースをオフラインでアップグレードするためのクライアントプログラムです。
アップグレードする前に必ず データとインストールを バックアップしてください。 バックアップコピーでアップグレードプロセスをテストすることをお勧めします。
6.2以前からアップグレードする場合は、ファイルストアの構成を更新します。 詳細については、 ファイル ストアの更新 を参照してください。
Liferayインスタンスから切り離している間にデータベースを修正することで、アップグレード操作用にデータベースをチューニングしたり、不要なデータ(Webコンテンツやドキュメントなどの不要なバージョンなど)を削除してアップグレードのパフォーマンスを向上させたり、アップグレードの問題を解決したりすることができます。 これらのアクティビティは、DXPをはじめとする大規模で重要なポータル環境を安全かつ迅速にアップグレードするために特に重要です。 データベースのチューニングとプルーニングを行い、 Liferay のアップグレードで説明されている関連タスクを完了したら、新しいインストールをセットアップし、アップグレードツールを使用してデータベースをアップグレードする準備が整います。
このツールは、バンドルの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ファイルを使用して構成する必要があります。以下は、必要な
rootDirパラメータを含むcom.liferay.portal.store.file.system.configuration.AdvancedFileSystemStoreConfiguration.configファイルの例です。rootDir="data/document_library" -
データベースベンダーが推奨するJDBCドライバーを使用してください。 例えばPostgreSQLを使用している場合は、
をportal-ext.propertiesファイルに設定し、アプリケーションサーバーが使用するPostgreSQL JDBCドライバJARを置き換えます。 詳細については、 データベースドライバ を参照してください。アップグレードツールのプロンプトに応答するか、アップグレードプロパティファイルを使用して、アップグレードを構成できます。
注新しい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を設定し ます。
アップグレードツールの実行
Liferay 7.4 U82/GA82 より前は、 db_upgrade_client.sh ファイルは db_upgrade.sh という名前でした。
アップグレードツールは、コマンドラインインターフェイスを介して、またはプロパティファイルを使用して によって構成されます。
[Liferay Home]/tools/portal-tools-db-upgrade-client フォルダにある db_upgrade_client.sh スクリプトは、アップグレードツール(Windowsでは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データベースをアップグレードしました。
これが試用版のアップグレードで、アップグレード時間を短縮したい場合は、データベースをアップグレード用に調整し(まだ行っていない場合)、データベースから不要なデータを削除してください。 必要に応じてこの記事の手順を繰り返してください。
問題が発生した場合は、 アップグレードレポート を確認し、 アップグレードのトラブルシューティングを参照してください。