Lusid.CorporateAction.Source

The Lusid.CorporateAction.Source provider enables you to write a Luminesce SQL query that retrieves information about corporate action sources in LUSID.

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

See also: Lusid.CorporateAction.Source.Writer

Basic usage

select * from Lusid.CorporateAction.Source where <filter-expression>

Query parameters

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

Data fields

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

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

Examples

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

Example 1: Retrieve the first ten corporate action sources

select * from Lusid.CorporateAction.Source limit 10

Example 2: Retrieve all sources using a particular instrument scope

select * from Lusid.CorporateAction.Source where InstrumentScopes = 'secret-instr-scope'