Summary
Alters the properties of an attribute rule.
Usage
Altering an attribute rule requires an exclusive lock on the dataset. Any active connections to the dataset should be closed, which may include stopping any services.
Syntax
arcpy.management.AlterAttributeRule(in_table, name, {description}, {error_number}, {error_message}, {tags}, {triggering_events}, {script_expression}, {exclude_from_client_evaluation})
Parameter | Explanation | Data Type |
in_table | The table containing the attribute rule to be altered. | Table View |
name | The name of the attribute rule that will be altered. | String |
description (Optional) | The description of the attribute rule. To keep the current value of the description, leave this parameter empty. To clear the current value of the description, use the RESET keyword.
| String |
error_number (Optional) | The error number of the attribute rule. To keep the current value of the error number, leave this parameter empty. To clear the current value of the error number for a calculation rule, use the RESET keyword. Error number is a required property for constraint and validation rules and cannot be cleared.
| String |
error_message (Optional) | The error message of the attribute rule. To keep the current value of the error message, leave this parameter empty. To clear the current value of the error message for a calculation rule, use the RESET keyword. Error message is a required property for constraint and validation rules and cannot be cleared.
| String |
tags [tags,...] (Optional) | The tags for the attribute rule. Be aware that the new values will replace all existing tags; if you want to keep any current tags, include them in this list. For multiple tags, use a semicolon delimiter, for example, Tag1;Tag2;Tag3. To keep the current tags, leave this parameter empty. To clear the current tags, use the RESET keyword.
| String |
triggering_events [triggering_events,...] (Optional) | Specifies the editing events that will trigger the attribute rule to take effect. Triggering events are only applicable for constraint rules and calculation rules that have the Batch parameter set to false. Be aware that the new values will replace existing triggering events. To keep the current triggering events, leave this parameter empty.
| String |
script_expression (Optional) | An Arcade expression that defines the rule. To keep the current expression, leave this parameter empty. Be aware that if an expression is provided for this parameter, it will replace the existing Arcade expression of the rule. If you alter the script expression of a batch calculation or validation rule, the rule will need to be reevaluated. | Calculator Expression |
exclude_from_client_evaluation (Optional) | Specifies whether the rule will be evaluated before edits are applied. The default for this property corresponds to the current value set for the rule. That is, if the input rule has the exclude from client evaluation property set to false, the default for this parameter will be INCLUDE so as to not modify the property without you specifically choosing to do so. This parameter is not applicable for validation rules or batch calculation rules.
| Boolean |
Derived Output
Name | Explanation | Data Type |
updated_table | The input table with the updated attribute rule properties. | Table View; Raster Layer; Mosaic Layer |
Code sample
Alter the properties of a constraint attribute rule named constraintRuleOP.
import arcpy
arcpy.AlterAttributeRule_management("C:\\MyProject\\sdeConn.sde\\progdb.user1.GasPipes",
"constraintRuleOP",
"Operating pressure cannot exceed 300",
"999",
"Invalid operating pressure value",
"Pipeline;OP;ExceededValue")
Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes