DB Upgrade Clientは、Liferay DXPデータベースをアップグレードする際に使用するスタンドアローンクライアントです。 本記事では、DBアップグレードクライアントのインストールと実行方法について説明します。
解決策
インストール
DB Upgrade Clientのインストールと実行には、以下の2つの方法があります。
- このクライアントは、カスタマーポータルから購入できるすべてのバンドルに含まれています。 Liferay DXPを.WARとしてアプリケーションサーバーに展開する場合でも、追加ファイルのためにバンドルをダウンロードするのは良いアイデアです。
- Liferay DXPをアプリケーションサーバーにデプロイする。
- アプリケーションサーバーをシャットダウンします。
- クライアントをLiferay Digital Enterpriseインスタンスに解凍します（例：
${liferayHome}/tools/portal-tools-db-upgrade-client）。 - 実行
java -jar com.liferay.portal.tools.db.upgrade.client.jar
- JPMの使用
- インストール jpm
- 実行
jpm install com.liferay.portal.tools.db.upgrade.client - 実行
liferay-upgrade-db
どちらの方法も、ツールの実行方法は別々です。 ただし、次のセクションに記載されているコマンドラインオプションは、どちらの方法でも同じように付加することができます（例： liferay-upgrade-db --noShell）。
使用量
初めてツールを実行すると、Liferay DXPのインストールに応じたプロパティが自動的に設定されます。 app-server.properties, portal-upgrade-database.properties, portal-upgrade-ext.propertiesを設定することで手動で行うことも可能です。 これらの .properties ファイルは、必ずツールを実行するのと同じディレクトリに配置してください。
また、DB Upgrade Clientは、アップグレード後、自動的にGogoシェルに接続します。 これにより、モジュールのアップグレードの状況を確認することができます。
com.liferay.portal.upgrade.internal.configuration.ReleaseManagerConfiguration.cfg というファイルを osgi/configs/ フォルダに以下の内容で追加すると、外部モジュールではなくコアのみをアップグレードするようにポータルを構成することができます。 autoUpgrade=false .
コマンドライン実行のオプション、Gogoシェルコマンド、コンフィギュレーションは以下から参照できます。
コマンドラインオプション
-
--jvm-optsまたは-j- アップグレード処理に必要な JVM オプションを設定します。 -
--log-fileまたは-l- ログファイルにカスタム名を使用します。 -
--shellまたは-s- アップグレード時にGogoシェルに接続します。
ゴーゴーシェルコマンドオプション
-
exitorquit- Gogoシェルを終了します。 -
upgrade:help- アップグレードコマンドを表示します。 -
upgrade:check- 失敗した、または開始されていないアップグレードをリストアップします。 -
upgrade:execute {module_name}- そのモジュールに対するアップグレードを実行します。 -
upgrade:list- 登録されているすべてのアップグレードの一覧を表示します。 -
upgrade:list {module_name}- そのモジュールに必要なアップグレード手順をリストアップします。 -
upgrade:list | grep Registered- 登録されたアップグレードとそのバージョンを一覧表示します。 -
upgrade:list | grep Registered | grep steps- 登録済みの進行中のアップグレードを一覧表示します。 -
verify:execute {module_name}- ベリファイアを実行する。 -
verify:list- 登録されているベリファイアをすべてリストアップします。
設定オプション
app-server.properties（アップサーバプロパティ
-
dir- アプリケーションサーバーのディレクトリ(必須) -
extra.lib.dirs- クラスパスに追加したい追加ディレクトリのカンマ区切りリスト (必須) -
global.lib.dir- アプリケーションサーバーのグローバルリブディレクトリ (必須) -
portal.dir- ポータルディレクトリ (必須)
portal-upgrade-database.properties（ポータルアップグレードデータベースプロパティ
-
jdbc.default.driverClassName(必須) -
jdbc.default.url(必須) -
jdbc.default.username(必須) -
jdbc.default.password(必須)
portal-upgrade-ext.properties（ポータルアップグレードエクストプロパティ
-
liferay.home- Liferay DXP のホームディレクトリ (必須) -
hibernate.jdbc.batch_size- パフォーマンスを向上させるために使用するJDBCバッチサイズ。デフォルトでは250に設定されています (オプション)