configure-sqrl

Update the configuration of a DataSQRL project by editing its *-package.json files or creating new ones. Read Configuration Files first (how the files are split and layered), then look up the key you need under Configuration Content.

The configuration supports environment placeholders in the configuration fields that process them. Read Environment Variables before adding credentials or tokens: the normal and secret forms have different compile-time behavior, and support is not universal across every configuration field.

Configuration Files

Base Config and Environment Overlays

For projects that need multiple deployment profiles, split configuration into a base (shared) and thin per-environment overlays to reduce duplication. This is a recommended project convention: SQRL accepts any ordered list of package JSON files and has no special meaning for the filenames or environment names.

• <project>-shared-package.json is the base config file that includes common settings to every environment which could be version, enabled-engines, script.main, script.api, and the engines/compiler settings.
• <project>-<env>-package.json (one per environment -test, -prod, -local, -dev) — add or overwrite ONLY what differs from the base configuration file (e.g. script.config.environment, test-runner, an engine override). Note that -dev is a local development environment, like -local.

Example for the base config and environment overlays: The lending360 project with a test and a production environment:

lending360-shared-package.json — the base: everything both environments share.

{
  "version": "1",
  "enabled-engines": ["flink", "postgres", "kafka", "vertx"],
  "script": {
    "main": "lending360.sqrl",
    "api": {
      "v1": {
        "schema": "lending360-api/schema.v1.graphqls",
        "operations": ["lending360-api/operations.v1.graphql"]
      }
    }
  },
  "engines": {
    "flink": {
      "config": {
        "execution.runtime-mode": "STREAMING",
        "table.exec.source.idle-timeout": "30 s"
      }
    }
  },
  "compiler": {
    "api": { "protocols": ["GRAPHQL", "REST", "MCP"], "endpoints": "FULL" }
  }
}