Lusid.Allocation

Providing you have sufficient access control permissions, the Lusid.Allocation provider enables you to write a Luminesce SQL query that retrieves allocations stored in LUSID.

Note: By default, Lusid.Allocation cannot retrieve properties for allocations. To do this, you must first configure Lusid.Allocation to 'inline' properties. See how to do this.

See also: Lusid.Allocation.Writer

Basic usage

select * from Lusid.Allocation where <filter-expression>

Query parameters

Lusid.Allocation 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.Allocation' and FieldType = 'Parameter';

Data fields

By default, Lusid.Allocation 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.Allocation' and FieldType = 'Column';

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

Examples

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

Example 1: Retrieve first ten allocations

select * from Lusid.Allocation limit 10;

Example 2: Retrieve a particular allocation

select * from Lusid.Allocation where AllocationScope = 'Finbourne-Examples' and AllocationCode = 'ALLOCATION-123';

Example 3: Retrieve allocations for a portfolio on a particular day

select * from Lusid.Allocation 
where PortfolioScope = 'Finbourne-Examples' 
and PortfolioCode = 'UK-Equities'
and AllocationDate between #2023-07-12# and #2023-07-13#; 

Example 4: Retrieve allocations and other information for a particular instrument

select ^ from Lusid.Allocation a
join Lusid.Instrument i
  on a.LusidInstrumentId = i.LusidInstrumentId;