Liferay Cloud Platform CLI Backup Management

Welcome to an enhanced backup management experience on the Liferay Cloud Platform. We've rolled out substantial updates to both the backup download and upload functionalities via our Command Line Interface (CLI) tool. Our aim is to provide a robust, efficient, and transparent suite of options for managing your backups.

The following capabilities are available on version 3.12 and beyond.

Backup Download

New and Enhanced Features

Simultaneous Downloading of Database and Document Library

You can now save valuable time by downloading both the database and document library backups in a single operation. The command to initiate this is lcp backup download --backupId {backupId}.

Optional Flags for Granular Control

If you're interested in downloading just the database backup, you can easily do this by appending the --database flag like this: lcp backup download --backupId {backupId} --database.

Improved Logging and Monitoring

We've enhanced our user activity log to provide more granular information about what's happening during the download process. This feature aids in troubleshooting and monitoring.

Updated Backup Route

We've optimized the API route for initiating backup downloads. It's designed to streamline the experience and make it more efficient.

Command Example for Download

To download both types of backups together:

lcp backup download --backupId {backupId}

To download only the database:

lcp backup download --backupId {backupId} --database

Concurrency Setting

If you're looking to optimize the download speed, you can use the --concurrency flag. This allows you to set how many download streams you want to run concurrently. Please note that this only applies to document library downloads as database backups are single-file entities.

Backup Upload

Who Can Upload Backups

Role-Based Access Control

The backup upload feature is limited to users with specific roles—namely, team members, owners, or administrators.

Project-Specific Access

Your access rights are further scoped to the projects to which you are assigned, ensuring robust security protocols.

Command Syntax and Parameters

To upload a backup, execute:

lcp backup upload --project {ProjectName} --environment {Environment} --doclib {PathToDocLibFolder} --database {PathToDatabaseFile.gz} --concurrency {NumberOfConcurrentStreams}

Parameter Guidelines

  • --database: The database backup must be in .gz format.
  • --doclib: Must point to a folder containing the document library.
  • --concurrency: Optional parameter to control parallel upload streams. The default is set to 500.

Additional Notes on Backup Upload

  • Requirement for Google Cloud Storage: The upload feature is only available if Google Cloud Storage (GCS) is enabled on your environment.

  • Concurrency for Enhanced Performance: The concurrency option allows the CLI to upload multiple files in parallel, thereby reducing the total upload time.

Important Note on UI Compatibility


With the release of our latest CLI updates, we have removed the backup upload and download options from the UI. While we understand that this change may be inconvenient for some, it's driven by our commitment to provide the most robust, efficient, and secure backup solution. The CLI is better suited to manage large data sets and offers better performance.

We Value Your Feedback: We’re keen to hear how these changes are affecting your workflow. Your experiences and feedback are crucial for our ongoing efforts to fine-tune this service. If you encounter any issues, please share them with us so that we can address them promptly.

Was this article helpful?
0 out of 1 found this helpful