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. Getting Started
  3. Quickstart

On this page

  1. The Generated Project
  2. Next Steps

Quickstart

Scaffold a LakeQL project and get it running.

The scaffolding tool is the fastest way to a working project. It creates the config, the server entry point, and the project structure for you.

pnpm create @lakeql/app my-api

It prompts for the adapters, data source names, and authentication strategy, then generates the project. See create-app for the full list of options and what you get.

The Generated Project #

.env.exampleCopy to .env and fill in
lakeql.config.tsAdapters and data sources

Next Steps #

Configure the environment

Fill in your data source connection details. See environment configuration.

Generate an endpoint

Introspect a table and generate its typed files with pull.

Start the server

Run the server and make your first request.

Previous page

Prerequisites

Next page

Environment