# llms full

Complete LLM-oriented tree for all documentation collections.

## lakeql

- [LakeQL](/docs/lakeql): Type-safe GraphQL APIs over Trino — overview, setup, and guides. (raw: /raw/lakeql.md)
  - [Introduction](/docs/lakeql/introduction): Learn what LakeQL is, the concepts behind it, and how its packages fit together. (raw: /raw/lakeql/introduction.md)
    - [Overview](/docs/lakeql/introduction/overview): LakeQL is a toolkit for generating type-safe GraphQL APIs on top of Trino data lakehouses. (raw: /raw/lakeql/introduction/overview.md)
    - [Key Concepts](/docs/lakeql/introduction/key-concepts): Core concepts behind LakeQL — data lakehouses, GraphQL-over-Trino, schema introspection, and code generation. (raw: /raw/lakeql/introduction/key-concepts.md)
    - [Package Map](/docs/lakeql/introduction/package-map): All packages in the LakeQL monorepo and how they relate to each other. (raw: /raw/lakeql/introduction/package-map.md)
  - [Getting Started](/docs/lakeql/getting-started): Set up your environment, scaffold a new project, and run your first GraphQL query over Trino. (raw: /raw/lakeql/getting-started.md)
    - [Prerequisites](/docs/lakeql/getting-started/prerequisites): System requirements and dependencies needed to run LakeQL. (raw: /raw/lakeql/getting-started/prerequisites.md)
    - [Quickstart](/docs/lakeql/getting-started/quickstart): Scaffold a new LakeQL project and run your first GraphQL query in under 5 minutes. (raw: /raw/lakeql/getting-started/quickstart.md)
    - [Environment Configuration](/docs/lakeql/getting-started/environment-configuration): Complete reference for all environment variables used by LakeQL packages. (raw: /raw/lakeql/getting-started/environment-configuration.md)
    - [First Run](/docs/lakeql/getting-started/first-run): Walk through pulling your first schema, understanding the generated files, and executing a GraphQL query. (raw: /raw/lakeql/getting-started/first-run.md)
  - [Architecture](/docs/lakeql/architecture): Understand how LakeQL's packages connect and how data flows from Trino to your GraphQL API. (raw: /raw/lakeql/architecture.md)
    - [System Overview](/docs/lakeql/architecture/system-overview): Package dependency diagram and the two main operational flows in LakeQL. (raw: /raw/lakeql/architecture/system-overview.md)
    - [Data Flow](/docs/lakeql/architecture/data-flow): How LakeQL's CLI pipeline transforms Trino metadata into generated TypeScript files. (raw: /raw/lakeql/architecture/data-flow.md)
    - [Request Lifecycle](/docs/lakeql/architecture/request-lifecycle): How a GraphQL request flows through LakeQL's API runtime, from HTTP to Trino and back. (raw: /raw/lakeql/architecture/request-lifecycle.md)
  - [Configuration](/docs/lakeql/configuration): Reference for all environment variables, authentication settings, and Trino connection options. (raw: /raw/lakeql/configuration.md)
    - [Environment Variables](/docs/lakeql/configuration/environment-variables): Complete reference for all environment variables used across LakeQL packages. (raw: /raw/lakeql/configuration/environment-variables.md)
    - [Authentication](/docs/lakeql/configuration/authentication): Configure JWT authentication, mock auth for development, and custom user resolvers. (raw: /raw/lakeql/configuration/authentication.md)
    - [Trino Connection](/docs/lakeql/configuration/trino-connection): Configure the Trino connection including authentication, host settings, and catalog defaults. (raw: /raw/lakeql/configuration/trino-connection.md)
  - [create-app](/docs/lakeql/create-app): Scaffold a new LakeQL project with `@lakeql/create-app`. (raw: /raw/lakeql/create-app.md)
    - [Usage](/docs/lakeql/create-app/usage): How to use `@lakeql/create-app` to scaffold a new project. (raw: /raw/lakeql/create-app/usage.md)
    - [Template Structure](/docs/lakeql/create-app/template-structure): Understand the project layout created by `@lakeql/create-app`. (raw: /raw/lakeql/create-app/template-structure.md)
    - [Post Creation](/docs/lakeql/create-app/post-creation): What to do after scaffolding a new LakeQL project. (raw: /raw/lakeql/create-app/post-creation.md)
  - [Contributing](/docs/lakeql/contributing): How to set up a local development environment and contribute to LakeQL. (raw: /raw/lakeql/contributing.md)
    - [Local Development](/docs/lakeql/contributing/local-development): Set up a local Trino/MinIO environment with test data for LakeQL development. (raw: /raw/lakeql/contributing/local-development.md)
    - [Contribution Guide](/docs/lakeql/contributing/contribution-guide): Guidelines for contributing to the LakeQL project. (raw: /raw/lakeql/contributing/contribution-guide.md)
  - [Guides](/docs/lakeql/guides): Practical guides for common tasks like adding custom resolvers, extending schemas, and deploying to production. (raw: /raw/lakeql/guides.md)
    - [Custom Resolvers](/docs/lakeql/guides/custom-resolvers): Add custom queries and mutations beyond the generated schema. (raw: /raw/lakeql/guides/custom-resolvers.md)
    - [Extending Schema](/docs/lakeql/guides/extending-schema): Extend generated GraphQL types with additional fields, custom comparison operators, and computed values. (raw: /raw/lakeql/guides/extending-schema.md)
    - [Deploying](/docs/lakeql/guides/deploying): Build and deploy a LakeQL API to production with Docker, Compose, and environment variable management. (raw: /raw/lakeql/guides/deploying.md)
    - [Mutations](/docs/lakeql/guides/mutations): Enable write operations with the mutation pipeline, configure load strategies, and use system user impersonation. (raw: /raw/lakeql/guides/mutations.md)
    - [Load Strategies](/docs/lakeql/guides/load-strategies): Understand the three load strategies (full_load, full_load_append, append) and when to use each for your mutation pipeline. (raw: /raw/lakeql/guides/load-strategies.md)

