Invoke-ProcessPartition

Reference

Module:: SQLServer

Conducts the Process operation on a specific Partition of a specific database having a specific Cube name and a MeasureGroup name with a specific ProcessType value.

Syntax

Invoke-ProcessPartition
      [-CubeName] <String>
      [-MeasureGroupName] <String>
      [-Name] <String>
      [-Database] <String>
      [-ProcessType] <ProcessType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ProcessPartition
      [-PartitionName] <String>
      [-TableName] <String>
      [-Database] <String>
      [-RefreshType] <RefreshType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ProcessPartition
      -DatabasePartition <Object>
      [-ProcessType] <ProcessType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ProcessPartition
      -DatabasePartition <Object>
      [-RefreshType] <RefreshType>
      [-Server <String>]
      [-Credential <PSCredential>]
      [-ServicePrincipal]
      [-ApplicationId <String>]
      [-TenantId <String>]
      [-CertificateThumbprint <String>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Conducts the Process operation on a specific Partition of a specific database having a specific Cube name and a MeasureGroup name with a specific ProcessType value.

Module requirements: version 21+ on PowerShell 5.1; version 21 (recent preview) or version 22+ on PowerShell 7.x.

Examples

Process partition from pipeline

PS SQLSERVER:\SQLAS\MachineName\Instance\Databases\DB1\Cubes\myCube\MeasureGroups\myMeasureGroup\Partitions\Partition1> Get-Item . | Invoke-ProcessPartition -ProcessType ProcessDefault

This command pipes in the identity of the partition to be processed.

Process partition using name

PS SQL SERVER:\SQLAS\MachineName\Instance\Databases\AWTEST\Cubes\Adventure Works\MeasureGroups> Invoke-ProcessPartition �Name "Total_Orders_2003" �MeasureGroupname "Sales Order" �CubeName "Adventure Works" �database "AWTEST" �ProcessType "ProcessFull"

This command processes the partition 'Total_Orders_2003' in the 'Sales Orders' measure group of the 'AWTEST' database.

Process tabular metadata partition

PS SQLSERVER:\SQLAS\MachineName\Instance\Databases\DB1> Invoke-ProcessPartition -PartitionName "myPartition" -TableName "myTable" -Database "DB1"  -RefreshType "Full"

Process tabular metadata partition using enum refresh type

PS SQLSERVER:\SQLAS\MachineName\Instance\Databases\DB1> Invoke-ProcessPartition -PartitionName "myPartition" -TableName "myTable" -Database "DB1"  -RefreshType [Microsoft.AnalysisServices.Tabular.RefreshType]::Full

Parameters

-ApplicationId

The application Id for the service principal.

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

-CertificateThumbprint

The certificate thumbprint for the service principal.

Type:	String
Position:	Named
Default value:	None
Required:	False
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
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CubeName

Cube name to which the MeasureGroup belongs to. (Multidimensional metadata only)

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Database

Database name to which the cube belongs to. (Multidimensional and tabular metadata)

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

-DatabasePartition

Microsoft.AnalysisServices.Partition or Microsoft.AnalysisService.Tabular.Partition object that has to be processed. (Multidimensional and tabular metadata respectively)

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

-MeasureGroupName

MeasureGroup name to which the Partition belongs to.(Multidimensional metadata only)

Type:	String
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of the Partition that has to be processed. (Multidimensional metadata only)

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

-PartitionName

The name of the partition.

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

-ProcessType

Specifies the process type (Multidimensional metadata only)

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RefreshType

The type of refresh.

Type:	RefreshType
Accepted values:	Full, ClearValues, Calculate, DataOnly, Automatic, Add, Defragment
Position:	2
Default value:	None
Required:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServicePrincipal

Specifies that this connection is using service principal.

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

-TableName

Specifies the name of the table.

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

-TenantId

The tenant Id for the service principal.

Type:	String
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Notes

Supported on all Analysis Services instances

Share via