Documentation

データベースアップグレードツールの使用

Liferayデータベースアップグレードツールは、Liferay DXPデータベースおよびLiferay Portalデータベースをオフラインでアップグレードするためのクライアントプログラムです。

重要

アップグレードする前に、必ずデータとインストールをバックアップしてください。 バックアップコピーでアップグレードプロセスをテストすることをお勧めします。

重要

6.2以前からアップグレードする場合は、ファイルストアの構成を更新します。 詳細は、Updating the File Storeを参照してください。

Liferayインスタンスから切り離された状態でデータベースを変更すると、データベースをアップグレード操作用に調整し、不要なデータ(Webコンテンツ、ドキュメントなどの不要なバージョンなど)を削除して、アップグレードのパフォーマンスを向上させ、アップグレードの問題を解決できます。 これらのアクティビティは、DXPをはじめとする大規模で重要なポータルCE環境を安全かつ迅速にアップグレードするために特に重要です。 データベースの調整と削除を考慮し、 アップグレードの基本 で説明されている関連タスクを完了すると、新しいインストールをセットアップし、アップグレードツールを使用してデータベースをアップグレードする準備が整います。

新しいLiferay Dockerイメージにアップグレードしていて、アップグレードツールを使用する場合は、新しいLiferayバージョンのLiferay Tomcat Bundleからそのツールを使用します。 このツールは、バンドルのtools/portal-tools-db-upgrade-clientフォルダにあります。

新しいLiferayリリースをアプリケーションサーバーにインストールした場合は、[Liferay Home]/tools/portal-tools-db-upgrade-clientフォルダを作成し、アップグレードツールをダウンロードして、ツールを新しいフォルダにインストールします。

編集

ダウンロード手順

Liferay DXP(サブスクリプション)

ダウンロード ページ に移動し、DXPバージョンと 製品/サービスパック のファイルタイプを選択します。 表示されるリストで、 Liferay DXPアップグレードクライアント 用の [Download] をクリックします。

Liferay Portal

Downloads] ページ に移動します。 [Liferay Portal] ダウンロードメニューで、 [Other files] を選択して、 [ダウンロード] をクリックします。 最新のLiferay PortalのリリースアセットのGitHubページが表示されます。 liferay-ce-portal-tools-[version].zipをクリックします。

新規インストール時の設定

  1. 新しいLiferayインストールの[Liferay Home]/dataフォルダをバックアップ[Liferay Home]/dataフォルダに置き換えます。

  2. DXPのアクティベーションキー(サブスクリプション)とOSGiの構成ファイルを、

  3. 高度なファイルシステムストアまたは簡易ファイルシステムストアを使用していて、保存場所を変更している場合は、ファイルストアの設定を .configファイル にエクスポートして、新しい[Liferay Home]/osgi/configs/フォルダにコピーします。

    重要

    高度なファイルシステムストアを使用している場合は、データベースをアップグレードする前に、新しいインストールで.configファイルを使って設定する必要があります。

    以下に例を示します。

必要なrootDirパラメーターを含むcom.liferay.portal.store.file.system.configuration.AdvancedFileSystemStoreConfiguration.configファイル:

