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. Overview
  3. Package Map

On this page

  1. Imported Directly
  2. Standalone Clients
  3. Internal packages

Package Map

Public vs. internal packages and how they relate.

LakeQL is a monorepo of focused packages. This page focuses on what an application touches directly. For how the packages depend on each other, see Package Architecture in the contributing section.

Imported Directly #

PackageRoleDocumented under
@lakeql/configLoad config, compose the runtimepackages/config
@lakeql/apiGraphQL server runtimeapi
@lakeql/adapter-trinoTrino adapterdata-sources/trino
@lakeql/adapter-fabricFabric adapterdata-sources/fabric
@lakeql/query-builderFilters, sorting, paging → SQLpackages/query-builder
@lakeql/cliIntrospection and generation (dev dependency)cli

Standalone Clients #

Used below the data-source abstraction, or on their own:

PackageRoleDocumented under
@lakeql/trino-clientTrino REST clientpackages/trino-client
@lakeql/fabric-clientFabric SQL clientpackages/fabric-client

Internal packages #

Most apps get these transitively through the preceding packages rather than installing them directly.

PackageRole
@lakeql/datasourceThe core contracts: data source, strategies, factories, auth, capabilities, and errors.
@lakeql/sql-read-strategyAdapter-neutral SQL read orchestration and validation.
@lakeql/response-transformerSchema-aware transformation of decoded records into typed objects.
@lakeql/schema-generatorGenerates endpoint and mutation schemas from parsed metadata.
@lakeql/file-generatorWrites the generated TypeScript endpoint and config files.
@lakeql/column-parserParses engine column type strings into structured type objects.
@lakeql/storageExternal-storage write pipeline, serializers, and table managers.
@lakeql/parquetParquet schema and serialization.
@lakeql/helpersShared low-level utilities.
@lakeql/loggerShared structured logging with field redaction.

@lakeql/datasource is the one internal package whose contracts you see in type signatures. Its reference lives under data-sources.

Previous page

Overview

Next page

query-builder