モジュールアップグレード用のGogoシェルコマンド

LiferayのGogoシェルコマンドを使用すると、個々のモジュールをアップグレードして検証できます。 これにより、コアモジュールとコア以外のコアモジュールのアップグレードを詳細まで調整することができます。以下が、コマンドでできることです。

まず最初に、コマンドの使用法について説明します。

コマンドの使用法

アップグレードツールを実行してGogoシェルを開いた場合は、すでに接続されています。 それ以外の場合は、Gogoシェルポートレットを使用してコマンドを実行でき ます。

upgrade名前空間で利用可能なコマンドは、次のとおりです。

exitまたはquit:: Gogoシェルを終了します。

**upgrade:help:**アップグレードコマンドを表示します。

**upgrade:check:**過去にアップデートに失敗したため、あるいはモジュールが最終バージョンに達していないために、実行が保留されているアップグレードを一覧表示します。

**upgrade:execute :**対象モジュールのアップグレードを実行します。

**upgrade:executeAll:**保留中のモジュールアップグレードプロセスをすべて実行します。

**upgrade:list:**登録されているすべてのアップグレードを一覧表示します。

**upgrade:list :**モジュールに必要なアップグレード手順を一覧表示します。

**upgrade:list | grep Registered:**登録されているアップグレードとそのバージョンを一覧表示します。

**verify:help:**検証コマンドを表示します。

**verify:check :**モジュールの検証プロセスの最新の実行結果を一覧表示します。

**verify:checkAll:**すべての検証プロセスの最新の実行結果を一覧表示します。

**verify:execute :**モジュールのベリファイアを実行します。

**verify:executeAll:**全てのベリファイアを実行します。

**verify:list:**登録されているすべてのベリファイアを一覧表示します。

LiferayコマンドおよびGogoシェルで利用可能な標準コマンドには、便利なものがたくさんあります。 以下のセクションでは、Liferayのアップグレードコマンドについて説明します。

モジュールアップグレードプロセスの一覧表示

モジュールをアップグレードする前に、未解決の依存関係があるかどうか、解決されてアップロードができる状態かどうか、そしてモジュールのアップグレードプロセスを調べてください。

Gogoシェルにあるupgrade:listを実行すると、アップグレードの依存関係が満たされているモジュールが一覧表示されます。表示されたモジュールはアップグレードすることができます。

モジュールがアクティブであってもリストされていない場合は、その依存関係をアップグレードする必要があります。Gogoシェルコマンドのscr:info [upgrade_step_class_qualified_name]は、アップグレードステップクラスの満たされていない依存関係を表示します。以下は、scr:infoコマンドの例です。

scr:info com.liferay.journal.upgrade.JournalServiceUpgrade

upgrade:list [module_name]を起動すると、モジュールのアップグレードプロセスが順不同で一覧表示されます。たとえば、upgrade:list com.liferay.bookmarks.serviceを(Bookmarks Serviceモジュールに対して)実行すると、次のようになります。

Registered upgrade processes for com.liferay.bookmarks.service 1.0.0
{fromSchemaVersionString=0.0.0, toSchemaVersionString=1.0.0, upgradeStep=com.liferay.portal.spring.extender.internal.context.ModuleApplicationContextExtender$ModuleApplicationContextExtension$1@6e9691da}
{fromSchemaVersionString=0.0.1, toSchemaVersionString=1.0.0-step-3, upgradeStep=com.liferay.bookmarks.upgrade.v1_0_0.UpgradePortletId@5f41b7ee}
{fromSchemaVersionString=1.0.0-step-1, toSchemaVersionString=1.0.0, upgradeStep=com.liferay.bookmarks.upgrade.v1_0_0.UpgradePortletSettings@53929b1d}
{fromSchemaVersionString=1.0.0-step-2, toSchemaVersionString=1.0.0-step-1, upgradeStep=com.liferay.bookmarks.upgrade.v1_0_0.UpgradeLastPublishDate@3e05b7c8}
{fromSchemaVersionString=1.0.0-step-3, toSchemaVersionString=1.0.0-step-2, upgradeStep=com.liferay.bookmarks.upgrade.v1_0_0.UpgradeClassNames@6964cb47}

アプリケーションのアップグレード手順クラス名は通常、その意図が明確です。たとえば、例にあげたcom.liferay.bookmarks.upgrade.v1_0_0.UpgradePortletIdアップグレード手順クラスは、アプリのポートレットIDを更新します。他の例のアップグレード手順クラスはクラス名、LastPublishDate、およびPortletSettingsを更新します。例の0.0.0から1.0.0へのステップは、空のデータベースからモジュールをアップグレードします。

モジュールのアップグレードプロセスをよりよく調べるにあたって、リストされたアップグレード手順は頭の中で、またはテキストエディタを使って、並べ替えます。以下は、Bookmarks ServiceモジュールをLiferay Portal 6.2(モジュールのデータベースが存在する)からスキーマバージョン1.0.0にアップグレードするためのアップグレード手順の例です。

  • 0.0.1から1.0.0-step-3
  • 0.0.1-step-3から1.0.0-step-2
  • 0.0.1-step-2から1.0.0-step-1
  • 0.0.1-step-1から1.0.0

