Type | Read/write | Author | Availability |
Data provider | Read | FINBOURNE | Provided with LUSID |
Providing you have sufficient access control permissions, the Lusid.OrderInstruction
provider enables you to write a Luminesce SQL query that retrieves order instructions stored in LUSID.
See also: Lusid.OrderInstruction.Writer
Basic usage
select * from Lusid.OrderInstruction where <filter-expression>
Query parameters
Lusid.OrderInstruction
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.OrderInstruction' and FieldType = 'Parameter';
Data fields
By default, Lusid.OrderInstruction
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.OrderInstruction' and FieldType = 'Column';
Note: Fields marked 'main' are returned by queries that select a caret character, for example select ^ from Lusid.OrderInstruction
.
Examples
Note: For more example Luminesce SQL queries, visit our Github repo.
Example 1: Retrieve first ten order instructions
select * from Lusid.OrderInstruction limit 10;
Example 2: Retrieve a particular order instruction
select * from Lusid.OrderInstruction where OrderInstructionScope = 'Finbourne-Examples' and OrderInstructionCode = 'LUID_ABCDEFGH';
Example 3: Retrieve all order instructions for a particular instrument
select * from Lusid.OrderInstruction where LusidInstrumentId = 'LUID_ABCDEFGH';