Enable Archiving (Data Management Tools)

Summary

Enables archiving on a table, feature class, or feature dataset.

Learn more about the process of enabling archiving

Usage

Enabling archiving provides the functionality to record and access changes made to a dataset over time.
Archiving is only supported on enterprise and mobile geodatabases. File geodatabases do not support archiving.
The input dataset must be from a database connection established as the data owner.
Archiving can be enabled on traditional versioned datasets in an enterprise geodatabase or on nonversioned datasets in an enterprise geodatabase or mobile geodatabase. Branch versioned datasets have archiving enabled automatically during the register a dataset as branch versioned process.

Label	Explanation	Data type
Input Dataset	The name of the dataset on which archiving will be enabled.	Table; Feature Class; Feature Dataset

Derived output

Label	Explanation	Data type
Updated Dataset	The updated input dataset.	Table; Feature Class; Feature Dataset

arcpy.management.EnableArchiving(in_dataset)

Name	Explanation	Data type
in_dataset	The name of the dataset on which archiving will be enabled.	Table; Feature Class; Feature Dataset

Derived output

Name	Explanation	Data type
out_dataset	The updated input dataset.	Table; Feature Class; Feature Dataset

Code sample

EnableArchiving example 1 (Python window)

The following code snippet illustrates how to use the EnableArchiving function in the Python window.

import arcpy
arcpy.management.EnableArchiving("Database Connections//toolbox.county.parcels")

EnableArchiving example 2 (stand-alone script)

The following script illustrates how to use the EnableArchiving function in a stand-alone script.

# Name: EnableArchiving_Example.py
# Description: Enable archiving on a dataset

# Import system modules
import arcpy

# Set local variables
in_dataset = 'C:/Data/connections/Redlands.sde/TEST.TOOLBOX.rdlsstreets'

# Describe the properties of the dataset to see if archiving is enabled.
desc = arcpy.Describe(in_dataset)
isArch = desc.isArchived

# Enable Archiving if it is not already enabled.
if isArch == False:
    # Run EnableArchiving
    arcpy.management.EnableArchiving(in_dataset)
    print("{0} has been enabled for archiving.".format(in_dataset))
elif isArch == True:
    # If IsArch = True, then archiving is already enabled
    print("{0} already has archiving enabled.".format(in_dataset))

Environments

Current Workspace

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Enable Archiving (Data Management Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics