Invoke-ProcessDimension

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

SqlServer

Conducts the Process operation on a specified Cube of a specific database with a specific ProcessType value.

Syntax

Invoke-ProcessDimension
      [-Name] <String>
      [-Database] <String>
      -ProcessType <ProcessType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ProcessDimension
      -DatabaseDimension <Dimension>
      -ProcessType <ProcessType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ProcessDimension
      [-Database] <String>
      [-RefreshType] <RefreshType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ProcessDimension
      [-RefreshType] <RefreshType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Conducts the Process operation on a specific Dimension of a specific database with a specific ProcessType value depending upon the input values.

Note: This cmdlet is only available for PowerShell 5. Currently, it is available for PowerShell 7 in recent **preview** versions of the module.

Examples

Example 1

PS SQL SERVER:\sqlas\locahost\default\Databases\AWTEST\Dimensions\Account> Get-Item . | Invoke-ProcessDimension �ProcessType:ProcessDefault

This command retrieves the specified dimension object via the pipeline and processes it.

Example 2

PS SQL SERVER:\sqlas\locahost\default\Databases\AWTEST\Dimensions > Invoke-ProcessDimension �Name �Customer� �Database �AWTEST� �ProcessType �ProcessDefault�

This command identifies a specific dimension that will be processed.

Parameters

-ApplicationId

The application Id for the service principal.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-CertificateThumbprint

The certificate thumbprint for the service principal.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

If this parameter is specified, the user name and password passed will be used to connect to specified Analysis Server instance.

If no credentials are specified default windows account of the user who is running the tool will be used.

Type:	PSCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Database

The database name to which the Dimension belongs to.

Type:	String
Position:	1
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseDimension

The Microsoft.AnalysisServices.Dimension object that has to be processed.

Type:	Dimension
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Name of the Dimension that has to be processed.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ProcessType

Analysis Services ProcessType value.

Type:	ProcessType
Accepted values:	ProcessFull, ProcessAdd, ProcessUpdate, ProcessIndexes, ProcessData, ProcessDefault, ProcessClear, ProcessStructure, ProcessClearStructureOnly, ProcessScriptCache, ProcessRecalc, ProcessDefrag
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-RefreshType

{{Fill RefreshType Description}}

Type:	RefreshType
Accepted values:	Full, ClearValues, Calculate, DataOnly, Automatic, Add, Defragment
Position:	2
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Server

Optionally specifies the server instance to connect to if not currently in the SQLAS Provider directory.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipal

Specifies that this connection is using service principal.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-TenantId

The tenant Id for the service principal.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.AnalysisServices.Dimension

Notes

Not supported on tabular databases with compatibility level 1200 or higher.

Sometimes a dimension that processed successfully appears as unprocessed when you list the dimensions folder in the PowerShell window. To verify whether a dimension was actually processed, check the dimension properties in SQL Server Management Studio.