Refresh command (TMSL)

Článek
12/09/2022

Applies to: SQL Server 2016 and later Analysis Services Azure Analysis Services Fabric/Power BI Premium

Processes objects in the current database.
Refresh always runs in parallel unless you throttle it with Sequence command (TMSL).

You can override some properties of some objects during a data refresh operation:

Change the QueryDefinition property of a Partition object to import data using an on-the-fly filter expression.
Provide data source credentials as part of a Refresh command, in the ConnectionString property of a DataSource object. This approach could be considered more secure, as credentials are provided and used temporarily for the duration of the operation, rather than stored.

Override default Power BI semantic model incremental refresh policy.

See the examples in this topic for an illustration of these property overrides.

Note

Unlike multidimensional processing, there is no special handling of processing errors for tabular processing.

Request

Refresh takes a type parameter and object definition.

    {  
        "refresh": {  
            "description": "Parameters of Refresh command of Analysis Services JSON API",  
            "properties": {  
            "type": {  
                "enum": [  
                "full",  
                "clearValues",  
                "calculate",  
                "dataOnly",  
                "automatic",  
                "add",  
                "defragment"  
                ]  
            },  
            "objects": [

The type parameter sets a scope on the processing operation.

Refresh type	Applies to	Description
full	Database, Table, Partition	For all partitions in the specified partition, table, or database, refresh data and recalculate all dependents. For a calculation partition, recalculate the partition and all its dependents.
clearValues	Database, Table, Partition	Clear values in this object and all its dependents.
calculate	Database, Table, Partition	Recalculate this object and all its dependents, but only if needed. This value does not force recalculation, except for volatile formulas.
dataOnly	Database, Table, Partition	Refresh data in this object and clear all dependents.
automatic	Database, Table, Partition	If the object needs to be refreshed and recalculated, refresh and recalculate the object and all its dependents. Applies if the partition is in a state other than Ready.
add	Partition	Append data to this partition and recalculate all dependents. This command is valid only for regular partitions and not for calculation partitions.
defragment	Database, Table	Defragment the data in the specified table. As data is added to or removed from a table, the dictionaries of each column can become polluted with values that no longer exist in the actual column values. The defragment option will clean up the values in the dictionaries that are no longer used.

You can refresh the following objects:

Database object (TMSL) Process a database.

{  
  "refresh": {  
    "type": "automatic",  
    "objects": [  
      {  
        "database": "AdventureWorksTabular1200"  
      }  
    ]  
  }  
}

Tables object (TMSL) Process a single table.

{  
  "refresh": {  
    "type": "automatic",  
    "objects": [  
      {  
        "database": "AdventureWorksTabular1200",  
        "table": "Date"  
      }  
    ]  
  }  
}

Partitions object (TMSL) Process a single partition within a table.

{  
  "refresh": {  
    "type": "automatic",  
    "objects": [  
      {  
        "database": "AdventureWorksTabular1200",  
        "table": "FactSalesQuota",  
        "partition": "FactSalesQuota"  
      },  
      {  
        "database": "AdventureWorksTabular1200",  
        "table": "FactSalesQuota",  
        "partition": "FactSalesQuota - 2011"  
      }  
    ]  
  }  
}

Optional parameters

For Power BI semantic models, the following parameters can be added to a TMSL refresh command to override the default incremental refresh behavior:

applyRefreshPolicy – If a table has an incremental refresh policy defined, applyRefreshPolicy will determine if the policy is applied or not. If the policy is not applied, a process full operation will leave partition definitions unchanged and all partitions in the table will be fully refreshed. Default value is true.
effectiveDate – If an incremental refresh policy is being applied, it needs to know the current date to determine rolling window ranges for the historical range and the incremental range. The effectiveDate parameter allows you to override the current date. This is useful for testing, demos, and business scenarios where data is incrementally refreshed up to a date in the past or the future (for example, budgets in the future). The default value is the current date.

{
  "refresh": {
    "type": "full",

    "applyRefreshPolicy": true,
    "effectiveDate": "12/31/2013",

    "objects": [
      {
        "database": "IR_AdventureWorks", 
        "table": "FactInternetSales" 
      }
    ]
  }
}

The following table shows the impact when applyRefreshPolicy is true (default) on each of the refresh types for a table that contains an incremental refresh policy:

Refresh type	Impact
full	The policy is applied as described in Incremental refresh in Power BI. Assuming historical partitions have already been created by a prior refresh operation, a summary is described here: - New partitions are added to the incremental range if needed. - If no pollingExpression is defined for detection of data changes, all partitions in the incremental range are refreshed in full. - If a pollingExpression is defined, it is evaluated for each partition in the incremental range. Only those that return a different polling result compared to the previous refresh operation are refreshed in full. - Historical partitions are not refreshed regardless of whether they have been cleared of data. - Historical partitions that fall out of range are deleted. - Recalculation of affected partitions and dependents.
clearValues	applyRefreshPolicy does not affect behavior.
calculate	applyRefreshPolicy does not affect behavior.
dataOnly	Same as type=full, but without recalculation of affected partitions and dependents.
automatic	Same as type=full, but partitions in the incremental range are refreshed using type=automatic.
add	applyRefreshPolicy does not affect behavior.
defragment	applyRefreshPolicy does not affect behavior.

Response

Returns an empty result when the command succeeds. Otherwise, an XMLA exception is returned.

Examples

Override both the ConnectionString and QueryDefinition of a partition.

{
  "refresh": {
    "type": "dataOnly",
    "objects": [
      {
        "database": "AdventureWorksDW2017",
        "table": "DimCustomer"
      }
    ],
    "overrides": [
      {
        "dataSources": [ // Bindings for DataSources
          {
            "originalObject": {
              "database": "AdventureWorksDW2017",
              "dataSource": "SqlServer localhost"
            },
            "connectionString": "Provider=SQLNCLI11.1;Data Source=.;Persist Security Info=True;User ID=YourSQLLogin;Password=YourPassword;Initial Catalog=AdventureWorksDW2017"
          }
        ],
        "partitions": [ // Bindings for Partitions
          {
            "originalObject": {
              "database": "AdventureWorksDW2017",
              "table": "DimCustomer",
              "partition": "DimCustomer"
            },
            "source": {
              "query": "SELECT * FROM [dbo].[DimCustomer]"
            }
          }
        ]
      }
    ]
  }
}

Scope particular overrides by setting the type parameter to a dataOnly refresh, metadata stays intact.

{
  "refresh": {
    "type": "dataOnly",
    "objects": [
      {
        "database": "TMTestDB",
        "table": "Customer"
      },
      {
        "database": "TMTestDB",
        "table": "Sales"
      }
    ],
    "overrides": [
      {
        "scope": {
          "database": "TMTestDB",
          "table": "Sales"
        },
        "dataSources": [
          {
            "originalObject": {
              "dataSource": "SqlServer sqlcldb2 AS_foodmart_2000"
            },
            "connectionString": "Provider=SQLNCLI11;Data Source=sqlcldb2;Initial Catalog=AS_foodmart_2000;Integrated Security=SSPI;Persist Security Info=false"
          }
        ]
      }
    ]
  }
}

Usage (endpoints)

This command element is used in a statement of the Execute Method (XMLA) call over an XMLA endpoint, exposed in the following ways:

As an XMLA window in SQL Server Management Studio (SSMS)
As an input file to the invoke-ascmd PowerShell cmdlet
As an input to an SSIS task or SQL Server Agent job

You can generate a ready-made script for this command from SSMS. For example, you can click the Script in a Processing dialog box.

Sdílet prostřednictvím