Table.ApplyRefreshPolicy Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ApplyRefreshPolicy(Boolean, Int32) |
Adjusting the partitioning scheme of the table, determined by the refresh-policy that is associated with it when the effective date that is used is based on the current time. |
| ApplyRefreshPolicy(DateTime, Boolean, Int32) |
Adjusting the partitioning scheme of the table, determined by the refresh-policy that is associated with it and the specified effective date. |
ApplyRefreshPolicy(Boolean, Int32)
Adjusting the partitioning scheme of the table, determined by the refresh-policy that is associated with it when the effective date that is used is based on the current time.
public System.Collections.Generic.IReadOnlyList<Microsoft.AnalysisServices.Tabular.ModelOperationResult> ApplyRefreshPolicy (bool refresh = true, int maxParallelism = 0);member this.ApplyRefreshPolicy : bool * int -> System.Collections.Generic.IReadOnlyList<Microsoft.AnalysisServices.Tabular.ModelOperationResult>Public Function ApplyRefreshPolicy (Optional refresh As Boolean = true, Optional maxParallelism As Integer = 0) As IReadOnlyList(Of ModelOperationResult)Parameters
- refresh
- Boolean
An indication if partitions of the table should be refreshed or not; the default behavior is to do the refresh.
- maxParallelism
- Int32
The degree of parallelism during the refresh execution.
Returns
The results of the operations that were executed in the procedure.
Remarks
- The execution flow of ApplyRefreshPolicy is the same as the flow that is triggered by a call to RequestRefresh, followed by a call to Model.SaveChanges.
- The execution flow includes:
- Calculating the expected partitioning scheme based on the effective date.
- Comparing the expected partitioning scheme to the existing set of partitions and issue the needed changes to move to the expected scheme [dropping, creating, and merging partitions as needed].
- Refresh the newly created partitions as well as the existing partitions in the incremental window.
- The only difference between the ApplyRefreshPolicy and the combination of RequestRefresh + SaveChanges is ApplyRefreshPolicy enables advanced options that are not available otherwise.
- It is recommended to use ApplyRefreshPolicy when you want to use a single API call, especially with advanced options.
- It is recommended to use the combination of RequestRefresh + SaveChanges when you want to combine the operation with additional authoring calls in the model before the call to SaveChanges.
Applies to
ApplyRefreshPolicy(DateTime, Boolean, Int32)
Adjusting the partitioning scheme of the table, determined by the refresh-policy that is associated with it and the specified effective date.
public System.Collections.Generic.IReadOnlyList<Microsoft.AnalysisServices.Tabular.ModelOperationResult> ApplyRefreshPolicy (DateTime effectiveDate, bool refresh = true, int maxParallelism = 0);member this.ApplyRefreshPolicy : DateTime * bool * int -> System.Collections.Generic.IReadOnlyList<Microsoft.AnalysisServices.Tabular.ModelOperationResult>Public Function ApplyRefreshPolicy (effectiveDate As DateTime, Optional refresh As Boolean = true, Optional maxParallelism As Integer = 0) As IReadOnlyList(Of ModelOperationResult)Parameters
- effectiveDate
- DateTime
The effective date that is used when calculating the partitioning scheme.
- refresh
- Boolean
An indication if partitions of the table should be refreshed or not; the default behavior is to do the refresh.
- maxParallelism
- Int32
The degree of parallelism during the refresh execution.
Returns
The results of the operations that were executed in the procedure.
Remarks
- The execution flow of ApplyRefreshPolicy is the same as the flow that is triggered by a call to RequestRefresh, followed by a call to Model.SaveChanges.
- The execution flow includes:
- Calculating the expected partitioning scheme based on the effective date.
- Comparing the expected partitioning scheme to the existing set of partitions and issue the needed changes to move to the expected scheme [dropping, creating, and merging partitions as needed].
- Refresh the newly created partitions as well as the existing partitions in the incremental window.
- The only difference between the ApplyRefreshPolicy and the combination of RequestRefresh+SaveChanges is ApplyRefreshPolicy enables advanced options that are not available otherwise.
- It is recommended to use ApplyRefreshPolicy when you want to use a single API call, especially with advanced options.
- It is recommended to use the combination of RequestRefresh + SaveChanges when you want to combine the operation with additional authoring calls in the model before the call to SaveChanges.