Skip to main content

Pega Platform database tools

Suggest edit Updated on May 4, 2022

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. The functionality of these tools helps you manage your internal database to provide the same experience as on an on-premises system.

To access these tools, you must have the PegaRULES:DatabaseAdministrator role in your access group.

The following table describes the functionality each of these tools provides:

Query Runner, Query Inspector, and Schema Tools

Query RunnerOffers 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 InspectorImproves 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 ToolsExtends 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 your Pega Platform database in Pega Cloud

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 following 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.

Database management functionality

Pega 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. 

You, as a Pega Cloud client, can use the following articles to understand how to perform standard database operations tasks:

Database taskArticle
Add a database column
Increase database column length
Alter a column type
Create a database table
Insert records into the database
Update records on the database
Deleting records from the database
Optimizing the database schema

SQL query management

You can use Query Runner and Query Inspector to manage your SQL queries with your internal database. Query Runner and Query Inspector offer 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 following corresponding articles for each database task:

SQL tasks for managing your internal database

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

Schema tools for table viewing and interaction

You can use Schema Tools to view and interact with the tables in your internal database. Schema Tools offers Pega Cloud-only functionality to help you.

To learn how to view and interact with database schemas, see the following corresponding articles for each database task.

Schema Tools for viewing and interacting with your internal database tables

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 the history of Schema Tools actions

Database retry dynamic system settings

You, as a Pega Cloud client, 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.

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 database.

To edit the number of retry attempts Pega Platform makes to each schema for the internal Pega 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 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.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

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