pruneChangeHistory

Back to index

Summary

Prunes obsolete-for-days data from the Change History tables.

daysToKeep

Integerrequired

Number of days' of change history data to keep (minimum seven).

batchedDelete

Booleanoptional

Allows to split records deletion queries by chunks to minimize usage of transaction undo log.

forcePruneAll

Booleanoptional

Override the supplied value of daysToKeep and prune the entire change history, keeping nothing discardable (normally not a good idea -- this is mostly intended for testing).

pruneUpgradeObsolete

Booleanoptional

Ignore the supplied value of daysToKeep and instead prune all change data that is obsolete in this version of CloudBees CD/RO. If you make extensive use of Stage entities, and have change history dating from to releases before CloudBees CD/RO 9.0, then running this once after the upgrade to 9.0 should reclaim some database space and might improve change history performance.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.pruneChangeHistory(
  daysToKeep: "test-daysToKeep"
  /* optional arguments */
)▼