Type | Read/write | Author | Availability |
Read | Finbourne | Provided with LUSID |
The Sys.Registration
provider enables you to write a Luminesce SQL query that lists the providers currently available to you in Luminesce. Sys.Registration
is the key source of data for which providers exist in your environment and how many instances of a provider exist at any point in time. You also have the option to see on which machines/pods they are running.
Note: The LUSID user running the query must have sufficient access control permissions to both use the provider and read system provider data. This should automatically be the case if you are the domain owner.
If you are a LUSID administrator (or have Feature/Honeycomb/GlobalMetadataVisibility
granted against Sys.Registration
), you can query Sys.Registration
with the filter ShowAll = true
to show details of every provider available to your domain. All users can filter using ShowAll = false
to return only the providers you may use.
See also: Sys.Field
Basic usage
select * from Sys.Registration where <filter-expression>;
Query parameters
Sys.Registration
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 = 'Sys.Registration' and FieldType = 'Parameter';
Data fields
By default, Sys.Registration
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 = 'Sys.Registration' and FieldType = 'Column';
Note: Fields marked 'main' are returned by queries that include a caret character, for example
select ^ from Sys.Registration
.
Examples
Note: For more example Luminesce SQL queries, visit our Github repo.
Example 1: Retrieve first 10 providers
select * from Sys.Registration limit 10
Example 2: Retrieve knowledge base documentation link for providers
select Name, DocumentationLink from Sys.Registration where DocumentationLink is not null
Example 3: Retrieve providers specific to the client
select * from Sys.Registration where Client is not null
Example 4: Retrieve available views
select * from Sys.Registration where Category = 'View'