Named queries

Named .eel files are the usual way apps consume Eelgrass Lang (sqlc-like). Inline templates are an escape hatch.

use schema "../demo_schema.eel"

query ListUsers() {
  users |> select { id, name, email, active, balance, status }
}

query GetPaid(min_balance: Money<usd>) {
  users
  |> filter status == .paid && balance >= ${min_balance}
  |> select { name, balance }
}

Declared params bind ${name} holes in the body. Types are checked against the schema registry (including use schema paths relative to the queries file).

Config

examples/eelgrass.config.json:

{
  "schemas": ["demo_schema.eel"],
  "queries": ["queries/**/*.eel"],
  "outDir": "generated"
}

Codegen

# from clients/typescript after npm run build
node bin/eelgrass-codegen.mjs --config ../../examples/eelgrass.config.json

Or, once on your PATH:

eelgrass-codegen --config eelgrass.config.json

Emits typed TypeScript functions that return EelgrassQuery<TRows> values for an EelgrassExecutor to run. See TypeScript client.

import { GetPaid } from "./generated/users.queries";
import { Money } from "@eelgrass/client";

const rows = await exec.execute(
  GetPaid({ min_balance: Money.minor(5000n, "USD") }),
);

CLI typecheck

eelgrass typecheck-queries examples/demo_schema.eel examples/queries/users.eel

Or via cargo:

cargo run -p eelgrass-cli -- typecheck-queries examples/demo_schema.eel examples/queries/users.eel

Transport reality

EelgrassExecutor is the contract. A shipping HTTP/IPC driver is not in @eelgrass/client yet. See Status. Today you drive the engine via eelgrass run / Studio / wasm, or implement EelgrassExecutor against eelgrass serve's /query for experiments.

Example layout

Path	Role
examples/demo_schema.eel	Schema
examples/queries/users.eel	Named queries
examples/eelgrass.config.json	Codegen config