LakeQL
Overview
  • Package Map
query-builder
  • Filtering
  • Sorting & Paging
  • API Reference
config
  • Runtime Config
  • API Reference
trino-client
  • Client Setup
  • Executing Queries
  • Streaming
  • Metadata
  • API Reference
fabric-client
  • Client Setup
  • Executing Queries
  • API Reference
GitHub
LakeQL
  1. Packages
  2. config

config

Load configuration and compose a runtime with @lakeql/config.

@lakeql/config is the composition layer. It loads your lakeql.config.ts, validates the data-source definitions against the registered adapters, and composes a runtime that owns the live data-source instances.

Install it:

pnpm add @lakeql/config

If you scaffolded with create-app, @lakeql/config is already installed.

Three functions span the lifecycle:

  • defineConfig — author the config file with full type inference.
  • loadConfig — load it and resolve it into a neutral project object. Per-source validation runs in defineConfig and the adapter factory, not here.
  • createLakeQLRuntime — compose the runtime from the loaded config, the adapter factories, and an auth resolver.

This section covers the runtime config contract and the full API reference.

Runtime Config

How configuration is loaded, validated, and composed into a runtime.

API Reference

Complete reference for the @lakeql/config public API.

Previous page

API Reference

Next page

Runtime Config