Lusid.CleardownModule.Rule

Providing you have sufficient access control permissions, the Lusid.CleardownModule.Rule provider enables you to write a Luminesce SQL query that retrieves cleardown rules for one or more cleardown modules.

Lusid.CleardownModule.Rule returns one record per cleardown rule. The RulePriority field reports the order of the cleardown rule in the set belonging to a particular cleardown module; lower numbers take precedence and are evaluated earlier.

See also: Lusid.CleardownModule.Rule.Writer

Basic usage

select * from Lusid.CleardownModule.Rule where <filter-expression>;

Query parameters

Lusid.CleardownModule.Rule has parameters that enable you to filter or refine a query.

To list available parameters, their data types, default values, and an explanation for each, run the following query using a suitable tool:

select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Lusid.CleardownModule.Rule' and FieldType = 'Parameter';

Data fields

By default, Lusid.CleardownModule.Rule returns a table of data populated with particular fields (columns). You can return a subset of these fields.

To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a suitable tool:

select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Lusid.CleardownModule.Rule' and FieldType = 'Column';

Note: Fields marked 'main' are returned by queries that select a caret character, for example select ^ from Lusid.CleardownModule.Rule.

Examples

Note: For more example Luminesce SQL queries, visit our Github repo.

Example 1: Retrieve every cleardown module rule

select * from Lusid.CleardownModule.Rule;

Example 2: Retrieve cleardown rules for a particular cleardown module

select * from Lusid.CleardownModule.Rule where CleardownModuleCode = 'Standard';