Consolidate Layer (Data Management)

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 the Convert data to file geodatabase parameter is checked, 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 the Include Enterprise Geodatabase data instead of referencing the data parameter.

• When the Convert data to file geodatabase parameter is not checked, 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 convert to file geodatabase rasters. ArcGIS cannot natively write out these formats. They will 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 for 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 value, based on the extent specified for 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, a topology dataset may reference 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.

• If the Schema only parameter is checked, only the schema of the input data sources will be consolidated or packaged. 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 and 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.

Parameters

Dialog

Label	Explanation	Data Type
Input Layer	The input layers that will be consolidated.	Layer
Output Folder	The output folder that will contain the layer files and consolidated data. If the specified folder does not exist, a new folder will be created.	Folder
Convert data to file geodatabase (Optional)	Specifies whether input layers will be converted to a file geodatabase or preserved in their original format. Checked—All data will be converted to a file geodatabase. This option does not apply to enterprise geodatabase data sources. To include enterprise geodatabase data, check the Include Enterprise Geodatabase data instead of referencing the data parameter. Unchecked—Data formats will be preserved when possible. This is the default.	Boolean
Include Enterprise Geodatabase data instead of referencing the data (Optional)	Specifies whether input enterprise geodatabase layers will be converted to a file geodatabase or preserved in their original format. Checked—All enterprise geodatabase data sources will be converted to a file geodatabase. This is the default. Unchecked—All enterprise geodatabase data sources will be preserved and will be referenced in the resulting package.	Boolean
Extent (Optional)	Specifies the extent that will be used to select or clip features. Current Display Extent —The extent will be based on the active map or scene. Draw Extent —The extent will be based on a rectangle drawn on the map or scene. Extent of a Layer —The extent will be based on an active map layer. Choose an available layer or use the Extent of data in all layers option. Each map layer has the following options: All Features —The extent of all features. Selected Features —The extent of the selected features. Visible Features —The extent of visible features. Browse —The extent will be based on a dataset. Intersection of Inputs —The extent will be the intersecting extent of all inputs. Union of Inputs —The extent will be the combined extent of all inputs. Clipboard —The extent can be copied to and from the clipboard. Copy Extent —Copies the extent and coordinate system to the clipboard. Paste Extent —Pastes the extent and coordinate system from the clipboard. If the clipboard does not include a coordinate system, the extent will use the map’s coordinate system. Reset Extent —The extent will be reset to the default value. When coordinates are manually provided, the coordinates must be numeric values and in the active map's coordinate system. The map may use different display units than the provided coordinates. Use a negative value sign for south and west coordinates.	Extent
Apply extent only to enterprise geodatabase layers (Optional)	Specifies whether the specified extent will be applied to all layers or to enterprise geodatabase layers only. Unchecked—The specified extent will be applied to all layers. This is the default. Checked—The specified extent will be applied to enterprise geodatabase layers only.	Boolean
Schema only (Optional)	Specifies whether only the schema of the input layers will be consolidated or packaged. Unchecked—All features and records for input layers will be included in the consolidated folder or package. This is the default. Checked—Only the schema of the input layers will be consolidated or packaged. No features or records will be consolidated or packaged in the output folder.	Boolean
Keep only the rows which are related to features within the extent (Optional)	Specifies whether the specified extent will be applied to related data sources. Unchecked—Related data sources will be consolidated in their entirety. This is the default. Checked—Only related data corresponding to records within the specified extent will be consolidated.	Boolean
Preserve mobile geodatabase (Optional)	Specifies whether input mobile geodatabase data will be preserved in the output or written to file geodatabase format. If the input data is a mobile geodatabase network dataset, the output will be a mobile geodatabase. This parameter overrides the Convert data to file geodatabase parameter when the input data is a mobile geodatabase. Unchecked—Mobile geodatabase data will be converted to file geodatabase format. This is the default. Checked—Mobile geodatabase data will be preserved as mobile geodatabase data in the output. The geodatabase will be included in its entirety.	Boolean
Exclude Network Dataset (Optional)	For network analysis layers, specifies whether the network dataset will also be consolidated. Unchecked—The network dataset will be included and consolidated. This is the default. Checked—The network dataset will not be included. Only the selected network analysis layers will be consolidated.	Boolean

