Prune Branch History (Data Management Tools)
Summary
Removes retired archive records from branch-versioned datasets.
Usage
When no Prune Before Date parameter value is provided, the tool will prune as much of the archive history as possible based on referenced moments. When a Prune Before Date parameter value is provided, all rows will be removed up to that moment.
If the Prune Before Date parameter value is invalid due to a version or replica that is referencing a moment before the requested prune date, a warning message will be issued. The output log will report the earliest moment that can be used and will include the moment and version that blocked the tool.
The versioning type of the Input Dataset parameter value's geodatabase connection must be set to branch.
The Input Dataset value must be a table, feature class, or feature dataset that is registered as branch versioned. It cannot participate in any controller datasets, except a topology, parcel fabric, or utility network.
Note:
While using this tool, if you receive an error message indicating that an upgrade is necessary, upgrade your geodatabase to the latest version. See this knowledge article for more details.
The tool can only be run by the data owner.
When the Input Dataset value is a feature dataset, all feature classes in that dataset and related data outside of the feature dataset will be processed, excluding data in another feature dataset.
If a feature class is in a feature dataset, use the feature dataset as the input.
Important:
Running the Prune Branch History tool removes eligible historical records from input datasets in your geodatabase. Depending on the number of rows deleted, your database administrator may need to perform database management tasks to ensure optimal query performance and reclaim unused disk space. Consult the documentation for your specific DBMS to determine the specific database management steps to perform following a large delete operation. Some examples include updating statistics, rebuilding indexes, and running space reclamation and cleanup procedures.
Parameters
| Label | Explanation | Data type |
|---|---|---|
|
Input Dataset |
The feature class, feature dataset, or table that will be pruned. |
Table View; Feature Dataset |
|
Output Log File |
A log file that reports the feature classes and tables that were pruned or will be pruned. The output file will also list the replicas and versions that prevented using the requested prune before date. |
File |
|
Report Only (Optional) |
Specifies whether the eligible archive records will be reported or pruned.
|
Boolean |
|
Only Prune System Tables (Optional) |
Specifies whether only the eligible internal tables will be reported or pruned.
|
Boolean |
|
Prune Before Date (Optional) |
Archive records that are older than the date and time provided will be pruned. The date and time must be in UTC. If no date is provided, the oldest referenced moment in the database will be used. |
Date |
|
Auto Commit Interval (Optional) |
The number of rows that will be processed before a commit occurs. When left empty, the default auto-commit interval of 1,073,741,824 rows is used. A value greater than 0 overrides the default and commits after the specified number of rows are processed. Smaller values may reduce resource usage but increase processing time. |
Long |
Derived output
| Label | Explanation | Data type |
|---|---|---|
|
Output Dataset |
The updated dataset. |
Table View; Feature Dataset |
Environments
This tool does not use any geoprocessing environments.
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes