Run the Sitecore Xdb Collection Update tool

Tool arguments

Version: 10.5

The following table lists the Sitecore Xdb Collection Update tool’s arguments:

Argument (short synonym)	Required	Default value	Description
--cmd (-c)	Yes		The update operation that you want to run
--connectionString(-s)	Yes		The connection string to the collection shard, including the user ID and password
--consumersNumber (-cn)	No	8	The number of threads that will send update queries
--batchSize (-bs)	No	500	The number of entities that should be updated in a single query
--timeout(-t)	No	30	The command query timeout
--startId (-si)	No	00000000-0000-0000-0000-000000000000	The ID value that you want to start updating from. The contactPercentile, contactPercentile, and contacts update operations support this argument.

Example:


.\SitecoreXdbCollectionUpdateTool.exe -s "user id=sa;password=12345;data source=.\SQL2017;Initial Catalog= Xdb.Collection.Shard0" -c deviceProfiles

.\SitecoreXdbCollectionUpdateTool.exe -s "user id=sa;password=12345;data source=.\SQL2017;Initial Catalog= Xdb.Collection.Shard0" -c deviceProfileFacets

.\SitecoreXdbCollectionUpdateTool.exe -s "user id=sa;password=12345;data source=.\SQL2017;Initial Catalog= Xdb.Collection.Shard0" -c contacts

.\SitecoreXdbCollectionUpdateTool.exe -s "user id=sa;password=12345;data source=.\SQL2017;Initial Catalog= Xdb.Collection.Shard0" -c contactIdentifierIndexes

.\SitecoreXdbCollectionUpdateTool.exe -s "user id=sa;password=12345;data source=.\SQL2017;Initial Catalog= Xdb.Collection.Shard0" -c contactPercentile

.\SitecoreXdbCollectionUpdateTool.exe -s "user id=sa;password=12345;data source=.\SQL2017;Initial Catalog= Xdb.Collection.Shard0" -c interactionPercentile

If you have suggestions for improving this article, let us know!