@bockit/sequel 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,228 @@
-# Temporary Holding Version
+# sequel
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+One CLI for a TypeScript app's Postgres data layer:
+
+- **Schema:** keep Prisma's schema language as the source of truth, as a folder of `.prisma` files.
+- **Migrations:** reviewable SQL that is safe to run in production. sequel generates it without prompts, lints it, and applies it with its own runner.
+- **Queries:** real SQL in `.sql` files, with typed TypeScript results, in the style of Kotlin's SQLDelight.
+
+Nothing from sequel runs in your app except the generated query code, which calls [`pg`](https://node-postgres.com). Your app drops the `prisma` and `@prisma/client` packages and every install hook.
+
+> **Status:** early development. Every command works, but sequel hasn't been adopted by an app yet, and commands and config may change before the first release. See [Status](#status).
+
+## Why
+
+Prisma is three tools sold as one: a schema language, migration tooling, and a query client. The schema language is good. In two production apps the other two caused most of a year's database incidents:
+
+- **The generated client** comes with a `postinstall` that can regenerate the wrong project's client. It is held in memory by long-lived workers, so they reject new enum values until restarted. It bakes in column defaults, and it selects every column it knows about, so dropping one before a restart breaks every insert.
+- **`migrate dev`** blocks without a terminal on any data-loss warning, and asks for resets that would wipe a dev database. It also keeps trying to drop what the schema language can't express: vector columns, collations, CHECKs, partial indexes, triggers and views.
+- **The query DSL** can't express row locks, `ON CONFLICT … GREATEST`, recursive CTEs, window functions, `DISTINCT ON`, vector search or advisory locks. So real queries end up as raw SQL with hand-written types.
+
+sequel keeps the schema language and replaces the other two:
+
+- **Migrations** are SQL you read and commit. The runner gives each file its own transaction and sets lock and statement timeouts.
+- **Queries** are SQL you write. sqlc and the database itself type them, including outer-join nullability, which tools that only ask Postgres to describe the query get wrong.
+
+## How it works
+
+```
+prisma/*.prisma ─(schema WASM: validate, format)
+   │
+   ├─(schema engine: diff)─► migrations/**/<ts>_<name>.sql ─(Squawk)─► sequel runner ─► Postgres
+   │                                                                            │
+<module>/queries/*.sql ─(sqlc + database analyzer, against the migrated test DB)─► sequel's generator ─► *.ts
+```
+
+sequel is built on:
+- Prisma's schema parser (vendored WASM);
+- Prisma's native schema engine;
+- [sqlc](https://sqlc.dev) with its database analyzer;
+- [Squawk](https://squawkhq.com).
+
+It fetches each tool as a pinned binary on first use and checks it against a sha256 recorded in sequel. Nothing downloads at install time.
+
+## Install
+
+Requirements:
+- Node 24 or newer;
+- Postgres (developed against 18);
+- `pg_dump` on `PATH`, at your server's major version or newer;
+- macOS on Apple silicon, Linux x64 or Linux arm64.
+
+```sh
+yarn add --dev @bockit/sequel
+yarn add pg
+yarn add --dev @types/pg
+```
+
+## Quick start
+
+**1. Configure** `sequel.config.ts` at your app's root (illustrative):
+
+```ts
+import { defineConfig } from '@bockit/sequel'
+
+export default defineConfig({
+  schema: 'prisma',
+  migrations: 'prisma/migrations',
+  queries: 'src/**/queries',
+  snapshot: 'prisma/snapshot.sql',
+  databases: {
+    target: process.env.DATABASE_URL,
+    test: process.env.TEST_DATABASE_URL,
+  },
+})
+```
+
+The schema's `datasource` block has no `url`: sequel supplies the connection.
+
+**2. Change the schema, then make a migration:**
+
+```sh
+sequel format
+sequel migrate new add_rate_limits
+# review and edit prisma/migrations/<timestamp>_add_rate_limits.sql
+sequel migrate deploy
+```
+
+**3. Write a query** next to the module that uses it, in `src/data/queries/rate-limits.sql`:
+
+```sql
+-- name: LatestSnapshots :many
+SELECT DISTINCT ON (account_id, bucket) *
+FROM rate_limit_snapshots
+WHERE account_id = @account_id
+ORDER BY account_id, bucket, hour_utc DESC;
+```
+
+**4. Generate, and use it:**
+
+```sh
+sequel generate        # writes src/data/queries/rate-limits.ts; commit it
+```
+
+```ts
+import { latestSnapshots } from './queries/rate-limits.ts'
+
+const rows = await latestSnapshots(pool, { accountId })
+// rows: { accountId: string; bucket: 'five_hour' | 'seven_day'; hourUtc: Date; … }[]
+```
+
+**5. Add `sequel check` to your test script and CI.**
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `sequel validate` | Check the schema folder, with Prisma's own error messages. |
+| `sequel format` | Format the schema folder. |
+| `sequel migrate new <name>` | Diff the migration history against the schema and write `<timestamp>_<name>.sql`. Never prompts, never resets, never touches your target database. Lints the result. |
+| `sequel migrate lint [file…]` | Lint migrations: Squawk's locking and data-loss rules, plus sequel's own. |
+| `sequel migrate adopt-prisma` | Rename Prisma's `<ts>_<name>/migration.sql` files to `<ts>_<name>.sql`, and create sequel's history from `_prisma_migrations` on the target database. Safe to rerun. |
+| `sequel migrate deploy [--allow-out-of-order]` | Apply pending migrations. |
+| `sequel generate [--watch]` | Migrate the test database, then turn every query file into a typed module beside it. |
+| `sequel extras` | Rewrite the snapshot of Postgres features the schema language can't express. |
+| `sequel check` | Fail on stale generated code, schema drift, lint findings or a stale extras snapshot. |
+
+Every command is non-interactive and exits non-zero with a message that names the fix.
+
+### Migrations you can run in production
+
+- **Files, not folders.** A migration is any `<timestamp>_<name>.sql` file under `migrations/`, in folders of any depth. The timestamp in the file name sets the order, so folders are only for organising.
+- **One transaction per file.** A failed file leaves nothing behind, and an enum value added in one file can be used in the next.
+- **`CREATE INDEX CONCURRENTLY`** goes alone in a file that starts with `-- sequel:no-transaction`.
+- **Every file runs with `lock_timeout` and `statement_timeout`** (5 s and 60 s by default). A file can raise them with its own `SET LOCAL`.
+- **One deploy at a time,** under an advisory lock.
+- **Refused before anything runs:**
+  - a changed file, since each applied file's sha256 is recorded;
+  - a deleted file;
+  - a pending file older than the newest applied one, unless `--allow-out-of-order` is given.
+- **No down migrations.** Expand, then contract: a column drop is two deploys. First stop using the column in your queries, with its field still in the schema. Then remove the field, in the same commit as the `DROP COLUMN` migration. Generated queries name every column they read, so a drop can't break code that no longer uses the column.
+- **Lint findings** can be silenced with Squawk's `-- squawk-ignore <rule> -- <reason>`, or with the reason on the line above.
+
+### Generated code
+
+- One function per query, taking any `pg` client: a `Pool`, a `PoolClient`, or a client inside your transaction.
+- Keys are camelCase, so the SQL needs no aliases.
+- Enums are string-literal unions.
+- Nullability follows the query, outer joins included.
+- Anything sequel can't map is `unknown`, never a guess.
+- `bigint` and `numeric` are strings, as `pg` returns them.
+- Output compiles under `verbatimModuleSyntax` and `erasableSyntaxOnly`.
+- Generated files are committed, so your build needs no database. Exclude them from your formatter.
+- **Don't cast a nullable expression:** sqlc treats every cast as never null ([sqlc #3710](https://github.com/sqlc-dev/sqlc/issues/3710)).
+
+### Postgres-only features
+
+Collations, CHECKs, partial and expression indexes, vector and trigram indexes, generated columns, triggers and views:
+- live in hand-written migration SQL, noted in a comment on their model;
+- appear in the committed extras snapshot, so a change to them shows in review.
+
+### Migrations managed by another tool
+
+If another tool manages your schema and migrations, set `externalMigrations: true`. sequel then only types your queries:
+
+```ts
+export default defineConfig({
+  externalMigrations: true,
+  queries: 'src/**/queries',
+  databases: { test: process.env.TEST_DATABASE_URL },
+})
+```
+
+- `generate` types queries against the test database as your other tool left it. It never migrates it, and that tool's history table there, such as `_prisma_migrations`, is fine. Migrate the test database with your tool first.
+- `check` checks only the generated modules: stale, missing or orphaned. It prints a line saying it skipped drift, lint, the extras snapshot and schema validation.
+- `generate --watch` watches only the query folders.
+- No schema folder or migrations are read, so `schema`, `migrations` and `snapshot` aren't needed, and are ignored if set. Only sqlc is fetched; `pg_dump` is still needed.
+- `validate`, `format`, `migrate …` and `extras` refuse, naming the setting.
+
+Remove the setting to have sequel manage the schema and migrations.
+
+## Adopting sequel in a Prisma app
+
+Move queries first, and decide about migrations last. Prisma keeps the schema, the migrations and `@prisma/client` while you port, and the app runs on both in the meantime.
+
+### Queries first
+
+1. Write `sequel.config.ts` with `externalMigrations: true` (see [above](#migrations-managed-by-another-tool)). The schema stays as it is, `url` included, and Prisma keeps migrating every database, the test database too.
+2. Move queries to `.sql` files module by module, porting modules that share a transaction together. Run `sequel generate`, and add `sequel check` to your test script and CI.
+3. Hand-written SQL now does what Prisma Client did for you:
+   - **`@updatedAt`:** Prisma Client sets it on every create and update, and the column has no database default. Set `updated_at = now()` in every `INSERT` and `UPDATE`.
+   - **`@default(cuid())` and `@default(uuid())`:** Prisma Client makes the id, and the column has no database default. Your app supplies it as a parameter.
+   - **A missing row:** Prisma's `update` and `delete` throw `P2025`. A `:one` query returns `null`, and an `:execrows` query returns `0`, so check for them.
+   - **Unique violations:** Prisma's `P2002` is now `pg`'s error with `code` `'23505'`.
+   - **Nested writes and `$transaction([...])`:** Prisma ran these in a transaction implicitly. Now take a client from the pool, run `BEGIN`, pass that client to every query in the transaction, and `COMMIT` (or `ROLLBACK` on error).
+4. When the last query is ported, remove `@prisma/client` and the schema's `generator` block. Prisma's CLI still runs the migrations.
+
+### Then migrations, if sequel is to run them
+
+1. Split `schema.prisma` into a folder, and remove `url` from the `datasource` block.
+2. In `sequel.config.ts`, remove `externalMigrations`, and set `schema`, `migrations`, `snapshot` and the target database. Set the lint cut-over to your newest existing migration.
+3. Run `sequel migrate adopt-prisma` and commit the renamed files. Their contents don't change, so their checksums still match.
+4. Run `sequel migrate adopt-prisma` once against every database: production, each developer's, and the test database. It creates sequel's history from `_prisma_migrations`, checking every checksum, and leaves that table untouched. Until then, `deploy` refuses that database.
+5. Run `sequel extras`, and commit the snapshot.
+6. Remove `prisma` and its install hooks.
+7. In VS Code's Prisma extension, which still formats and validates offline, turn off the "Generate" CodeLens and the Prisma Client file watcher.
+
+## Status
+
+The order of work:
+
+1. Repo skeleton: licence layout, vendored schema WASM, binary fetching. Done.
+2. The generator and its eight-query test suite, proved by porting real queries. Done.
+3. The runner, the schema-engine client, `migrate` and `check`. Done.
+4. Adopt sequel in a first app, module by module, then drop `@prisma/client`.
+5. A second app: split its schema into files, then the same steps.
+
+Other open work is tracked in [`to-do.md`](to-do.md).
+
+## Licence
+
+sequel is licensed under the [Apache License 2.0](LICENSE).
+
+It uses, without modification:
+- Prisma's schema WASM, vendored in `vendor/prisma-schema-wasm/` under Apache-2.0;
+- Prisma's schema engine (Apache-2.0), sqlc (MIT) and Squawk (Apache-2.0), fetched as pinned binaries and mirrored in this repository's releases;
+- `pg` (MIT), as an npm dependency.
+
+See [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).