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

Getting Started

Scaffold a project, configure it, and make your first request.

Go from nothing to a running GraphQL API: check the prerequisites, scaffold a project in the quickstart, configure the environment, and make your first request.

If you already know the pieces, the short version is: scaffold with create-app, point lakeql.config.ts at your data source, generate an endpoint with pull, and start the server.

Prerequisites

What you need before starting with LakeQL.

Quickstart

Scaffold a LakeQL project and get it running.

Environment

Point your project at a data source through the environment.

First Run

Generate an endpoint, start the server, and run a query.

Previous page

Key Concepts

Next page

Prerequisites