Skip To Content

Consolidate Layer

Summary

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

Usage

  • A warning is issued when this tool encounters an unsupported layer type. The unsupported layer will not be written to the output.

  • When Convert data to file geodatabase is checked (convert_data='CONVERT' in Python), the following occurs:

    • Each unique data source will have a file geodatabase created in the consolidated folder or package.
    • Compressed raster and vector formats will be converted to a file geodatabase, and compression will be lost.
    • Enterprise geodatabase data will not be consolidated. To have enterprise geodatabase data converted to a file geodatabase, check Include Enterprise geodatabase data instead of referencing the data.

  • When Convert data to file geodatabase is not checked (convert_data='PRESERVE' in Python), the following occurs:

    • The data source format of the input layers will be preserved when possible.
    • ADRG, CADRG/ECRG, CIB, and RPF raster formats will always convert to file geodatabase rasters. ArcGIS cannot natively write out these formats. They will always be converted to file geodatabase rasters for efficiency.
    • In the output folder structure, file geodatabases will be consolidated into a version-specific folder, and all other formats will be consolidated into the commonData folder.
    • Compressed raster and vector formats will not be clipped, even if an extent is specified in the Extent parameter.

  • For layers that contain a join or participate in a relationship class, all joined or related data sources will be consolidated into the output folder.

  • For feature layers, the Extent parameter is used to select the features that will be consolidated. For raster layers, the Extent parameter is used to clip the raster datasets.

  • Some datasets reference other datasets. For example, you may have a topology dataset that references four feature classes. Other examples of datasets that reference other datasets include Geometric Networks, Networks, and Locators. When consolidating or packaging a layer based on these types of datasets, the participating datasets will also be consolidated or packaged.

  • The Schema only parameter, if checked, (schema_only='SCHEMA_ONLY' in Python) will only consolidate or package the schema of the input data sources. A schema is the structure or design of a feature class or table that consists of field and table definitions, coordinate system properties, symbology, definition queries, and so on. Data or records will not be consolidated or packaged.

  • Data sources that do not support schema only will not be consolidated or packaged. If the Schema only parameter is checked and the tool encounters a layer that is not supported for schema only, a warning message is displayed, and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will fail.

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.
    Note:

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

  • PRESERVEData formats will be preserved when possible. This is the default.
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)

Specifies 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')
ConsolidateLayer example 2 (stand-alone script)

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

# import system modules
import os 
import arcpy

# Set environment settings
arcpy.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 {}'.format(lyr))
    arcpy.ConsolidateLayer_management(lyr, os.path.splitext(lyr)[0], 'PRESERVE', 'CONVERT_ARCSDE')

Licensing information

  • ArcGIS Desktop Basic: Yes
  • ArcGIS Desktop Standard: Yes
  • ArcGIS Desktop Advanced: Yes

Related topics