sp_syscollector_set_cache_window (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Sets the number of times to attempt a data upload in case of failure. Retrying an upload in the event of a failure mitigates the risk of losing collected data.

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_syscollector_set_cache_window [ @cache_window = ] cache_window   

Arguments

[ @cache_window = ] cache_window
Is the number of times a failed data upload to the management data warehouse is retried without losing data. cache_window is int with a default value of 1. cache_window can have one of the following values:

Value Description
-1 Cache all the upload data from the previous upload failures.
0 Do not cache any data from an upload failure.
n Cache data from n previous upload failures, where n >= 1.

Return Code Values

0 (success) or 1 (failure)

Remarks

You must disable the data collector before changing the cache window configuration. This stored procedure fails if the data collector is enabled. For more information, see Enable or Disable Data Collection, and Manage Data Collection.

Permissions

Requires membership in the dc_admin (with EXECUTE permission) fixed database role to execute this procedure.

Examples

The following example disables the data collector, configures the cache window to retain data for up to three failed uploads, and then enables to data collector.

USE msdb;  
GO  
EXECUTE dbo.sp_syscollector_disable_collector;  
GO  
EXECUTE dbo.sp_syscollector_set_cache_window 3;  
GO  
EXECUTE dbo.sp_syscollector_enable_collector;  

See Also

System Stored Procedures (Transact-SQL)
sp_syscollector_set_cache_directory (Transact-SQL)