Unregister As Versioned (Data Management)

Summary

Unregisters an enterprise geodatabase dataset as versioned.

Usage

  • The input dataset must be from a database connection established as the data owner.

  • Versioning tools only work with datasets in an enterprise geodatabases. File geodatabases do not support versioning.

  • An exclusive lock is required on the dataset.

  • Unregistering a branch versioned dataset without first posting all named versions to the default version may result in a loss of edits.

  • Unregistering a traditional versioned dataset without first compressing the geodatabase may lead to loss of edited data.

Parameters

LabelExplanationData Type
Input Dataset

The name of the dataset to be unregistered as versioned.

Table View; Feature Dataset
Do not run if there are versions with edits
(Optional)

Specifies whether edits made to the versioned data will be maintained.

  • Checked—If there are existing edits in the delta tables, the tool will fail with an error message. Do not use this option if you intend to compress your edits from the Default version in the Compress all edits in the Default version into the base table parameter. This is the default.
  • Unchecked—If there are existing edits in the delta tables, the tool will allow deletion of these edits. Use this option if you intend to compress your edits from the Default version in the Compress all edits in the Default version into the base table parameter.
Boolean
Compress all edits in the Default version into the base table
(Optional)

Specifies whether edits will be compressed and unused data will be removed. This option is ignored if the Do not run if there are versions with edits parameter is checked.

  • Checked—Edits in the Default version will be compressed to the base table.
  • Unchecked—Any edits remaining in the delta tables will not be compressed. This is the default.

Boolean

Derived Output

LabelExplanationData Type
Unregistered Dataset

The unregistered dataset.

Table View; Feature Dataset

arcpy.management.UnregisterAsVersioned(in_dataset, {keep_edit}, {compress_default})
NameExplanationData Type
in_dataset

The name of the dataset to be unregistered as versioned.

Table View; Feature Dataset
keep_edit
(Optional)

Specifies whether edits made to the versioned data will be maintained.

  • KEEP_EDITIf there are existing edits in the delta tables, the tool will fail with an error message. Do not use this option if you intend to compress your edits from the Default version in the compress_default parameter. This is the default.
  • NO_KEEP_EDITIf there are existing edits in the delta tables, the tool will allow deletion of these edits. Use this option if you do intend to compress your edits from the Default version in the compress_default parameter.
Boolean
compress_default
(Optional)

Specifies whether edits will be compressed and unused data will be removed. This option is ignored if the KEEP_EDIT option is used in the keep_edit parameter. This option is only applicable for traditional versioned datasets.

  • COMPRESS_DEFAULTEdits in the Default version will be compressed to the base table.
  • NO_COMPRESS_DEFAULTAny edits remaining in the delta tables will not be compressed. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_dataset

The unregistered dataset.

Table View; Feature Dataset

Code sample

UnregisterAsVersioned example (stand-alone script)

The following stand-alone script demonstrates how to use the UnregisterAsVersioned tool to unregister a dataset as versioned.

# Name: UnregisterAsVersioned_Example.py
# Description: Unregisters a dataset as versioned
# Author: ESRI

# Import system modules
import arcpy

# Set local variables
datasetName = "c:/whistler@prod.sde/prod.GDB.ctgFuseFeature"

# Execute UnregisterAsVersioned
arcpy.UnregisterAsVersioned_management(datasetName,
                                       "NO_KEEP_EDIT",
                                       "COMPRESS_DEFAULT")

Environments

Licensing information

  • Basic: No
  • Standard: Yes
  • Advanced: Yes

Related topics