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 consolidating or packaging layers, the resulting layers will be renamed using the convention <integer><layername>.lyr (for example, 0000roads.lyr). This renaming is needed to ensure all layers that reference unique data sources, and have the same layer name within ArcMap, have unique layer names in the consolidated folder.
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 convert enterprise geodatabase data 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. The exceptions are formats such as personal geodatabase data (.mdb), VPF data, and tables based on Excel spreadsheets or OLEDB connections. These formats are not supported in 64x environments and will always be converted to a file geodatabase.
- 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 in a version-specific folder, and all other formats will be consolidated in 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. By default, joined or related data sources will be consolidated in their entirety or, depending on the Select Related Rows parameter, based on the extent specified using the Extent parameter.
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 appears and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will fail.
Consolidating or packaging Coverage or VPF layers will copy the entire Coverage or VPF dataset into the consolidated folder or package.
Syntax
arcpy.management.ConsolidateLayer(in_layer, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only})| Parameter | Explanation | Data 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 to a file geodatabase or preserved in their original format.
| Boolean |
convert_arcsde_data (Optional) | Specifies whether input enterprise geodatabase layers will be converted to a file geodatabase or preserved in their original format.
| 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.
| Extent |
apply_extent_to_arcsde (Optional) | Specifies whether the specified extent will be applied to all layers or only to enterprise geodatabase layers.
| Boolean |
schema_only (Optional) | Specifies whether only the schema of the 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')
Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes