BUILDING Parts of this page describe what is not built yet, and each says so.
SQLSettings
A SQLSettings as RunningLake's configuration repository declares it, at sql/settings.yaml. Generated from the Go types the control plane decodes this file into, so it checks the shape the gate reads — field names and types, and which fields may exist. The gate also applies rules no schema can express — required fields inside spec among them — so a file this schema accepts can still be refused by `rl diff`. Take #/properties/spec for the spec alone.
Recorded, and not yet read. This file belongs to one project and is read from that project’s own
repository, at sql/settings.yaml. A push that shortens the warm time, or changes the engine, applies at the
next sync. A push that makes the warm time longer is not applied: the control plane keeps the warm time it had and
lists the change as held until an owner or an admin confirms it with a fresh confirmation. A warm time above your
organisation’s limit, and a file that cannot be read, are held and cannot be confirmed. A warm time left out
counts as 15 minutes.
What that does not do: the SQL window does not start on the engine named here yet, and nothing starts or stops an engine from the warm time, so the file changes no query today; and it cannot tell who pushed a change.
File: sql/settings.yaml
Fields
| Field | Type | Required | Meaning |
|---|---|---|---|
apiVersion |
string | Yes |
The config schema's version, which is independent of the HTTP API's (rule unsupported-api-version). Values: |
kind |
string | Yes |
The kind this file declares. A kind that disagrees with the file's path is refused (rule kind-mismatch). Values: |
metadata |
object | Yes |
No description
|
metadata. |
string | Yes |
The resource's name, which is also its path segment. It must be the name this file's path gives it (rule name-mismatch). |
metadata. |
map of string | No |
No description
|
metadata. |
map of string | No |
No description
|
spec |
object | No |
SQLSettingsSpec is a project's own choice for its SQL window: the engine it starts on, and how long that engine stays warm after the project's last query. |
spec. |
string | No |
DefaultEngine is the engine the SQL window starts on for this project, by name. The only engine is trino; DuckDB is not an engine ad-hoc SQL can be set to. Optional: left out, the project chooses nothing and keeps the engine the platform pins. A change of engine takes effect at the next sync. |
spec. |
integer | No |
WarmMinutes is how long, in whole minutes from 1 to 1440, the engine stays warm after the project's last query. Optional: left out, it is 15 minutes (or your organisation's limit when that is lower). A longer warm time is held until an owner or admin confirms it; a shorter one applies at the next sync. |
A nested field is written with its parents, spec.a.b; an item of a list is
[] and a value of a map is *. Required means the
parent object must carry the field; the rules a schema cannot express, such as a field that
is required only inside spec, are checked by rl diff.
The schema
This page is read from the kind’s published schema, at
https://runninglake.com/schema/v1alpha1/sqlsettings.json. An editor that follows it checks a file of this kind as you
type. To see the fields of a kind’s spec from the command line, run rl schema
with the kind’s name: it works offline and prints what the gate accepts. The
command reference has the rest.