DM_getRules

This function returns a table containing the rules in a value of type DM_RuleModel.

Syntax

Function syntax

Read syntax diagramSkip visual syntax diagram
>>-DM_getRules--(--ruleModel--)--------------------------------><

Parameters

ruleModel
A value of type DM_RuleModel

Return Value

The return value is of type TABLE

Table 1. Result Values for DM_getRules
Column Data type Purpose
Id INTEGER Is a number generated to identify the rules.
headName VARCHAR(1024) Contains the head item of the rule after name mapping (if any).
head VARCHAR(1024) Uses the original item before name mappings.
bodyId INTEGER Is a generated identifier to allow joining the resulting table with a table generated by DM_getRuleBodies. Note: Values of BODYID may appear in several rows, if there are rules with identical sets of items in their bodies.
length SMALLINT Is a concatenation of the names of all body items separated by the term 'AND'. The body items and their names can be determined using the table DM_getRuleBodies.
bodyText VARCHAR(4096) Is a count of all items in the head and body.
support REAL Is the rule support and contains percentage values between 0.0 and 100.0. The support of an association rule is the percentage of groups that contain all of the items listed in that association rule.
confidence REAL Is the rule confidence and contains percentage values between 0.0 and 100.0. The confidence of an association rule is a percentage value that shows how frequently the rule head occurs among all the groups containing the rule body.
lift REAL Indicates how much more confidence the rule has as might be expected if the items were statistically independent; the value is given as a positive factor. The lift of a rule is the ratio of confidence to the expected confidence. It indicates how much more confidence the rule has as might be expected if the items were statistically independent.


Feedback | Information roadmap