Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/coming-from-drizzle-prisma.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@maple-dev/effect-orm": patch
---

A new guide, `docs/coming-from-drizzle-prisma.md`, maps the common Prisma and Drizzle operations to effect-orm, says what differs by design, and shows a Cloudflare Worker that reaches Postgres through Hyperdrive. Its examples run on PGlite in the doc checks.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Type-safe ClickHouse and Postgres queries, result decoding, and reproducible ben
Formerly `@maple-dev/effect-clickhouse`.

[Read the documentation](https://effect-clickhouse.maple.dev) ·
[Getting started](./docs/getting-started.md) · [Recipes](./docs/recipes.md)
[Getting started](./docs/getting-started.md) · [Recipes](./docs/recipes.md) · [Coming from Drizzle or Prisma](./docs/coming-from-drizzle-prisma.md)

- **Schema-first** — a column type _is_ an Effect `Schema`, so a query compiles
to its own row schema. `decodeRows` validates without you writing one, and the
Expand Down Expand Up @@ -210,6 +210,7 @@ Full guides live in [`docs/`](./docs/README.md):
| [Postgres](./docs/postgres.md) | The Postgres dialect, its column types and functions |
| [Schema and migrations](./docs/migrations.md) | DDL from `table`, `effect-orm generate`, applying migrations |
| [Extending the DSL](./docs/extending.md) | `defineFn`, raw escape hatches, handwritten SQL |
| [Coming from Drizzle or Prisma](./docs/coming-from-drizzle-prisma.md) | Their operations mapped to effect-orm, and a Worker on Hyperdrive |
| [API reference](./docs/reference.md) | Full export catalog by module, plus error types |

Named complete examples are extracted and checked by
Expand Down
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ executor own those responsibilities.
4. [Benchmark a change](./benchmarking.md) with a fixed workload and saved baseline.
5. Consult [Troubleshooting](./troubleshooting.md) if installation or results differ from expectations.

Coming from another ORM? [Coming from Drizzle or Prisma](./coming-from-drizzle-prisma.md) maps
their operations to effect-orm, with one checked program and a Cloudflare Worker sketch.

The named complete examples are extracted from Markdown, typechecked, and exercised by
[`check-doc-examples.mjs`](../scripts/check-doc-examples.mjs). Focused behavior tests also live in
[`src/docs-examples.test.ts`](../src/docs-examples.test.ts). Client execution requires a server;
Expand Down Expand Up @@ -65,6 +68,7 @@ Roughly in reading order.
| [Postgres](./postgres.md) | The Postgres dialect, its column types and functions |
| [Schema and migrations](./migrations.md) | DDL from `CH.table` / `PG.table`, `materializedView`, `effect-orm generate`, applying migrations, adopting drizzle-kit |
| [Statements and transactions](./database.md) | `Database` over your `SqlClient`: `run`, `execute`, `transaction`, retry |
| [Coming from Drizzle or Prisma](./coming-from-drizzle-prisma.md) | Their operations mapped to effect-orm, what differs by design, a Worker on Hyperdrive |

## Reference

Expand Down
Loading