## cli

- [CLI](/docs/cli): Schema introspection and code generation CLI. (raw: /raw/cli.md)
  - [Overview](/docs/cli/overview): Introduction to the LakeQL CLI, its purpose, and installation options. (raw: /raw/cli/overview.md)
    - [Installation](/docs/cli/overview/installation): How to install and run the LakeQL CLI for schema introspection and code generation. (raw: /raw/cli/overview/installation.md)
  - [Commands](/docs/cli/commands): Reference for all available CLI commands with syntax, options, and usage examples. (raw: /raw/cli/commands.md)
    - [init](/docs/cli/commands/init): Initialize a lakeql.config.json configuration file in your project. (raw: /raw/cli/commands/init.md)
    - [pull](/docs/cli/commands/pull): Interactive query endpoint generation based on a remote table. (raw: /raw/cli/commands/pull.md)
    - [create-registry](/docs/cli/commands/create-registry): Generates the config registry for type-safe permissions. (raw: /raw/cli/commands/create-registry.md)
    - [list-schemas](/docs/cli/commands/list-schemas): Lists available schemas for the configured catalog. (raw: /raw/cli/commands/list-schemas.md)
    - [list-tables](/docs/cli/commands/list-tables): Lists available tables for the configured catalog and schema. (raw: /raw/cli/commands/list-tables.md)
    - [list-views](/docs/cli/commands/list-views): Lists available views for the configured catalog and schema. (raw: /raw/cli/commands/list-views.md)
    - [list-columns](/docs/cli/commands/list-columns): Lists columns for the specified table including types and descriptions. (raw: /raw/cli/commands/list-columns.md)
    - [create-endpoint](/docs/cli/commands/create-endpoint): Generate a custom endpoint from a JSON definition file. (raw: /raw/cli/commands/create-endpoint.md)
    - [generate-import-config](/docs/cli/commands/generate-import-config): Generate an import.config.mjs from already-pulled schemas. (raw: /raw/cli/commands/generate-import-config.md)
  - [Configuration](/docs/cli/configuration): Environment variables and configuration file reference for the LakeQL CLI. (raw: /raw/cli/configuration.md)
    - [Environment Variables](/docs/cli/configuration/environment-variables): All environment variables used by the LakeQL CLI for Trino connectivity. (raw: /raw/cli/configuration/environment-variables.md)
    - [Config File](/docs/cli/configuration/config-file): Reference for the lakeql config file. (raw: /raw/cli/configuration/config-file.md)

## api

