TDWMAddLimitForRuleState | Application Programming Reference | Teradata Vantage - TDWMAddLimitForRuleState - Teradata Vantage - Analytics Database

Application Programming Reference
Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2025-11-21
dita:mapPath
qld1628112131956.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
ajo1472244909562
lifecycle
latest
Product Category
Teradata Vantage™

Adds the default limit or query limit for a specific state. This step is repeated for each state, if necessary. At least one of these calls must specify the default limit.

This XSP is intended to support any TASM rule types (for example, throttle, arrival rate meter, workload, filter, and so on). However, only system throttle, arrival rate meter, and filter are supported in this release.

Syntax

REPLACE PROCEDURE TDWM.TDWMAddLimitForRuleState (
  IN RulesetName TD_ANYTYPE,
  IN RuleName TD_ANYTYPE,
  IN StateName TD_ANYTYPE,
  IN Description TD_ANYTYPE,
  IN StateLimit VARCHAR(50) CHARACTER SET LATIN,
  IN Action VARCHAR(6) CHARACTER SET LATIN,
  IN ReplaceOption CHAR(1) CHARACTER SET LATIN
)
  ...
;

Syntax Elements

RulesetName
Name of the ruleset that contains the RuleName. Use ‘ALLRULESETS’ to add limit for the specified rule state in all existing rulesets. Cannot be null and its length must be between 1 and 30.
RuleName
Name of the throttle to add the limit. The specified name must be unique among all existing TASM rules: throttles, arrival rate meters, workloads, filters, and so on. Cannot be null and the length must be between 1 and 30.
StateName
Name of the state of the RuleName to add the limit. ‘DEFAULT’ is reserved for the default limit that is used for any state that does not have a specific limit. A combination of RulesetName, RuleName, and StateName uniquely identifies a specific rule state. If RulesetName is ‘ALLRULESETS’, the limit is added for the same StateName of the same RuleName in all existing rulesets.
Description
Description of the state limit. Description can be null. The maximum length is 80.
StateLimit
This parameter is ignored if the rule type is filter. For other rule types, the parameter specifies the limit of a state.
Action
Action to take for the specified state.These actions are mutually exclusive.
Filter rules can be enabled or disabled on a state by state basis and automatically reject qualifying queries. Valid actions are:
  • 'E' = Enabled
  • 'N' = Disabled (not enabled)
Throttle and arrival rate meter rules are enabled at the rule level. At the state level, you can specify the action to take for new qualifying requests when the throttle limit is reached. Valid Actions are:
  • 'D' = Delay
  • 'R' = Reject
ReplaceOption
  • 'Y' = Delete the all existing limits of the specified state and add a new state limit. If the specified state does not exist or does not have any sub-criteria, an error is returned.
  • 'N' = Add the specified state limit. If the specified state has a limit, an error is returned.