全体的なモジュールアップグレードプロセスはバージョン0.0.1から始まり、バージョン1.0.0で終わります。最初のステップは最初のバージョン(0.0.1)から始まり、ターゲットバージョンの最も高いステップ(step-3)で終わります。最後のステップは、ターゲットバージョンの最も低いステップ(step-1)から始まり、ターゲットバージョン(1.0.0)で終了します。

モジュールのアップグレードプロセスが理解できたら、安心して実行することができます。

モジュールアップグレードの実行

upgrade:execute [module_name]を実行すると、モジュールがアップグレードされます。解決しなければならないアップグレードエラーに遭遇することがあるかもしれません。その場合、再度コマンドを実行すると、最後に成功したステップからアップグレードが開始されます。

upgrade:list [module_name]を実行することで、アップグレード状況を確認できます。たとえば、upgrade:list com.liferay.iframe.webを入力すると次のように出力されます。

Registered upgrade processes for com.liferay.iframe.web 0.0.1
{fromSchemaVersionString=0.0.1, toSchemaVersionString=1.0.0, upgradeStep=com.liferay.iframe.web.upgrade.IFrameWebUpgrade$1@1537752d}

最初の行はモジュールの名前と現在のバージョンをリストしています。例のモジュールの現在のバージョンは0.0.1です。toSchemaVersionString値は、ターゲットバージョンです。

モジュールのアップグレードが成功した後で、モジュール上のupgrade:list [module_name]を実行すると、モジュールの名前とそれに続くターゲットバージョンが表示されます。

たとえば、com.liferay.iframe.webのバージョン1.0.0へのアップグレードが成功した場合、upgrade:list com.liferay.iframe.webを実行すると、モジュールのバージョンは1.0.0であることが表示されます。

Registered upgrade processes for com.liferay.iframe.web 1.0.0
{fromSchemaVersionString=0.0.1, toSchemaVersionString=1.0.0, upgradeStep=com.liferay.iframe.web.upgrade.IFrameWebUpgrade$1@1537752d}

完了していないモジュールのアップグレードの場合は、それらのステータスを確認して問題を解決できます。

アップグレードステータスの確認

まだアップグレードが必要なものと、その理由を知っておくと便利です。アップグレードが必要な場合、モジュールのアップグレードを忘れてしまったか、アップグレードが失敗した可能性があります。いずれにせよ、アップグレードステータスがどうなっているのかを知ることは重要です。

upgrade:checkコマンドは、差し迫ったアップグレードがあるモジュールをリストします。

たとえば、com.liferay.dynamic.data.mapping.serviceモジュールが1.0.0-step-2というラベルの付いたステップで失敗したとします。upgrade:checkを実行すると、以下の内容が表示されます。

Would upgrade com.liferay.dynamic.data.mapping.service from 1.0.0-step-2 to
1.0.0 and its dependent modules

モジュールはアップグレードを完了するために、他のモジュールにしばしば依存します。scr:info [upgrade_step_class_qualified_name]を実行すると、アップグレードステップクラスの依存関係が表示されます。依存関係にあるモジュールを正常にアップグレードするには、依存モジュールをアップグレードする必要があります。

モジュールを解決してアクティブ化するには、アップグレードが完了している必要があります。 Apache Felix依存性マネージャのGogoシェルコマンドのdm wtfは、未解決の依存関係を明らかにします。モジュールが特定のデータスキーマバージョン(例えば、bnd.bndLiferay-Require-SchemaVersion: 1.0.2を指定します)を必要としているのに、モジュールがそのバージョンへのアップグレードを完了していない場合に、dm wtfはスキーマバージョンが登録されていないことを表示します。

1 missing dependencies found.
-------------------------------------
The following service(s) are missing:
* com.liferay.portal.kernel.model.Release (&(release.bundle.symbolic.name=com.liferay.journal.service)(release.schema.version=1.0.2)) is not found in the service registry

このdm wtfコマンドは、ポートレットの定義、およびカスタムポートレットのschemaVersionフィールドにあるエラーを検出するのにも役立ちます。

Liferay DXPデータベースのRelease_テーブルを参照すると、モジュールのアップグレードステータスも判断できます。コアのservletContextNameフィールド値はportalです。コアのschemaVersionフィールドが新しいLiferay DXPバージョン(例えば、Liferay Portal CE GA2の場合は7.1.1)と一致し、そのverifiedフィールドが1(true)の場合、コアのアップグレードは正常に完了しています。

各モジュールには1つのRelease_テーブルレコードがあり、そのschemaVersionフィールドの値は1.0.0以上でなければなりません(Liferay Portalのバージョン6.2以前を対象とした従来のプラグインを除いて、1.0.0がLiferay DXP 7.1モジュールの初期バージョンです。)。

検証プロセスの実行

検証プロセスにより、アップグレードが正常に実行されたことを確認します。コアのプロセスがLiferay DXPのアップグレード後に自動的に実行されることを確認します。verify.*ポータルのプロパティを設定してサーバを再起動することでも実行できます。

また、一部のモジュールには検証プロセスがあります。利用可能な検証プロセスを確認するには、Gogoシェルコマンドのverify:listを入力します。検証プロセスを実行するには、verify:execute [verify_qualified_name]と入力します。

« アップグレードツールの実行アップグレード後の作業 »
この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています