Skip to main content

Managing your Pega Platform database in Pega Cloud

Suggest edit Updated on January 24, 2022

Pega Cloud supports certain database operations in Pega Platform, including adding and deleting database columns and running queries on its composite schemas of PegaRULES, PegaDATA, and CustomerData.

To interact with your Pega Platform database, Pega Cloud provides the follow resources:

  • Schema Tools
  • Query Runner
  • Query Inspector
  • Dynamic system settings for database retries
You can also use standard Pega Platform functions to configure database tables, for example:
  • increase column length
  • create a table
  • Insert records into a table
Additionally, you can update records in the Pega Platform database by writing Java code or using ExecuteRDB SQL run through an Activity. Pega also can help you to identify possible database optimizations that could improve system performance, minimize database size, and improve resource use.

Pega Cloud-only Query Runner, Query Inspector, and Schema Tools for the Pega Platform database

A Pega Platform instance within Pega Cloud uses an internal database. You can interact with the database through Query Runner, Query Inspector, and Schema Tools after enabling them on your instance of Pega Platform. These tools offer functionality for managing your internal database to provide the same experience as on an on-premises system. Access to these tools requires the PegaRULES:DatabaseAdministrator role in your access group.

  • Query Runner offers options to retrieve data that you pull from your Pega Platform database by using SELECT SQL statements. Query Runner is optimized to use SELECT statements only (instead of other types of SQL statements) for operators with read-only access to the database for the fastest return on your query.
  • Query Inspector improves the SELECT statements that are used through the Query Runner. SELECT statements that you enter into the Query Runner generate the steps in the query statement through an EXPLAIN PLAN output. Use the EXPLAIN PLAN to improve query efficiency.
  • Schema Tools extends a robust set of tools to administer your Pega Platform database, including viewing schema, increasing column size, adding or deleting indexes, and optimizing tables.
Managing SQL queries with Query Runner and Query Inspector

Query Runner and Query Inspector offer the following Pega Cloud-only functionality for interacting with your internal database. To learn how to manage SQL queries with Query Runner and Query Inspector, see the corresponding articles for each database task.

Database taskArticle
Run SQL queries Running SQL queries on Pega Cloud
View SQL query historyViewing previously run queries
Export SQL queriesExporting previously run query results
Analyze SQL queries with EXPLAIN PLANUsing Query Inspector to improve SQL queries
Viewing database schema and interacting with tables using Schema Tools

Schema Tools offers the following Pega Cloud-only functionality for interacting with your internal database. To learn how to view database schemas, see the corresponding articles for each database task.

Database taskArticle
View database schemaViewing database schema information
Increase column length Increasing column length
View column BLOB sizeViewing column BLOB size
Collect table statisticsUpdating statistics
Schedule BLOB size and table statistic updatesScheduling schema updates
Defragment tablesDefragmenting tables
Create and remove indexesAdding and deleting database indexes
View the history of actions taken using Schema ToolsViewing history of Schema Tools actions

Archiving, purging, and data retention in the Pega Platform database in Pega Cloud

Pega Cloud clients can archive their resolved case data to Pega Cloud File storage, then purge the data from their Pega Platform database to improve system performance. You can also set a data retention policy on data archived to Pega Cloud File storage that expunges the archived data permanently. By periodically purging entries from your database, you can improve application performance, improves search and reporting, increases performance for database queries, shortens database maintenance cycles, reduces primary database costs, and creates better compliance with government compliance policies, such as the General Data Protection Regulation (GDPR), and the Health Insurance Portability and Accountability Act (HIPAA).

For an overview for archiving and purging, see Case archiving and purging overview.

Pega Cloud offers the following functionality for archiving and purging case data from your Pega Platform database.

Archiving and purging taskArticle
Enabling archival and setting archival policies on case dataCreating an archival policy
Scheduling case archiving and purging jobsScheduling the case archival process
Configuring archive settings dynamic system settingsConfiguring archive cycle settings
Configuring purge cycle settingsConfiguring purge cycle settings
Configuring expunge cycle settingsConfiguring expunge cycle settings
Monitoring case archiving and purgingMonitoring case archiving and purge
Reviewing archived case data in Pega CloudReviewing archived case data

Pega Cloud-only dynamic system settings for database retries

Note: Pega Cloud permits changing only the parameters for database retries to the internal Pega Platform database. Pega Cloud does not permit you to edit any other parameter for the internal Pega Platform database.

Pega Cloud clients can change the number of times Pega Platform retries a connection attempt to the internal database before timing out. Changing the number of retries to the internal database can be useful during troubleshooting scenarios. To edit the number of retry attempts Pega Platform makes to each schema for the internal Pega Platform database, create, open, and change the value for the following dynamic system settings:

  • database/databases/PegaRULES/retryAttempts
  • database/databases/PegaDATA/retryAttempts

A value of 0 turns off retry attempts to the internal Pega Platform database. Pega Platform defaults to 3 retries for each schema.

For more information about creating a dynamic system setting, see Creating a dynamic system setting.

Pega Platform database management in Pega Cloud

Pega Platform gives you a range of capabilities to update your database schema, add or delete columns, insert database tables, and update records on your internal Pega Platform database. 

The following articles describe the Pega Platform tasks that are required for Pega Cloud clients to perform the listed standard database operations.

Database taskArticle
Add a database column
Delete a database column
Increase database column length
Altering a column type
Creating a database table
Inserting records into the database
Updating records on the database
Deleting records from the database
Optimizing the database schema
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us