CHANGE_TRACKING_IS_COLUMN_IN_MASK (Transact-SQL)

Article
11/19/2024

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance SQL database in Microsoft Fabric

Interprets the SYS_CHANGE_COLUMNS value that is returned by the CHANGETABLE(CHANGES ...) function. This enables an application to determine whether the specified column is included in the values that are returned for SYS_CHANGE_COLUMNS.

Transact-SQL syntax conventions

Syntax

  
CHANGE_TRACKING_IS_COLUMN_IN_MASK ( column_id , change_columns )

Arguments

column_id
Is the ID of the column that is being checked. The column ID can be obtained by using the COLUMNPROPERTY function.

change_columns
Is the binary data from the SYS_CHANGE_COLUMNS column of the CHANGETABLE data.

Return Type

bit

Return Values

CHANGE_TRACKING_IS_COLUMN_IN_MASK returns the following values.

Return value	Description
0	The specified column is not in the change_columns list.
1	The specified column is in the change_columns list.

Remarks

CHANGE_TRACKING_IS_COLUMN_IN_MASK does not perform any checks to validate the column_id value or that the change_columns parameter was obtained from the table from which the column_id was obtained.

Examples

The following example determines whether the Salary column of the Employees table was updated. The COLUMNPROPERTY function returns the column ID of the Salary column. The @change_columns local variable must be set to the results of a query by using CHANGETABLE as a data source.

SET @SalaryChanged = CHANGE_TRACKING_IS_COLUMN_IN_MASK  
    (COLUMNPROPERTY(OBJECT_ID('Employees'), 'Salary', 'ColumnId')  
    ,@change_columns);

Share via