- [API](/docs/api): GraphQL API server with Hono, Yoga, and Pothos. (raw: /raw/api.md)
  - [Overview](/docs/api/overview): Introduction to the @lakeql/api package and its role in the LakeQL ecosystem. (raw: /raw/api/overview.md)
    - [Introduction](/docs/api/overview/introduction): What @lakeql/api provides and how it fits into the LakeQL ecosystem. (raw: /raw/api/overview/introduction.md)
  - [Server Setup](/docs/api/server-setup): Create and configure the LakeQL API server with defineConfig, createApiServer, and startApiServer. (raw: /raw/api/server-setup.md)
    - [createApiServer](/docs/api/server-setup/create-api-server): Create a configured Hono application with GraphQL Yoga integration, CORS, and logging middleware. (raw: /raw/api/server-setup/create-api-server.md)
    - [defineConfig](/docs/api/server-setup/define-config): Type-safe configuration wrapper that provides createYogaServer and startServer methods. (raw: /raw/api/server-setup/define-config.md)
    - [Yoga Configuration](/docs/api/server-setup/yoga-configuration): Customize GraphQL Yoga options like GraphiQL, error masking, logging, and landing page. (raw: /raw/api/server-setup/yoga-configuration.md)
  - [Authentication](/docs/api/authentication): JWT-based authentication, permission management, and scope-based authorization. (raw: /raw/api/authentication.md)
    - [JWT Authentication](/docs/api/authentication/jwt-authentication): Configure user authentication via JWT tokens or mock authentication for development. (raw: /raw/api/authentication/jwt-authentication.md)
    - [Permissions](/docs/api/authentication/permissions): Define table-level permission rules for technical users via the Permission interface. (raw: /raw/api/authentication/permissions.md)
    - [Scope Authorization](/docs/api/authentication/scope-authorization): Three authorization scopes control access to GraphQL fields — authorized, readPermission, and writePermission. (raw: /raw/api/authentication/scope-authorization.md)
  - [Schema Builder](/docs/api/schema-builder): Pothos schema builder configuration including scalars, comparison types, pagination, and validation. (raw: /raw/api/schema-builder.md)
    - [Builder Configuration](/docs/api/schema-builder/builder-configuration): Pothos SchemaBuilder setup with scope auth, validation plugins, and the GraphQL context type. (raw: /raw/api/schema-builder/builder-configuration.md)
    - [Scalar Types](/docs/api/schema-builder/scalar-types): Custom GraphQL scalar types for Date, DateTime, and File uploads. (raw: /raw/api/schema-builder/scalar-types.md)
    - [Comparison Types](/docs/api/schema-builder/comparison-types): Pre-built GraphQL input types for filtering queries with typed comparison operators. (raw: /raw/api/schema-builder/comparison-types.md)
    - [Pagination](/docs/api/schema-builder/pagination): Built-in page-based pagination with Paging input, PageInfo output, and ConnectionInterface. (raw: /raw/api/schema-builder/pagination.md)
    - [Input Validation](/docs/api/schema-builder/input-validation): Validate GraphQL input fields using Zod schemas via the Pothos ValidationPlugin. (raw: /raw/api/schema-builder/input-validation.md)
  - [Customization](/docs/api/customization): Extend the generated GraphQL API with custom queries, mutations, types, and middleware. (raw: /raw/api/customization.md)
    - [Custom Queries & Mutations](/docs/api/customization/custom-queries-mutations): Add custom query and mutation endpoints using the CLI endpoint builder. (raw: /raw/api/customization/custom-queries-mutations.md)
    - [Extending Core](/docs/api/customization/extending-core): Provide custom resolvers for authentication, permissions, and add additional scalars. (raw: /raw/api/customization/extending-core.md)
    - [CORS Configuration](/docs/api/customization/cors-configuration): Customize CORS settings and add additional Hono middleware to the API server. (raw: /raw/api/customization/cors-configuration.md)

## adapters

- [Adapters](/docs/adapters): Storage adapters for the LakeQL write pipeline — Parquet generation, S3/MinIO uploads, and Hive table management. (raw: /raw/adapters.md)
  - [Overview](/docs/adapters/overview) (raw: /raw/adapters/overview.md)
    - [Introduction](/docs/adapters/overview/introduction): Overview of the @lakeql/adapters package and how it powers the mutation write pipeline. (raw: /raw/adapters/overview/introduction.md)
    - [Hive Table Manager](/docs/adapters/overview/hive-table-manager): How the write pipeline manages Hive external tables in Trino. (raw: /raw/adapters/overview/hive-table-manager.md)
  - [Write Pipeline](/docs/adapters/write-pipeline) (raw: /raw/adapters/write-pipeline.md)
    - [executeWritePipeline](/docs/adapters/write-pipeline/execute-write-pipeline): The main entry point for persisting mutation data through the write pipeline. (raw: /raw/adapters/write-pipeline/execute-write-pipeline.md)
    - [Load Strategies](/docs/adapters/write-pipeline/load-strategies): How full_load, full_load_append, and append strategies control data storage and table management. (raw: /raw/adapters/write-pipeline/load-strategies.md)
    - [Partitioning](/docs/adapters/write-pipeline/partitioning): How data is partitioned into Hive-style paths within the all.parquet/ directory. (raw: /raw/adapters/write-pipeline/partitioning.md)
  - [Storage](/docs/adapters/storage) (raw: /raw/adapters/storage.md)
    - [Storage Operations](/docs/adapters/storage/storage-operations): Low-level S3/MinIO storage operations for uploading and managing Parquet files. (raw: /raw/adapters/storage/storage-operations.md)
  - [API Reference](/docs/adapters/api-reference): Auto-generated reference for all exported types, interfaces, and functions from @lakeql/adapters. (raw: /raw/adapters/api-reference.md)

