Consolidate Layer (Data Management)

Summary

Consolidates one or more layers by copying all data and referenced data sources into a single folder.

Illustration

Consolidate Layer illustration
The format and structure of a consolidated folder. In this example, three layers with varying data sources were consolidated into a single folder.

Usage

Syntax

ConsolidateLayer_management (in_layer, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only})
ParameterExplanationData Type
in_layer
[in_layer,...]

The input layer(s) that will be consolidated.

Layer
output_folder

The output folder that will contain the layer files and consolidated data.

Folder
convert_data
(Optional)

Specifies whether input layers will be converted into file geodatabase or preserve their original format.

  • CONVERT Data will be copied to a file geodatabase.
  • PRESERVE Data formats will be preserved. This is the default.
Boolean
convert_arcsde_data
(Optional)

Specifies whether input layers will be converted into file geodatabase or preserve their original format.

  • CONVERT_ARCSDE ArcSDE data will be copied to a file geodatabase. This is the default.
  • PRESERVE_ARCSDE ArcSDE data will be preserved and will be referenced in the resulting consolidated folder or package.
Boolean
extent
(Optional)

Specify the extent by manually entering the coordinates in the extent parameter using the format X-Min Y-Min X-Max Y-Max. Additionally, to use the extent of a specific layer, simply add the layer name for the extent parameter.

  • MAXOFUnion of inputs
  • MINOFIntersection of inputs
  • DISPLAYSame as Display
  • <Layer>Same as Layer...
Extent
apply_extent_to_arcsde
(Optional)

Specifies the extent that will be used to select ArcSDE data sources.

  • ALL Specified extent is applied to all layers. This is the default.
  • ARCSDE_ONLYSpecified extent is applied to ArcSDE layers only.
Boolean
schema_only
(Optional)

Specifies whether the schema of the input layers will be consolidated or packaged.

  • ALL All features and records will be consolidated or packaged. This is the default.
  • SCHEMA_ONLY Only the Schema of input layers will be consolidated pr packaged.
Boolean

Code Sample

ConsolidateLayer Example (Python Window)

The following Python window script demonstrates how to use the ConsolidateLayer tool in immediate mode.

import arcpy
arcpy.env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers" 
arcpy.ConsolidateLayer_management('Parcels.lyr', 'Consolidate_folder', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL","ALL")
ConsolidateLayer Example 1 (stand-alone Python script)

Finds and creates individual consolidated folders for all of the layer files that reside in a specified folder.

# Name: ConsolidateLayerEx1.py
# Description:  Find all the layer files that reside in a specified folder and create a consolidated folder for each layer file.
# Author: ESRI

# import system modules
import os 
import arcpy

from arcpy import env

# Set environment settings
env.overwriteOutput = True
env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers" 

# Loop through the workspace, find all the layer files (.lyr) and create a consolidated folder for each 
# layer file found using the same name as the original layer file.
for lyr in arcpy.ListFiles("*.lyr"):
    print "Consolidating " +  lyr
    arcpy.ConsolidateLayer_management(lyr, os.path.splitext(lyr)[0], "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL")
ConsolidateLayer Example 2 (stand-alone Python script)

Finds and creates a single consolidated folder for all of the layer files that reside in a specified workspace.

# Name: ConsolidateLayerEx2.py
# Description:  Find all the layer files that reside in a specified folder and create a single 
# consolidated folder that will contain all layers found.
# Author: ESRI

# import system modules
import os
import arcpy

from arcpy import env

# Set environment settings
env.overwriteOutput = True
env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers" 

# Find all the layer files (.lyr) in a workspace and create a single consolidated folder
lyrs = arcpy.ListFiles("*.lyr")
arcpy.ConsolidateLayer_management(lyrs, 'all_layers',"PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL")

Environments

Related Topics

Licensing Information

ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes

10/27/2014