Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Adding columns to your database schema

Updated on July 8, 2022

Pega supports the manual addition of columns to expose additional properties in your database schema for optimized reporting and search performance.

To manually add new columns to your database, you should be a database administrator familiar with SQL, DDL, and database schemas using a SQL client and have appropriate access to your organization's database account and password, so that you have permissions to restructure your database (SQL ALTER TABLE grant).

Before you manually add a column to a table in your application schema, consider the following:

  • Final, tested table structure changes in a development or test system must also be made to the corresponding table in a production system.
  • Exposing additional columns can affect the performance and tablespace requirements of the database, but has no functional effect on activities, the property, or other rules referencing the property.
  • If, in the Storage Stream (BLOB) column, the selected property or properties have non-blank values for at least some rows, you must extract (copy) the existing values into the new column by using the Column Populator utility. Column populator operations might require minutes or hours to complete. Perform column populator processing when rows of the affected table are not locked by other Pega Platform users (so that no add, delete, or update operations occur during this process).
  • In a multinode cluster, new database columns will visible on all of the nodes in the cluster after you save the changes to the Data-Admin-DB-Name (for example, PegaDATA) or the specific Data-Admin-DB-Table that maps the Class Definition to the database table that you manually modified. While you can make the new column visible on all nodes by restarting the entire system, saving the changes in these rules is a recommended method as it does not impact your application availability.
    Note: Pega recommends that you use the Property Optimization wizard (for details see Optimize a property from the user interface). If you use the Property optimization wizard, the Column Population Job that is scheduled will automatically notify the cluster by re-saving the impacted DB-Table.
    Caution: The Storage Stream column ( pzPVStream ) of the pr_operators table contains Operator ID passwords in an encrypted form. For maximum security of your Pega Platform system, do not alter the schema for this table to expose the password property as a column.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

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