## query-builder

- [Query Builder](/docs/query-builder): Translates GraphQL queries into Trino SQL. (raw: /raw/query-builder.md)
  - [Overview](/docs/query-builder/overview): High-level overview of the LakeQL query builder package and its role in the system. (raw: /raw/query-builder/overview.md)
    - [Introduction](/docs/query-builder/overview/introduction): Learn how the query builder uses Kysely to generate Trino-compatible SQL from GraphQL queries. (raw: /raw/query-builder/overview/introduction.md)
  - [Filtering](/docs/query-builder/filtering): How the query builder translates GraphQL filter inputs into SQL WHERE clauses. (raw: /raw/query-builder/filtering.md)
    - [Where Interface](/docs/query-builder/filtering/where-interface): The recursive type structure that represents filter conditions. (raw: /raw/query-builder/filtering/where-interface.md)
    - [Operators](/docs/query-builder/filtering/operators): All supported filter operators and their SQL translations. (raw: /raw/query-builder/filtering/operators.md)
    - [Combining Filters](/docs/query-builder/filtering/combining-filters): How AND/OR logic works and how filters are normalized before query compilation. (raw: /raw/query-builder/filtering/combining-filters.md)
  - [Sorting and Paging](/docs/query-builder/sorting-and-paging): How the query builder applies ORDER BY and Trino-specific FETCH/OFFSET pagination. (raw: /raw/query-builder/sorting-and-paging.md)
    - [Sorting](/docs/query-builder/sorting-and-paging/sorting): Multi-field sorting with configurable direction for query results. (raw: /raw/query-builder/sorting-and-paging/sorting.md)
    - [Paging](/docs/query-builder/sorting-and-paging/paging): Trino-specific pagination using FETCH FIRST/NEXT and OFFSET. (raw: /raw/query-builder/sorting-and-paging/paging.md)
  - [API Reference](/docs/query-builder/api-reference): Auto-generated reference for all exported types, interfaces, and functions from @lakeql/query-builder. (raw: /raw/query-builder/api-reference.md)

## trino-client

- [Trino Client](/docs/trino-client): HTTP client for Trino's REST API. (raw: /raw/trino-client.md)
  - [Overview](/docs/trino-client/overview): High-level overview of the LakeQL Trino client and its capabilities. (raw: /raw/trino-client/overview.md)
    - [Introduction](/docs/trino-client/overview/introduction): An HTTP client for executing queries and inspecting metadata on Trino clusters. (raw: /raw/trino-client/overview/introduction.md)
  - [Configuration](/docs/trino-client/configuration): How to configure and instantiate the Trino client. (raw: /raw/trino-client/configuration.md)
    - [Client Setup](/docs/trino-client/configuration/client-setup): Configuration options and authentication for the Trino client. (raw: /raw/trino-client/configuration/client-setup.md)
  - [Queries](/docs/trino-client/queries): Executing SQL queries against Trino with full pagination or streaming. (raw: /raw/trino-client/queries.md)
    - [Executing Queries](/docs/trino-client/queries/executing-queries): Run SQL statements against Trino and collect all result pages into a single array. (raw: /raw/trino-client/queries/executing-queries.md)
    - [Streaming](/docs/trino-client/queries/streaming): Stream query results row-by-row using an async generator for memory-efficient processing. (raw: /raw/trino-client/queries/streaming.md)
  - [Metadata](/docs/trino-client/metadata): Inspecting Trino catalog metadata — schemas, tables, views, and columns. (raw: /raw/trino-client/metadata.md)
    - [Inspecting Catalogs](/docs/trino-client/metadata/inspecting-catalogs): List schemas, tables, views, and columns from any Trino catalog. (raw: /raw/trino-client/metadata/inspecting-catalogs.md)
  - [API Reference](/docs/trino-client/api-reference): Auto-generated reference for all exported types, interfaces, and functions from @lakeql/trino-client. (raw: /raw/trino-client/api-reference.md)