`rootDir="data/document_library"`
```
  1. データベースベンダーが推奨するJDBCデータベースドライバーを使用していることを確認してください。 たとえば、MySQLを使用している場合は、portal-ext.propertiesjdbc.default.driverClassName=com.mysql.cj.jdbc.Driverを設定し、アプリケーションサーバーが使用するMySQL JDBCドライバーのJARを置き換えます。 詳細は、 データベースドライバー を参照してください。

    新しいLiferay Dockerイメージにアップグレードする場合は、Docker環境変数の代わりにポータルプロパティを使用してデータベース接続を指定してください。 ポータルプロパティのリファレンス には、対応するポータルプロパティが各Liferay環境変数とともに一覧表示されています。

    注釈

    新しいLiferay Dockerイメージにアップグレードする場合は、Docker環境変数の代わりに ポータルプロパティ ファイルを使用してデータベース接続を指定してください。 ポータルプロパティリファレンス には、各Liferay環境変数に対応するポータルプロパティが一覧表示されています。

DXP版

ダウンロード手順

Liferay DXP(サブスクリプション)

ダウンロード ページ に移動し、DXPバージョンと 製品/サービスパック のファイルタイプを選択します。 表示されるリストで、 Liferay DXPアップグレードクライアント 用の [Download] をクリックします。

LiferayポータルCE

[Downloads] ページ に移動します。 [Liferay Portal] ダウンロードメニューで、 [Other files] を選択して、 [ダウンロード] をクリックします。 最新のLiferay PortalのリリースアセットのGitHubページが表示されます。 liferay-ce-portal-tools-[version].zipをクリックします。

アップグレードツールの実行

アップグレードツールの設定は、コマンドラインインターフェイスで行うか、 プロパティファイル を使って行います。

[Liferay Home]/tools/portal-tools-db-upgrade-clientフォルダにあるdb_upgrade.shスクリプトは、アップグレードツールを呼び出します。 --helpオプションは、ツールの使用状況を説明します。

./db_upgrade.sh --help

ここでは、アップグレードツールを使ってデータベースをアップグレードする方法を説明しています。

  1. アップグレードツールを起動します。 次にコマンドの例を示します。

    cd liferay-home/tools/portal-tools-db-upgrade-client
    

    アップグレードプロパティファイル を作成していない場合、アップグレードツールによって構成値の入力が求められ、括弧内にデフォルト値が表示されます。 次に対話の例を示します。

    ./db_upgrade.sh -j "-Dfile.encoding=UTF-8 -Duser.timezone=GMT -Xmx4096m"
    

    上記のコマンドは、アプリケーションサーバーで推奨されているのと同じJVMオプションでアップグレードツールを実行します。 File encoding (UTF-8), time zone (GMT), country, language, and memory settings (-Xmx value) should all match your application server's settings. For databases with over 10 GB of data, allocate additional memory using the -Xmx option.

    If you haven't configured the upgrade using the upgrade properties files , the upgrade tool prompts you for configuration values and shows default values in parentheses. 次に対話の例を示します。

    Please enter your application server (tomcat):
    tomcat
    
    Please enter your application server directory (../../tomcat-9.0.17):
    
    Please enter your extra library directories (../../tomcat-9.0.17/bin):
    
    Please enter your global library directory (../../tomcat-9.0.17/lib):
    
    Please enter your portal directory (../../tomcat-9.0.17/webapps/ROOT):
    
    [ db2 mariadb mysql oracle postgresql sqlserver sybase ]
    Please enter your database (mysql):
    mariadb
    
    Please enter your database host (localhost):
    
    (etc.)
    

    プロンプトに表示されるデフォルト値を使用する場合は、Enterキーを押します。

    After configuration completes, the upgrade starts. The tool logs each upgrade process start and completion.

  2. アップグレードが完了したら、データベースのアップグレードの失敗、エラー、または警告がないか、アップグレードレポートを確認してください。 Gogo Shellコマンドを使用して、それらの問題をトラブルシューティングし、アップグレードを完了できます。

データベースのアップグレードが完了し、問題が解決されました。

アップグレードされたデータベースのテスト

データベースのアップグレードが完了したので、テストしてみましょう。

  1. 新しいLiferay Dockerイメージにアップグレードしている場合は、イメージをアップグレードされたデータベースに指定し、Liferayをデータベースで検証します。 詳しくは、Configuring Liferay Containersを参照してください。

  2. アップグレード後の検討事項を調べます。

  3. カスタム Liferay Homeのファイルアプリケーションサーバーのファイル をバックアップから新規インストールにコピーしてマージします。 ファイルには次のものが含まれる場合がありますが、これらに限定されません。

    • /license/*:アクティベーションキー。 (サブスクリプション)

    • /log/*:ログファイル。

    • /osgi/configs/*.config:OSGi設定ファイル。

    • portal-*.propertiesportal-ext.propertiesのようなポータルプロパティファイル。

    • アプリケーションサーバーファイル:変更されたスクリプトと設定ファイル。

    • web.xml:ポータルWebアプリケーション記述子。

  4. 新しいインストール先で ポータルプロパティを更新 します。

  5. サーバーを起動し、アップグレードしたデータベースでLiferayを検証します。

    これがLiferay DXPのランディング画面です。

データベースアップグレードツールを使用してLiferayデータベースをアップグレードしました。

これが試用版のアップグレードで、アップグレード時間を短縮したい場合は、データベースをアップグレード用に調整し(まだ行っていない場合)、データベースから不要なデータを削除してください。 必要に応じてこの記事の手順を繰り返してください。

次のステップ

アップグレードの基本 を再確認して、アップグレードに必要な残りの作業について確認してください。