Post-Creation Steps

What to do after scaffolding a new LakeQL project.

After Scaffolding #

Once @lakeql/create-app finishes, follow these steps to get your API running.

npm run cli pull --catalog hive --schema myschema

This creates:

src/schemas/generated/hive/myschema/<table>/config.ts — Table metadata
src/schemas/generated/hive/myschema/<table>/interface.ts — TypeScript interface
src/schemas/generated/hive/myschema/<table>/query-schema.ts — GraphQL query schema
src/schemas/generated/hive/myschema/<table>/mutation-schema.ts — GraphQL mutation schema
src/schemas/generated/hive/myschema/<table>/json-schema.json — Response schema
src/schemas/generated/hive/myschema/<table>/endpoint.json — Endpoint definition
src/config-registry.ts — Aggregated config index

To pull multiple tables at once, pass --table multiple times:

npm run cli pull --catalog hive --schema sales --table orders --table customers
--table products

npm run dev

You should see:

1
2
3
* Server URL: http://localhost:4000/
* GraphQL Endpoint: http://localhost:4000/graphql

As you add tables to your lakehouse, pull them into the project:

npm run cli pull --catalog hive --schema new_schema

Set up user-level read/write permissions for production. See Authentication.

Issue	Solution
`pull` fails with connection error	Verify `HIVE_HOST` and `HIVE_PORT` in `.env`. Check Trino is running.
Server starts but no queries available	Run `pnpm cli pull` first. Check that `schemaPath` points to the correct directory.
Auth errors in GraphiQL	Set `AUTH_MOCK=true` and include the `Authorization` header matching `AUTH_MOCK_TOKEN`.
Generated types have wrong fields	Re-run `pull` to sync with current Trino table structure.

You should see:

1
2
3
* Server URL: http://localhost:4000/
* GraphQL Endpoint: http://localhost:4000/graphql

As you add tables to your lakehouse, pull them into the project:

npm run cli pull --catalog hive --schema new_schema

Set up user-level read/write permissions for production. See Authentication.

Issue	Solution
`pull` fails with connection error	Verify `HIVE_HOST` and `HIVE_PORT` in `.env`. Check Trino is running.
Server starts but no queries available	Run `pnpm cli pull` first. Check that `schemaPath` points to the correct directory.
Auth errors in GraphiQL	Set `AUTH_MOCK=true` and include the `Authorization` header matching `AUTH_MOCK_TOKEN`.
Generated types have wrong fields	Re-run `pull` to sync with current Trino table structure.