Summary
Synchronizes a mosaic dataset to keep it up to date. In addition to syncing data, you can update overviews if the underlying imagery has been changed, generate new overviews and cache, and restore the original configuration of mosaic dataset items. You can also remove paths to source data with this tool. To repair paths, use the Repair Mosaic Dataset Paths tool.
Synchronization is a one-way operation: changes in the source data can be synchronized to the mosaic dataset’s attribute table, thereby updating the mosaic dataset's attribute table. Changes in the mosaic dataset's attribute table will not affect the source data.
Usage
You can use a selection set with this tool to limit the raster items that are updated. When there is a selection or query, only those items will be processed.
Synchronization can add new items, update existing items, or remove items.
Stale items refer to source rasters that have been changed since the mosaic dataset was created or the last time the mosaic dataset was synchronized. For instance, the georeferencing may have been updated or the pyramids may have been built.
Since the raster items will be reconstructed, any modifications made to them since the last time they were built will be lost, such as editing functions or content in the attribute table.
If you remove items that have broken data sources, ensure that all network connections are working properly. This tool will remove any items that cannot be accessed.
This tool can also build pyramids and calculate statistics on the source rasters as well as create thumbnails and raster cache for the raster items.
This tool is particularly useful for keeping mosaic datasets up to date. If new raster datasets have been added to the workspaces that this mosaic dataset accesses, the new raster datasets can be added to the mosaic dataset. Mosaic datasets that are populated using tables that reside in an externally managed database can also be updated with this tool.
To use the Refresh Aggregate Information parameter, uncheck the Update Existing Items parameter. For multidimensional mosaic datasets, the Refresh Aggregate Information parameter refreshes the multidimensional properties of the mosaic based on the content of the attribute table of the mosaic dataset.
This tool can be used to generate the cache for an item in the mosaic dataset. Items that can always be cached are created from the following data: .las files, LAS datasets, and terrains. Items can also be cached using the Cached Raster function.
Database fragmentation and frequent data manipulation can dramatically increase the size of your mosaic dataset. If your database size is inflated due to constant transactions, run the Compact tool.
Syntax
arcpy.management.SynchronizeMosaicDataset(in_mosaic_dataset, {where_clause}, {new_items}, {sync_only_stale}, {update_cellsize_ranges}, {update_boundary}, {update_overviews}, {build_pyramids}, {calculate_statistics}, {build_thumbnails}, {build_item_cache}, {rebuild_raster}, {update_fields}, {fields_to_update}, {existing_items}, {broken_items}, {skip_existing_items}, {refresh_aggregate_info}, estimate_statistics)| Parameter | Explanation | Data Type |
in_mosaic_dataset | The mosaic dataset that will be synchronized. | Mosaic Layer |
where_clause (Optional) | An SQL expression to select which mosaic dataset items will be synchronized. If an expression is not provided, all dataset items will be updated. | SQL Expression |
new_items (Optional) | Specifies whether new items will be included when synchronizing as well as the options to use to update the new items. If you use this option, the item's workspace will be searched for new data. When data is added to the mosaic dataset, it will use the same raster type as the other items in the same workspace.
| Boolean |
sync_only_stale (Optional) | Specifies whether mosaic dataset items will be updated only when the underlying raster datasets have been modified due to synchronizing. For example, building pyramids or updating the georeferencing of rasters will affect how the overviews are rendered.
| Boolean |
update_cellsize_ranges (Optional) | Specifies whether cell size ranges for the mosaic dataset will be recalculated.
| Boolean |
update_boundary (Optional) | Specifies whether the boundary that shows the full extent of the mosaic dataset will be rebuilt. Choose UPDATE_BOUNDARY if syncing will change the extent of the mosaic dataset.
| Boolean |
update_overviews (Optional) | Specifies whether obsolete overviews will be updated. The overview becomes obsolete if any underlying rasters have been modified due to synchronizing.
| Boolean |
build_pyramids (Optional) | Specifies whether pyramids will be built for the specified mosaic dataset items. Pyramids can be built for each raster item in the mosaic dataset. Pyramids can improve the speed at which each raster is displayed.
Pyramids will not be built for items that were added due to synchronization. | Boolean |
calculate_statistics (Optional) | Specifies whether statistics will be calculated for the specified mosaic dataset items. Statistics are required for a mosaic dataset when performing certain tasks, such as applying a contrast stretch.
Statistics will not be calculated for items that were added due to synchronization. | Boolean |
build_thumbnails (Optional) | Specifies whether thumbnails will be built for the specified mosaic dataset items. Thumbnails are small, highly resampled images that can be created for each raster item in the mosaic definition. Thumbnails can be accessed when the mosaic dataset is accessed as an image service and will display as part of the item description.
Thumbnails will not be built for items that were added due to synchronization. | Boolean |
build_item_cache (Optional) | Specifies whether a cache will be built for the specified mosaic dataset items. A cache can be built when you've added data using the LAS, Terrain, or LAS Dataset raster types. Items can also be cached using the Cached Raster function.
A cache will not be built for items that were added due to synchronization. | Boolean |
rebuild_raster (Optional) | Specifies whether the raster items will be rebuilt from the data source using the original raster type.
This only affects items that will be synchronized. This parameter is not applicable if the new_items parameter is set to UPDATE_WITH_NEW_ITEMS. | Boolean |
update_fields (Optional) | Specifies whether the fields in the table will be updated. This only affects items that will be synchronized.
If you update the fields, you can control which fields are updated using the fields_to_update parameter. If you made edits to some of the fields, you can remove them using the fields_to_update parameter. | Boolean |
fields_to_update [field_to_update,...] (Optional) | The fields that will be updated. This parameter is only valid if the update_fields parameter is set to UPDATE_FIELDS. If you made edits to some of the fields, make sure they are not listed. The RASTER field can be refreshed, even if REBUILD_RASTER is not specified. However, if REBUILD_RASTER is specified, the RASTER field will be rebuilt, even if the fields_to_update parameter value is not specified. | String |
existing_items (Optional) | Specifies whether existing items in the mosaic dataset will be updated. If you use this parameter, choose which existing parameters to update: sync_only_stale, build_pyramids, calculate_statistics, build_thumbnails, build_item_cache, update_fields, or fields_to_update.
| Boolean |
broken_items (Optional) | Specifies whether items with broken links will be removed. Ensure that all network connections are working properly. This tool will remove any items that cannot be accessed.
| Boolean |
skip_existing_items (Optional) | Specifies whether existing mosaic dataset items will be skipped or updated with the modified files from disk. To use this parameter, the new_items parameter must be set to UPDATE_WITH_NEW_ITEMS.
| Boolean |
refresh_aggregate_info (Optional) | Specifies whether data that may have been removed from the mosaic dataset will be included. To use this parameter, the existing_items parameter must be set to IGNORE_EXISTING_ITEMS.
| Boolean |
estimate_statistics | Specifies whether statistics on the mosaic dataset will be estimated.
| Boolean |
Derived Output
| Name | Explanation | Data Type |
| out_mosaic_dataset | The updated mosaic dataset. | Mosaic Layer |
Code sample
SynchronizeMosaicDataset example 1 (Python window)
This is a Python sample for the SynchronizeMosaicDataset function.
import arcpy
arcpy.SynchronizeMosaicDataset_management(
"c:/data/syncmd.gdb/md", "Year>1999", "NO_NEW_ITEMS", "SYNC_STALE",
"#", "#", "#", "NO_PYRAMIDS", "NO_STATISTICS", "NO_THUMBNAILS",
"NO_ITEM_CACHE", "NO_RASTER", "NO_FIELDS", "#", "#")
SynchronizeMosaicDataset example 2 (stand-alone script)
This is a Python script sample for the SynchronizeMosaicDataset function.
# Synchronize source and add new data
import arcpy
arcpy.env.workspace = "C:/Workspace"
mdname = "syncmd.gdb/mdnew"
query = "#"
updatenew = "UPDATE_WITH_NEW_ITEMS"
syncstale = "SYNC_STALE"
updatecs = "#"
updatebnd = "#"
updateovr = "#"
buildpy = "NO_PYRAMIDS"
calcstats = "NO_STATISTICS"
buildthumb = "NO_THUMBNAILS"
buildcache = "NO_ITEM_CACHE"
updateras = "NO_RASTER"
updatefield = "NO_FIELDS"
fields = "#"
arcpy.SynchronizeMosaicDataset_management(
mdname, query, updatenew, syncstale, updatecs, updatebnd,
updateovr, buildpy, calcstats, buildthumb, buildcache,
updateras, updatefield, fields)
Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes