Consolidate Layer (Data Management)

License Level:BasicStandardAdvanced

Summary

Consolidates one or more layers by copying all referenced data sources 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 layers to 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 a file geodatabase or preserve their original format.

  • CONVERT Data will be converted to a file geodatabase.
    NoteNote:

    This parameter does not apply to enterprise geodatabase data sources. To convert enterprise geodatabase data, set convert_arcsde_data to CONVERT_ARCSDE.

  • PRESERVEData formats will be preserved when possible. This is the default.
    NoteNote:

    The exception to this rule are formats that are not supported in a 64x environment (personal geodatabase (.mdb) data, VPF data, and tables based on Excel spreadsheets or OLEDB connections) and raster formats that ArcGIS cannot write out natively (ADRG, CADRG/ECRG, CIB, and RPF).

Boolean
convert_arcsde_data
(Optional)

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

  • CONVERT_ARCSDE Enterprise geodatabase data will be converted to a file geodatabase and included in the consolidated folder or package. This is the default.
  • PRESERVE_ARCSDE Enterprise geodatabase data will be preserved and will be referenced in the 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. To use the extent of a specific layer, specify the layer name.

  • MAXOFUnion of inputs
  • MINOFIntersection of inputs
  • DISPLAYSame extent as current display
  • <Layer>Same extent as specified layer
Extent
apply_extent_to_arcsde
(Optional)

Determines whether specified extent will be applied to all layers or only to enterprise geodatabase layers.

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

Specifies whether only 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 or packaged.
Boolean

Code Sample

ConsolidateLayer example 1 (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', 'Consolidated_folder', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL","ALL")
ConsolidateLayer example 2 (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.

# 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 3 (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.

# 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

ArcGIS for Desktop Basic: Yes
ArcGIS for Desktop Standard: Yes
ArcGIS for Desktop Advanced: Yes
11/18/2013