LakeQL
  • Overview
Server Setup
  • Create Server
  • Define Config
  • Yoga Configuration
  • createLakeQLApp
Authentication
  • Authorization Model
  • JWT Authentication
  • Permissions
  • Scope Authorization
  • Trino User Impersonation
  • Debugging Identity
Schema Builder
  • Builder Configuration
  • Scalar Types
  • Comparison Types
  • Pagination
  • Input Validation
Customization
  • Custom Queries & Mutations
  • Extending Core
  • CORS Configuration
  • Error Handling
  • API Reference
GitHub
LakeQL
  1. API
  2. Overview

Overview

What @lakeql/api provides and how it fits into a project.

@lakeql/api is the GraphQL server layer. It composes a schema from your generated endpoint files, authenticates and authorizes requests, runs the resulting queries through the runtime, and serves the result over HTTP. It does not own the runtime or the data sources. The application composes those with @lakeql/config and passes the runtime in.

The package publishes subpath exports rather than a single root. You import each piece from its module:

1
2
3
4
import { defineApiConfig } from "@lakeql/api/config"
import { createApiResolveAuth } from "@lakeql/api/resolve-auth"
import { trinoUserImpersonation } from "@lakeql/api/trino-user-impersonation"

This section covers:

Server Setup

Compose and start the LakeQL GraphQL server.

Authentication

Validate tokens, resolve identity, enforce permissions, and impersonate users.

Schema Builder

How the GraphQL schema is generated — scalars, comparisons, pagination, validation.

Customization

Custom queries and mutations, extending core, CORS, and error handling.

The full surface is in the API reference. Each export lives under the subpath matching its source module.

Next page

API Reference