Set-SCDWRetentionPeriod

Set-SCDWRetentionPeriod

Sets the data retention period for a fact table.

Syntax

Parameter Set: EntitySet
Set-SCDWRetentionPeriod [-ComputerName <String> ] [-Credential <PSCredential> ] [-DurationInMinutes <Int32> ] [-EntityName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: DatamartConnectionSet
Set-SCDWRetentionPeriod [-DatamartComputerName] <String> [-DatamartDatabaseName] <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [-DurationInMinutes <Int32> ] [-EntityName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-SCDWRetentionPeriod cmdlet sets the data retention period, in minutes, for either a specific fact table within a specific data warehouse database or the default for fact tables within the database. Data that is eligible for grooming and older than the retention period will be groomed out of the database.

Parameters

-ComputerName<String>

Specifies the name of the computer on which the System Center Data Access service is running. The user account that is defined in the Credential parameter must have access rights to the specified computer. You can omit this parameter only if the System Center Data Access Service is running on the same computer that has Service Manager installed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Credential<PSCredential>

Specifies the credentials to use when you are connecting to the server on which the System Center Data Access service is running. The user account that is provided must have access to that server.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DatamartComputerName<String>

Specifies the name of the computer on which the datamart resides. This is usually the SQL database server that services the data warehouse. If a value is not provided, the value is discovered by inspecting the warehouse configuration.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DatamartDatabaseName<String>

Specifies the name of the datamart database. This is typically the SQL database server that services the data warehouse. The default value is the warehouse repository. You can retrieve the entities from the Staging or DataMart databases to provide a value for this parameter.

Aliases	none
Required?	true
Position?	3
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DurationInMinutes<Int32>

Specifies the duration, in minutes, before the entity is groomed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EntityName<String>

Specifies the Dimension, Fact, or Outrigger on which to set the watermark. You can use the Get-SCDWEntity cmdlet to retrieve entity names.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• None.

  You cannot pipe input to this cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• None.

  This cmdlet does not generate any output.

Examples

Example 1: Set a retention period

This command sets a retention period.

PS C:\> Set-SCDWRetentionPeriod -ComputerName "serverDW72" -DatamartComputerName "serverDW72" -DatamartDatabaseName "CMDWDataMart" -EntityName
"ComputerHasSoftwareUpdateInstalledFact" -DurationInMinutes 1576800

Related topics

Get-SCDWEntity