Merge pull request #8 from enveritas/feature/type-overrides

Support type overrides in addition to column overrides

Author: MerlinVeritas

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
         go-version: '1.23.5'
     - uses: sqlc-dev/setup-sqlc@v4
       with:
-        sqlc-version: '1.29.0'
+        sqlc-version: '1.30.0'
     - run: make
     - run: make test
     - run: sqlc diff

README.md

@@ -99,3 +99,51 @@ class Status(str, enum.Enum):
     OPEN = "op!en"
     CLOSED = "clo@sed"
 ```
+
+### Override Column Types
+
+Option: `overrides`
+
+You can override the SQL to Python type mapping for specific columns or database types using the `overrides` option. This is useful for columns with JSON data or other custom types.
+
+Example configuration:
+
+```yaml
+options:
+  package: authors
+  emit_pydantic_models: true
+  overrides:
+    - column: "some_table.payload"
+      py_import: "my_lib.models"
+      py_type: "Payload"
+    - db_type: "jsonb"
+      py_import: "my_lib.models"
+      py_type: "Payload"
+```
+
+This will:
+1. Override the column `payload` in `some_table` to use the type `Payload`
+2. Override any column with the database type `jsonb` to use the type `Payload`
+3. Add an import for `my_lib.models` to the models file
+
+Example output:
+
+```python
+# Code generated by sqlc. DO NOT EDIT.
+# versions:
+#   sqlc v1.30.0
+
+import datetime
+import pydantic
+from typing import Any
+
+import my_lib.models
+
+
+class SomeTable(pydantic.BaseModel):
+    id: int
+    created_at: datetime.datetime
+    payload: my_lib.models.Payload
+```
+
+This is similar to the [overrides functionality in the Go version of sqlc](https://docs.sqlc.dev/en/stable/howto/overrides.html#overriding-types).

examples/src/authors/models.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 import dataclasses
 from typing import Optional
 

examples/src/authors/query.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 # source: query.sql
 from typing import AsyncIterator, Iterator, Optional
 

examples/src/booktest/models.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 import dataclasses
 import datetime
 import enum

examples/src/booktest/query.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 # source: query.sql
 import dataclasses
 import datetime

examples/src/jets/models.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 import dataclasses
 
 

examples/src/jets/query-building.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 # source: query-building.sql
 from typing import AsyncIterator, Optional
 

examples/src/ondeck/city.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 # source: city.sql
 from typing import AsyncIterator, Optional
 

examples/src/ondeck/models.py

@@ -1,6 +1,6 @@
 # Code generated by sqlc. DO NOT EDIT.
 # versions:
-#   sqlc v1.29.0
+#   sqlc v1.30.0
 import dataclasses
 import datetime
 import enum