DBアップグレードクライアントは、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アップグレードクライアントは、アップグレード後に自動的にGogoシェルに接続します。 これにより、モジュールのアップグレードの状態を確認することができます。
注意: com.liferay.portal.upgrade.internal.configuration.ReleaseManagerConfiguration.cfg というファイルを osgi/configs/ フォルダに以下の内容で追加することで、コアのみをアップグレードし、外部モジュールはアップグレードしないように設定することができます。 autoUpgrade=false..
コマンドライン実行、Gogoシェルコマンド、設定のオプションは以下で参照できます。
コマンドラインオプション
-
--jvm-optsまたは-j- アップグレードプロセスのJVMオプションを設定します。 -
--log-fileまたは-l- ログファイルのカスタム名を使用します。 -
-shellまたは-s- アップグレード中に Gogo シェルに接続する
ゴーゴーシェルのコマンドオプション
-
exitまたはquit- 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- 登録されているすべての検証者をリストアップします。
設定オプション
アプリサーバー.プロパティ
-
dir- アプリケーションサーバのディレクトリ (required) -
extra.lib.dirs- クラスパスに追加したい追加ディレクトリのカンマ区切りリスト (required) -
global.lib.dir- アプリケーションサーバのグローバルlibディレクトリ (必須) -
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 に設定されます (オプション)