GeezerVison

version: "2"
plugins:
  - name: py
    wasm:
      url: https://downloads.sqlc.dev/plugin/sqlc-gen-python_1.3.0.wasm
      sha256: fbedae96b5ecae2380a70fb5b925fd4bff58a6cfb1f3140375d098fbab7b3a3c
sql:
  - schema: "schema.sql"
    queries: "query.sql"
    engine: postgresql
    codegen:
      - out: src/authors
        plugin: py
        options:
          package: authors
          emit_sync_querier: true
          emit_async_querier: true

Option: emit_pydantic_models

By default, sqlc-gen-python will emit dataclasses for the models. If you prefer to use pydantic models, you can enable this option.

with emit_pydantic_models

from pydantic import BaseModel

class Author(pydantic.BaseModel):
    id: int
    name: str

without emit_pydantic_models

import dataclasses

@dataclasses.dataclass()
class Author:
    id: int
    name: str

Option: emit_str_enum

enum.StrEnum was introduce in Python 3.11.

enum.StrEnum is a subclass of str that is also a subclass of Enum. This allows for the use of Enum values as strings, compared to strings, or compared to other enum.StrEnum types.

This is convenient for type checking and validation, as well as for serialization and deserialization.

By default, sqlc-gen-python will emit (str, enum.Enum) for the enum classes. If you prefer to use enum.StrEnum, you can enable this option.

with emit_str_enum

class Status(enum.StrEnum):
    """Venues can be either open or closed"""
    OPEN = "op!en"
    CLOSED = "clo@sed"

without emit_str_enum (current behavior)

class Status(str, enum.Enum):
    """Venues can be either open or closed"""
    OPEN = "op!en"
    CLOSED = "clo@sed"

Option: domain_overrides

sqlc does not pass CREATE DOMAIN definitions (their base type or CHECK constraints) to code generation plugins, so columns using a domain are emitted as Any and a unknown PostgreSQL type warning is logged. The domain_overrides option lets you map a PostgreSQL type name to a fully-qualified Python type. The required import is added automatically, including for nested modules.

options:
  package: authors
  domain_overrides:
    job_status: my.module.JobStatus
    positive_int: decimal.Decimal

Given a domain job_status used by a status column, this generates:

import decimal

import my.module


@dataclasses.dataclass()
class Job:
    id: int
    status: my.module.JobStatus
    priority: Optional[decimal.Decimal]

The key is matched against the column's data type, its bare type name, and its schema-qualified name (e.g. public.job_status), so you can key the override however is most convenient. This also works for any other type sqlc reports as unknown, not just domains.