Question
Morgan Stanley
IN
Last activity: 13 Jun 2016 1:19 EDT
Documentation for API of PegaDatabase class
Where do i find the API documentation for the class PegaDatabase..
I did not find any information related to PegaDatabase in the Engine API link in resources menu.
Its used in the 15th step of the activity UsageCleaner.
I'm interested to find out the purpose of the below API in the step:
((PegaDatabase)tools.getDatabase()).purgeTableContainingClass("Log-RuleUsage-Details", "pxUpdateDateTime", paramPage.getString("RententionDays"));
Accepted Solution
Pegasystems Inc.
US
Correct - anything with a Pega prefix, PegaAPI, PegaDatabase, PegaRequestor etc., is meant for internal (Pega platform) consumption only - and subject to change without notice. These APIs should not be used by strategic apps or customers. The lack of documentation is largely intentional.
Pegasystems Inc.
US
/**
* Wrapper for the SQLGenerator purgeTableContainingClass function
*
* @param aClassName The Class of table to purge
* @param aColumn The column to filter date by
* @param aDays Delete all rows older than this many days
* @throws DatabaseException
* @throws SQLException
*/
Morgan Stanley
IN
Thanks Kevin.. I would like to see the entire API documentation as present for rest of the classes in Engine API.
Any idea on why there is no API documentation about this class in Engine API. Was it intentionally skipped to avoid PegaDatabase from being used by teams other than Engine team.
Pegasystems Inc.
US
tagging Suprakash Das, what is the process of engine API document generation? Can you weigh in on the question from Avinash?
Accepted Solution
Pegasystems Inc.
US
Correct - anything with a Pega prefix, PegaAPI, PegaDatabase, PegaRequestor etc., is meant for internal (Pega platform) consumption only - and subject to change without notice. These APIs should not be used by strategic apps or customers. The lack of documentation is largely intentional.
Morgan Stanley
IN
My requirement is to just pruge entire database table which has an associated class.
Would you suggest me to use purgeTableContainingClass method or write my own custom Connect SQL rule..
Your suggestions?
Thank you
Avinash
Morgan Stanley
IN
Thanks Kevin.
I had come across the below function which tells if the database is postgres or not:
Function: pzIsPostgreSQLDB --> Code: ((PegaDatabase)tools.getDatabase()).isSchemaOperationAllowed("PegaRULES");
Can you please let me know what does isSchemaOperationAllowed mean in PegaDatabase class?