LakeQL
Introduction
  • Overview
  • Why LakeQL
  • Key Concepts
Getting Started
  • Prerequisites
  • Quickstart
  • Environment
  • First Run
Architecture
  • System Overview
  • Data Flow
  • Request Lifecycle
Configuration
  • Config File
  • Runtime Lifecycle
  • Environment Variables
create-app
  • Usage
  • Template Structure
  • Post-Creation
Guides
  • Custom Resolvers
  • Extending the Schema
  • Mutations
  • Set Up a Trino Mutation
  • Deploying
Endpoints
  • Definition Format
  • Field Types
  • Nested Fields
  • Mutations
  • Glossary
Contributing
  • Local Development
  • Contribution Guide
  • Architecture
GitHub
LakeQL
  1. LakeQL
  2. Guides
  3. Deploying

On this page

  1. Build and Generated Files
  2. Environment
  3. Lifecycle
  4. Observability
  5. Containers

Deploying

Run a LakeQL server in production.

A LakeQL project is an ordinary Node application, so it deploys like any Node service. A few things are worth getting right for production.

Build and Generated Files #

The generated endpoint files under your source path are part of your source. Commit them, and regenerate with pull when a table changes. Build the project with its build script before deploying.

Environment #

Provide the connection variables through your platform's environment or secrets manager, not a committed .env. Validate them at startup so a misconfiguration fails fast. See environment variables.

Lifecycle #

The application owns the runtime. Wire runtime.close() to SIGTERM/SIGINT so connections drain cleanly on shutdown, as shown in server setup. The server exposes a health check at /live for readiness and liveness probes. The path is configurable.

Observability #

LakeQL logs every execution error server-side. It also offers an onError hook to forward errors to your telemetry (OpenTelemetry, Sentry, metrics). The hook keeps the framework decoupled from any provider.

Containers #

The project builds into a standard Node container image. Set the environment at runtime, expose the server port (default 4000), and run the built entry point.

Previous page

Set Up a Trino Mutation

Next page

Endpoints