A tour of LumiCode

Prev Next

This tour shows LumiCode's main features, one screen at a time: writing SQL, exploring and charting results, working with Candela, browsing the catalog, searching your history and diagnosing failed queries. To try LumiCode yourself step by step, start with Getting started with LumiCode.

Every command, as well as the SQL editor, supports command completion.
So seeing a list of commands is as simple as typing / + Tab.
For example typing /help + Tab gives you this:
Command completion after typing /help and pressing Tab

Writing SQL

Writing SQL works the way you'd expect: just start typing, press Tab if you are stuck and code completion will help you finish writing it or ask Candela to help out. You will see functions, providers, their fields and parameters, and code completion shows the documentation for each.

You can run more than one SQL statement at a time by putting a \ on its own line between them.

SQL code completion suggesting providers, fields and parameters

Links to reference documentation are likewise available:

Code completion with a link to reference documentation

Reference documentation opened from code completion

You can always see what sort of SQL can follow beyond where your cursor lies ("code completion").

Code completion showing what SQL can follow the cursor (1 of 2)

Code completion showing what SQL can follow the cursor (2 of 2)

LumiCode shows progress as your query runs:
Progress shown while a query runs

And you can get the full log into the transcript with /feedback.

Multi-queries

A multi-query is a set of named queries that you write in the editor, where each query can read the results of the ones above it. LumiCode runs independent queries at the same time, and you can save the whole set, and all its results, in one go.

Running a multi-query in LumiCode

To write and run one, see How do I run several queries together as a multi-query?

Data rendered in tables, grouped tables and charts

LumiCode writes a summary of the results to the transcript:
Summary of query results in the transcript

Wherever you see data, if a provider (or a view you create!) supports links, LumiCode adds links that open other websites. This could open into LUSID, showing dialogs (Drive, LUSID-Instruments, Scheduler logs, Configuration Service entries, etc.) or any other site, such as Google Maps or your own internal systems.
Query results with links that open other websites

/rows

/rows lets you explore all rows, further filter, choose columns, sort, and show detail cards (a panel showing every field of one row).
Exploring rows with /rows (1 of 2)
Exploring rows with /rows (2 of 2)

/group

Lets you group by any number of columns, expand them, apply group-aggregations, etc.
Grouping results with /group

/chart

You can render the data as many types of chart, including into the transcript:
A chart drawn with /chart
/chart gallery will show you examples of the full set, here's a small sample:
Sample charts from /chart gallery

Using the built-in Candela AI

LumiCode natively uses Candela, FINBOURNE's AI agent. You can use it to ask about providers in your catalog, optimise queries, explain lineage of the data you are seeing and more.

Working with Candela AI in LumiCode (1 of 6)

Working with Candela AI in LumiCode (2 of 6)

Working with Candela AI in LumiCode (3 of 6)

Working with Candela AI in LumiCode (4 of 6)

Working with Candela AI in LumiCode (5 of 6)

Working with Candela AI in LumiCode (6 of 6)

Catalog browsing

/catalog gives you an interactive, searchable tree, including detail cards of providers/views, links to documentation, lineage, dependencies, uses of providers, etc.

Searchable provider tree in /catalog

Detail view

Catalog detail card for a provider (1 of 2)

Catalog detail card for a provider (2 of 2)

Lineage

You can see everything that depends on a provider / view:
Lineage: everything that depends on a provider or view
... and everything that a view depends on:
Lineage: everything a view depends on

View details

You can see many other view details, such as their definitions, the query that created them (so you can easily update them), etc.
View details in the catalog (1 of 2)
View details in the catalog (2 of 2)

History

Many forms of "user action history" are available in LumiCode.
You can query all of these through providers, but LumiCode also has simple commands with directed user interfaces to view this information. They all start with a time range first, so searches stay fast.

Query history

With /history you can search for queries with various SQL in them and limit to only failed ones. By default you see only your own queries. Users granted the GlobalMetadataVisibility activity on the Sys.Logs.HcQuery provider see queries from everyone in their domain (their organisation's LUSID environment).

Searching query history with /history

To get a past query back, or its results, see How do I find and re-run a past query? To have a query run by itself on a timetable, see How do I schedule a query from LumiCode?

API call history

With /api-history you can search for API calls for any FINBOURNE application in a given time range, limit to only failed ones (and filter by error message also). By default you see only your own calls; users granted the GlobalMetadataVisibility activity on the Lusid.Logs.AppRequest provider see calls from everyone in their domain.

Searching API call history with /api-history

Access check history

With /access-history you can search for access checks made by any application (or all of them). By default you see only your own access checks; users granted the Insights accesslogs-view-all permission see everyone's in their domain.

Searching access check history with /access-history

Failure diagnosis

/diagnose gathers everything the platform recorded about one query run into a single report: the provider call that actually failed, even inside a view, every execution and provider call with its timings, and the full feedback log. You can save the report as Markdown for FINBOURNE Support or an AI assistant.

Investigating a query run with /diagnose

To use it, see How do I diagnose a failed query?