Invoke-ProcessTable

Reference

Module:: SQLServer

Conducts the Process operation on a specified Table with a specific RefreshType.

Syntax

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

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

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

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

Description

Conducts the Process operation on a specified Table with a specific RefreshType.

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

Examples

Process tabular metadata table

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

Process tabular metadata table using enum refresh type

PS SQLSERVER:\SQLAS\MachineName\Instance\Databases\DB1\> Invoke-ProcessTable -TableName "myTable" -Database "DB1"  -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

Include this parameter to interactively confirm the operation with a Yes or No response before it's executed.

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

-DatabaseName

Database name to which the cube belongs to.

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

-RefreshType

Microsoft.AnalysisServices.Tabular.RefreshType to process the partition with.

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

-Table

Microsoft.AnalysisServices.Tabular.Table object that is to be processed.

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

-TableName

Name of the table to with the partition belongs that has to be processed.

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

Include this parameter to get information about the impact of the operation before it's executed.

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

Inputs

Microsoft.AnalysisServices.Tabular.Table

Notes

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