jade-sql 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82ae87a5571e7ef32804036dd347134fc11bcf20a66ebabe7562ac898f943262
-  data.tar.gz: c81268fa4accc4f8bb8f945a8ba164a64ac0ca629d554c9d99874ecb4fb697d5
+  metadata.gz: 75f58977c75363b33bfd885e9059624c732f81b14ed764e8fc8f6ffc70842209
+  data.tar.gz: 94ab9ce7fcc86ce8ac9e6868ffa8b0a7284af351baa1c1785db74921de419c56
 SHA512:
-  metadata.gz: c1cbadd648ec547bcd888c79504d40b630b7e808f0ef0b1e0f379d8b581816d1c3110112fbed3b597dae9987270b13082e68b0561a6ea5bfec2637e7fc81bc4d
-  data.tar.gz: 2864083ceebdd23042ddcd31a3c81d2446b1533b5a7ba8614565138899de6d8fea76bb6a485a8781d16315174cf1856f989890664157bb371ab56cfae2a4e63f
+  metadata.gz: 3ea0a83ac2633a0096e848e0cf774f003772d6f1f166f72a525ba831d47b6ad2ef36b13d993004e551db9a18a3b43c99b004a04daf86fefe0bcaca689ab72014
+  data.tar.gz: 3cf14a376b2195bca477c521820982e785b5669cab11ec3401e2f11ca03cbeeb6da5abe3489c58db198acf181d5dc0bf6c0014454b21f804923e18cfc74f2eb6

data/README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/agustinrhcp/jade-sql/actions/workflows/ci.yml/badge.svg)](https://github.com/agustinrhcp/jade-sql/actions/workflows/ci.yml)
 
-Type-safe SQL for Jade. Builds queries and mutations from a generated
+Type-safe SQL for Jade. Builds queries and writes from a generated
 schema, renders them to `(String, List(Value))`, and runs them against
 ActiveRecord via a Task port that auto-decodes rows into typed Jade
 structs.
@@ -24,22 +24,28 @@ To execute queries at runtime, opt into the AR-backed task port:
 require 'jade-sql/runtime'
 ```
 
-To get the rake task for schema generation:
+To get the rake tasks for schema generation:
 
 ```ruby
 # Rakefile (or lib/tasks/jade.rake)
 load Gem.find_files('jade-sql/tasks.rake').first
 ```
 
+`rake jade:schema` writes the schema; `rake jade:schema:check` fails when the
+checked-in one no longer matches `db/structure.sql`, which is what a migration
+merged without regenerating looks like. Both are also `jade-sql schema` and
+`jade-sql schema --check`.
+
 ## At a glance
 
 Generate a typed schema from `db/structure.sql`, then build a query against
-it. The result is a `Q` you render with `to_sql` or run with `fetch_*`; rows
+it. The result is a `Query` you render with `to_sql` or run with `fetch_*`; rows
 decode straight into your struct.
 
 ```jade
-import Sql exposing (Selector, eq, to_expr)
-import Sql.Query exposing (Q, field, from, join, select, where)
+import Sql exposing (Selector, eq)
+import Sql.Expr as Expr
+import Sql.Query exposing (Query, field, from, join, select, where)
 import Schema exposing (patients, appointments)
 
 struct Visit = {
@@ -47,14 +53,14 @@ struct Visit = {
   reason: String
 }
 
-def scheduled_visits -> Q(Selector(Visit))
+def scheduled_visits -> Select(Visit)
   p <- from(patients)
-  a <- join(appointments, (a) -> { p.id |> eq(a.patient_id) })
+  a <- join(appointments, (a) -> { p.id |> Expr.eq(a.patient_id) })
 
   select(Visit(_, _))
     |> field(p.name)
     |> field(a.reason)
-    |> where(a.status |> eq(to_expr("scheduled")))
+    |> where(a.status |> eq("scheduled"))
 end
 ```
 
@@ -65,6 +71,6 @@ that decodes each row into `Visit`.
 
 - [Building SQL](docs/building.md) — generate a schema, build queries
   (joins, sorting/grouping, pagination, aggregates, arrays, JSONB) and
-  mutations (insert/update/delete, RETURNING, timestamps, UUIDs).
-- [Running queries and mutations](docs/running.md) — `fetch_*` / `execute`,
+  writes (insert/update/delete, RETURNING, timestamps, UUIDs).
+- [Running queries and writes](docs/running.md) — `fetch_*` / `execute`,
   transactions, and testing without a database.