Documentation

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

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

重要

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

重要

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

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

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

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

編集

ダウンロード手順

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

Downloads] ページ に移動し、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の構成ファイルを、 バックアップ から新しいインストールにコピーします。

1 7.2にアップグレードする場合は、新しいインストールの[Liferay Home]/files/osgi/configs/フォルダにある構成ファイルを使用して検索インデックスを無効にします。 例:

```bash
cd liferay-home
```

```bash
mkdir -p osgi/configs
```

```bash
echo "indexReadOnly=\"true\"" >> osgi/configs/com.liferay.portal.search.configuration.IndexStatusManagerConfiguration.config
```

```{note}
DXP/Portal 7.3以降は、検索インデックスが自動的に無効/再有効化されます。
```
  1. コマース を使用している場合は、コマースをアップグレードする準備をしてください。 詳細については、 Liferay Commerceのアップグレード を参照してください。

  2. Liferayデータベースのアップグレードと一緒にマーケットプレイスアプリのデータをアップグレードする場合は、新しいLiferayバージョンの対象となる各アプリの最新バージョンをダウンロードして、[Liferay Home]/deployフォルダにコピーします。 それ以外の場合は、 アップグレード後の考慮事項 で説明されているように、データベースのアップグレード後にアプリをインストールし、データをアップグレードできます。

  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.propertiesファイルでjdbc.default.driverClassName=com.mysql.cj.jdbc.Driverを設定し、アプリケーションサーバーが使用するMySQL JDBCドライバーのJARを置き換えます。 詳細は、 Database Drivers を参照してください。

    アップグレードツールのプロンプトに応答するか、 アップグレードプロパティファイルを使用 して、アップグレードを構成できます。

    注釈

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

  2. 必要に応じて、アップグレードレポートを有効にして、環境や変更などをレポートに記録します。

    echo "upgrade.report.enabled=\"true\"" << tools/portal-tools-db-upgrade-client/portal-upgrade-ext.properties
    

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

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

[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オプションでアップグレードツールを実行します。 ファイルのエンコーディング(UTF-8)、タイムゾーン(GMT)、国、言語、メモリ設定(-Xmx値)は、すべてアプリケーションサーバーの設定と一致させる必要があります。10GB 以上のデータを持つデータベースの場合、-Xmx オプションを使用して追加のメモリを割り当てます。

    ファイルのエンコーディング(UTF-8)、タイムゾーン(GMT)、国、言語、メモリ設定(-Xmx値)は、すべてアプリケーションサーバーの設定と一致させる必要があります。10GB 以上のデータを持つデータベースの場合、-Xmxオプションを使用して追加のメモリを割り当てます。 アップグレードのプロパティファイル を使ってアップグレードの設定をしていない場合、アップグレードツールは設定値の入力を促し、デフォルト値を括弧で囲んで表示します。

    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キーを押します。

    設定が完了すると、アップグレードが開始されます。このツールは、アップグレード処理の開始と完了をそれぞれ記録します。

  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データベースをアップグレードしました。

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

問題が発生した場合は、アップグレードレポートを確認し、 アップグレードのトラブルシューティング を参照してください。

次のステップ

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