Lusid.Portfolio.Holding.Property

  • Published on Aug 21, 2024

Type

Read/write

Author

Availability

Data provider

Read

Finbourne

Provided with LUSID

The Lusid.Portfolio.Holding.Property provider enables you to write a Luminesce SQL query that retrieves custom properties for holdings in LUSID.

Note: The LUSID user running the query must have sufficient access control permissions to both use the provider and read holding property data stored in LUSID. This should automatically be the case if you are the domain owner.

Note that, by default, the core Lusid.Portfolio.Holding provider does not retrieve properties. You can use Lusid.Portfolio.Holding.Property to do so in conjunction with any other provider (including Lusid.Portfolio.Holding) to analyse all the data associated with holdings.

See also: Lusid.Portfolio.Txn.Property

select * from Lusid.Portfolio.Holding.Property where <filter-expression>;
SQL

Lusid.Portfolio.Holding.Property 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.Portfolio.Holding.Property' and FieldType = 'Parameter';
SQL

By default, Lusid.Portfolio.Holding.Property returns a table of data populated with particular fields (columns). You can return just a subset of these fields if you wish.

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.Portfolio.Holding.Property' and FieldType = 'Column';
SQL

Note: Fields marked 'main' are returned by queries that start select ^ from Lusid.Portfolio.Holding.Property...

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

select * from Lusid.Portfolio.Holding.Property
SQL

You can select a particular property value for your filter expression, for example the New Investment order reason code.

select * from Lusid.Portfolio.Holding.Property where PropertyCode = 'OrderReason' and Value = 'New Investment'
SQL

You can join Lusid.Portfolio.Holding.Property to an entity provider such as Lusid.Instrument to decorate holdings with particular instrument fields such as DisplayName.

select 
    i.LusidInstrumentId,
    i.DisplayName as InstrumentName,
    hp.PortfolioScope,
    hp.PortfolioCode,
    hp.SubHoldingKey,
    hp.Value as 'OrderReason'
from Lusid.Portfolio.Holding.Property hp
inner join Lusid.Instrument i
    on i.LusidInstrumentId = hp.LusidInstrumentId
where hp.PortfolioScope = 'Finbourne-Examples' and hp.PropertyCode = 'OrderReason'
SQL