| Type | Read/write | Author | Availability |
| Data provider | Read | FINBOURNE | Provided with LUSID |
Providing you have sufficient access control permissions, the Lusid.CleardownModule provider enables you to write a Luminesce SQL query that retrieves cleardown modules stored in LUSID.
See also: Lusid.CleardownModule.Writer
Basic usage
select * from Lusid.CleardownModule where <filter-expression>;
Query parameters
Lusid.CleardownModule 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' and FieldType = 'Parameter';
Data fields
By default, Lusid.CleardownModule 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' and FieldType = 'Column';
Note: Fields marked 'main' are returned by queries that select a caret character, for example select ^ from Lusid.CleardownModule.
Examples
Note: For more example Luminesce SQL queries, visit our Github repo.
Example 1: Retrieve every cleardown module
select * from Lusid.CleardownModule;
Example 2: Retrieve cleardown modules from a particular CoA
select * from Lusid.CleardownModule where ChartOfAccountsScope = 'Abor' and ChartOfAccountsCode = 'Standard';