From 2019.1 or later to latest (single server)

These instructions assume you have a single server. If not, see From 2019.1 or later to latest (multi-server environment).

Prerequisites

  • To upgrade Helix Core Server to a newer version, your Helix Server license file must be current.
  • We strongly recommend that you take a checkpoint so that you know you can recover if something goes wrong during the upgrade. (See Checkpoint files.) It is best to take the checkpoint at a time when the end-users are not active.

  • Make sure that journaling is enabled. To learn more, see Journal files.

  • Read the information at Upgrade overview.

Upgrade for proxy, broker, and offline database

A proxy or broker only needs to get the latest binary.

You do not need to run p4d -xu against offline db.* files. An offline database is a set of db.* files periodically made current by replaying the journal files from the production server.

Upgrade steps for P4D and its database

Upgrading the server requires you to upgrade the p4d binary, and then upgrade the p4d database that the binary reads from and writes to.

Upgrade the p4d binary

  1. (Recommended) Verify files before and after a server upgrade.

  2. Shut down the server by running
    p4 admin stop

  3. Install the new version of the p4d binary, which you can obtain from Download Helix Core (P4D) Server.
    1. For Linux and macOS, make a copy of the existing p4d binary, and overwrite the existing p4d binary with the new one. Then proceed to "Upgrade the p4d database".

    2. For Windows, the installer:

      • Detects that an installation exists and proceeds as "Upgrading the Helix Core Server Installation".

      • Concludes with a message that "Helix Core Server failed to start. ..." This is to be expected. Proceed to "Upgrade the p4d database".
Upgrade the p4d database
  1. As the OS account owner of the Helix Core Server, run
    p4d -r P4ROOT -J P4JOURNAL -xu
    replacing
    P4ROOT with the path to the P4ROOT directory
    P4JOURNAL with the directory path and name of the journal file as specified at P4JOURNAL.
  2. Wait until you see this message:

    Upgrades will be applied at server startup.

  3. Start the server. This upgrades the database level to be compatible with the server version. For the list of database levels by server version, see the database schema Upgrades.
  4. (Recommended) Verify files before and after a server upgrade.

  5. Inform users of this server that they can resume working.