@tetsujs/sql

@tetsujs/sql puts Postgres behind an application on Tetsu. SQL migrations are the schema, the types are generated from the database they build, and queries are Kysely’s, or SQL files typed by Postgres itself. It has a section of its own: Database.

bun add @tetsujs/sql kysely

It needs Bun 1.4.4 or later and Postgres 14 or later. kysely is a peer dependency, 0.29.6 or a later 0.29.

Usage

import { database, verifySchema } from "@tetsujs/sql";
import { schema } from "./db.generated";

export const 
const db: Kysely<DB>
db = database(schema, { 
url: string
A postgres:// URL of the database: the server, the user and the
database it names are the ones used. The database is given apart from
the URL as well, since Bun 1.4.4 would take PGDATABASE over it.
url: 
const config: {
    DATABASE_URL: string;
}
config.
type DATABASE_URL: string
DATABASE_URL });

await verifySchema(
const db: Kysely<DB>
db, schema);

const 
const paid: {
    id: bigint;
    total: string;
    placed_at: Date;
}[]
paid = await 
const db: Kysely<DB>
db
  .selectFrom("orders")
  .select(["id", "total", "placed_at"])
  .where("status", "=", "paid")
  .execute();

src/db.generated.ts is what tetsu-sql types:generate writes from the migrations: Overview walks from the first migration to a route, and Types from the database says what each column becomes.

The command line

tetsu-sql runs the package’s functions from package.json scripts, with the database in DATABASE_URL or --url:

command	what it does
`migrations:new <name>`	creates an empty migration, named with the current UTC time
`migrations:run`	applies the pending migrations: Migrations
`migrations:baseline <migration>`	records the migrations up to this one as applied, without running them, in a database built before them: Adopting a database
`types:generate`	writes the types of the database the migrations build, and the functions of the query files; `--check` writes nothing and fails when the files are out of date, and `--int8 string` reads an `int8` as a string: Types from the database

Exports

database, with DatabaseOptions.
migrate, with MigrateOptions, MigrateResult and MigrationRecord; baseline, with BaselineOptions, BaselineResult and BaselineRecord; MigrationError, with MigrationErrorReason.
verifySchema.
atomic.
isViolation, with ConstraintName and Constraints, which the generated files add the names of their constraints to.
queryRows and queryCount, with FileQuery: what the functions of query files call.
Schema, the type of a generated schema.
From @tetsujs/sql/generate: generate, with GenerateOptions, QueriesOptions and GeneratedFiles; createMigration, with CreateMigrationOptions; and QueryFileError.
From @tetsujs/sql/testing: testDatabase, with TestDatabaseOptions and TestDatabase.