Python

arcpy.management.ConsolidateLayer(in_layer, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only}, {select_related_rows}, {preserve_sqlite}, {exclude_network_dataset})

Name	Explanation	Data Type
in_layer [in_layer,...]	The input layers that will be consolidated.	Layer
output_folder	The output folder that will contain the layer files and consolidated data. If the specified folder does not exist, a new folder will be created.	Folder
convert_data (Optional)	Specifies whether input layers will be converted to a file geodatabase or preserved in their original format. CONVERT— Data will be converted to a file geodatabase. This option does not apply to enterprise geodatabase data sources. To convert enterprise geodatabase data, set the convert_arcsde_data parameter to CONVERT_ARCSDE. PRESERVE—Data formats will be preserved when possible. This is the default.	Boolean
convert_arcsde_data (Optional)	Specifies whether input enterprise geodatabase layers will be converted to a file geodatabase or preserved in their original format. CONVERT_ARCSDE— Enterprise geodatabase data will be converted to a file geodatabase and will be 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 that will be used to select or clip features. MAXOF—The maximum extent of all inputs will be used. MINOF—The minimum area common to all inputs will be used. DISPLAY—The extent is equal to the visible display. Layer name—The extent of the specified layer will be used. Extent object—The extent of the specified object will be used. Space delimited string of coordinates—The extent of the specified string will be used. Coordinates are expressed in the order of x-min, y-min, x-max, y-max.	Extent
apply_extent_to_arcsde (Optional)	Specifies whether the specified extent will be applied to all layers or to enterprise geodatabase layers only. ALL— The specified extent will be applied to all layers. This is the default. ARCSDE_ONLY—The specified extent will be 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 the input layers will be consolidated or packaged.	Boolean
select_related_rows (Optional)	Specifies whether the specified extent will be applied to related data sources. KEEP_ONLY_RELATED_ROWS—Only related data corresponding to records within the specified extent will be consolidated. KEEP_ALL_RELATED_ROWS—Related data sources will be consolidated in their entirety. This is the default.	Boolean
preserve_sqlite (Optional)	Specifies whether mobile geodatabase data will be preserved in the output or written to file geodatabase format. If the input data is a mobile geodatabase network dataset, the output will be a mobile geodatabase. This parameter overrides the convert_data parameter when the input data is a mobile geodatabase. CONVERT_SQLITE—Mobile geodatabase data will be converted to file geodatabase format. This is the default. PRESERVE_SQLITE— Mobile geodatabase data will be preserved as mobile geodatabase data in the output. The geodatabase will be included in its entirety.	Boolean
exclude_network_dataset (Optional)	For network analysis layers, specifies whether the network dataset will also be consolidated. INCLUDE_NETWORK_DATASET—The network dataset will be included and consolidated. This is the default. EXCLUDE_NETWORK_DATASET— The network dataset will not be included. Only the network analysis layers will be consolidated.	Boolean

Code sample

ConsolidateLayer example 1 (Python window)

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

import arcpy
arcpy.env.workspace = 'C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers' 
arcpy.management.ConsolidateLayer('Parcels.lyr', 'Consolidated_folder', 'PRESERVE', 'CONVERT_ARCSDE')

ConsolidateLayer example 2 (stand-alone script)

Find and create 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.management.ConsolidateLayer(lyr, os.path.splitext(lyr)[0], 'PRESERVE', 'CONVERT_ARCSDE')

Environments

Current Workspace, Extent, Parallel Processing Factor

Special cases

Parallel Processing Factor

If the environment is not specified, the tool will use one half of the available cores.

Licensing information

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