Type | Read/write | Author | Availability |
---|---|---|---|
Read | FINBOURNE | Provided with LUSID |
Providing you have sufficient access control permissions, the Lusid.ReferenceList
provider enables you to write a Luminesce SQL query that retrieves reference lists stored in LUSID.
Note: Retrieving
PropertyList
is not currently supported. You can use the LUSID API or LUSID web app instead, see how.
See also: Lusid.ReferenceList.Writer
Basic usage
select * from Lusid.ReferenceList where <filter-expression>
Query parameters
Lusid.ReferenceList
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.ReferenceList' and FieldType = 'Parameter';
Data fields
By default, Lusid.ReferenceList
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.ReferenceList' and FieldType = 'Column';
Note: Fields marked 'main' are returned by queries that select a caret character, for example
select ^ from Lusid.ReferenceList
.
Examples
Note: For more example Luminesce SQL queries, visit our Github repo.
Example 1: Retrieve first 10 reference lists
select * from Lusid.ReferenceList limit 10;
Example 2: Retrieve a particular reference list
select * from Lusid.ReferenceList where Scope = 'Finbourne-Examples' and Code = 'Uk-Portfolios';
Example 3: Retrieve reference lists containing a particular value
select * from Lusid.ReferenceList where Value like '%%PortfolioUk%%';