@wneng/create-keel 0.3.6 → 0.4.0

package/src/templates/db-python-alembic-postgres/files/alembic.ini

@@ -0,0 +1,45 @@
+; Alembic configuration for <%= it.options.projectName %>-server (PostgreSQL).
+;
+; Connection string is read from DATABASE_URL at runtime (see env.py).
+
+[alembic]
+script_location = db/migrations
+prepend_sys_path = .
+version_path_separator = os
+sqlalchemy.url =
+
+output_encoding = utf-8
+
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %Y-%m-%d %H:%M:%S

package/src/templates/db-python-alembic-postgres/files/db-README.md

@@ -0,0 +1,70 @@
+# server/db/
+
+数据库迁移、种子数据、本地数据库工具的入口。
+
+> 跨项目的数据库归属规则（哪类 SQL 放哪个目录、与 `contracts/` 如何对齐）见 [`docs/governance/database.md`](../../docs/governance/database.md)。
+
+## 工具与版本
+
+| 项 | 值 |
+|---|---|
+| 数据库 | PostgreSQL 14+ |
+| 迁移工具 | [Alembic](https://alembic.sqlalchemy.org) `1.13.3` |
+| ORM | SQLAlchemy `2.0.36` |
+| 驱动 | `psycopg[binary]` `3.2.3`（psycopg v3） |
+
+工具版本在 `pyproject.toml` 钉死，并镜像到 `docs/03-工程规范与研发基础设施/tech-stack-server.md`。
+
+## 目录布局
+
+```
+server/
+├── pyproject.toml
+├── alembic.ini
+└── db/
+    ├── README.md
+    └── migrations/
+        ├── env.py
+        ├── script.py.mako
+        └── versions/
+            └── <NNNN>_<description>.py
+```
+
+## 常用命令
+
+```bash
+alembic revision -m "create orders table"             # 新建迁移
+alembic revision --autogenerate -m "..."              # 配合 SQLAlchemy 模型
+alembic upgrade head                                  # 升到最新
+alembic downgrade -1                                  # 回滚一版
+alembic current                                       # 查看当前版本
+```
+
+环境变量 `DATABASE_URL`（默认 `postgresql+psycopg://postgres:@127.0.0.1:5432/<project>_dev`）。
+
+## prod vs dev seeds
+
+| 类型 | 位置 |
+|---|---|
+| 生产字典（必装） | 写进 `versions/` 的 revision 中（ON CONFLICT DO NOTHING） |
+| 开发样例 | `server/db/seeds/dev/` 下手动执行 |
+
+字典类生产种子真值在 `contracts/dictionaries/enums.yaml`；当前手动同步。
+
+## 改动分级（参见 `docs/governance/change-tiers.md`）
+
+| 改动 | Tier |
+|---|---|
+| 新建 revision 加表 / 加字段 | 3 |
+| 修改既有 revision | **不允许** |
+| 删字段 / 改类型（破坏性） | 4 |
+| 改 dev seed | 1/2 |
+| 改字典数据 | 3（同步 contracts/dictionaries/） |
+| 升级 Alembic / SQLAlchemy / psycopg | 2，但同步改 tech-stack-server.md |
+
+## CI 行为
+
+```bash
+alembic upgrade head
+alembic downgrade base
+```

package/src/templates/db-python-alembic-postgres/files/env.py

@@ -0,0 +1,62 @@
+"""Alembic environment for PostgreSQL (psycopg v3).
+
+Reads DATABASE_URL from env (or falls back to a localhost Postgres DSN);
+imports the application's SQLAlchemy metadata for autogenerate support.
+
+Edit `target_metadata` to point at your app's Base.metadata once you
+introduce ORM models.
+"""
+
+import os
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+config = context.config
+
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+config.set_main_option(
+    "sqlalchemy.url",
+    os.environ.get(
+        "DATABASE_URL",
+        "postgresql+psycopg://postgres:@127.0.0.1:5432/" + "<%= it.options.projectName.replace(/-/g, '_') %>" + "_dev",
+    ),
+)
+
+target_metadata = None
+
+
+def run_migrations_offline() -> None:
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

package/src/templates/db-python-alembic-postgres/files/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "<%= it.options.projectName %>-server"
+version = "0.1.0"
+requires-python = ">=3.11"
+dependencies = [
+  "fastapi==0.115.5",
+  "uvicorn[standard]==0.32.0",
+  "pydantic==2.9.2",
+  "pydantic-settings==2.6.1",
+  "alembic==1.13.3",
+  "sqlalchemy==2.0.36",
+  "psycopg[binary]==3.2.3",
+]
+
+[project.optional-dependencies]
+dev = [
+  "ruff>=0.6.8",
+  "mypy>=1.11.0",
+  "pytest>=8.3.0",
+  "pytest-asyncio>=0.24.0",
+  "httpx>=0.27.0",
+  "pip-audit>=2.7.0",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["generated", ".venv", "db/migrations/versions"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "N"]
+ignore = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"
+
+[tool.mypy]
+python_version = "3.11"
+strict_optional = true
+disallow_untyped_defs = true
+warn_unused_ignores = true
+exclude = ["generated", ".venv", "db/migrations/versions"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.setuptools.packages.find]
+include = ["app*"]
+exclude = ["tests*", "generated*", "db*"]

package/src/templates/db-python-alembic-postgres/files/script.py.mako

@@ -0,0 +1,25 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

package/src/templates/db-python-alembic-postgres/fragment.yaml

@@ -0,0 +1,25 @@
+name: db-python-alembic-postgres
+version: 1.0.0
+appliesWhen:
+  backend: python
+  database: postgres
+priority: 40
+files:
+  - from: files/pyproject.toml
+    to: server/pyproject.toml
+    render: true
+  - from: files/alembic.ini
+    to: server/alembic.ini
+    render: true
+  - from: files/env.py
+    to: server/db/migrations/env.py
+    render: false
+  - from: files/script.py.mako
+    to: server/db/migrations/script.py.mako
+    render: false
+  - from: files/0001_init.py
+    to: server/db/migrations/versions/0001_init.py
+    render: false
+  - from: files/db-README.md
+    to: server/db/README.md
+    render: true

package/src/templates/db-python-elasticsearch/files/apply_templates.py

@@ -0,0 +1,55 @@
+"""Idempotent Elasticsearch index-template applier (Python backend).
+
+ES 没有事务性 DDL；"migration" 退化为把 db/index-templates/*.json 全部 PUT 一次。
+ES 自身保证 PUT 同名 template 的幂等性。
+
+改动 tier（参见 docs/governance/change-tiers.md）：
+  - 新增 template 文件：Tier 3
+  - 修改既有 template 的 mapping 字段：Tier 4（破坏性 - 可能 reindex）
+  - 仅改 priority / 新增 alias：Tier 2
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import sys
+from pathlib import Path
+
+from elasticsearch import Elasticsearch
+
+TEMPLATE_DIR = Path(__file__).parent / "index-templates"
+
+
+def main() -> None:
+    url = os.environ.get("ELASTICSEARCH_URL", "http://127.0.0.1:9200")
+    username = os.environ.get("ELASTICSEARCH_USERNAME")
+    password = os.environ.get("ELASTICSEARCH_PASSWORD")
+
+    kwargs: dict[str, object] = {"hosts": [url]}
+    if username and password:
+        kwargs["basic_auth"] = (username, password)
+
+    client = Elasticsearch(**kwargs)
+    client.cluster.health(wait_for_status="yellow", timeout="30s")
+
+    files = sorted(p for p in TEMPLATE_DIR.glob("*.json"))
+    if not files:
+        print(f"no index templates found in {TEMPLATE_DIR}")
+        return
+
+    for path in files:
+        body = json.loads(path.read_text(encoding="utf-8"))
+        name = path.stem  # filename minus .json
+        client.indices.put_index_template(name=name, body=body)
+        print(f"✓ applied {name}")
+
+    print(f"done; {len(files)} template(s) applied to {url}")
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as e:  # noqa: BLE001
+        print(f"✗ failed: {e}", file=sys.stderr)
+        sys.exit(1)

package/src/templates/db-python-elasticsearch/files/db-README.md

@@ -0,0 +1,57 @@
+# server/db/
+
+Elasticsearch index-template 入口（Python 后端）。
+
+> 跨项目的数据库归属规则见 [`docs/governance/database.md`](../../docs/governance/database.md)。
+
+## "Migration" 的语义
+
+**Elasticsearch 没有事务性 DDL，本目录里的 JSON 不是迁移文件。**
+
+每个 `db/index-templates/*.json` 是一个 [Index Template v2](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html)。`apply_templates.py` 按文件名字典序遍历目录，对每个文件 PUT；ES 自身保证幂等。
+
+## 工具与版本
+
+| 项 | 值 |
+|---|---|
+| Elasticsearch | 8.15+ |
+| Python 客户端 | `elasticsearch` `8.15.1` |
+
+## 目录布局
+
+```
+server/
+├── pyproject.toml
+└── db/
+    ├── README.md
+    ├── apply_templates.py            # 幂等 applier
+    └── index-templates/
+        └── <utc-ts>_<description>.json
+```
+
+## 常用命令
+
+```bash
+python -m server.db.apply_templates
+# 或
+python server/db/apply_templates.py
+```
+
+环境变量 `ELASTICSEARCH_URL`（默认 `http://127.0.0.1:9200`）、`ELASTICSEARCH_USERNAME` / `ELASTICSEARCH_PASSWORD`（可选）。
+
+## 改动分级（参见 `docs/governance/change-tiers.md`）
+
+| 改动 | Tier |
+|---|---|
+| 新增 template 文件 | 3 |
+| 修改既有 template 的 mapping 字段 | 4（破坏性 - 可能 reindex） |
+| 仅改 priority / 新增 alias / 改 settings.refresh_interval | 2 |
+| 删除 template | 4 |
+
+## 与 `contracts/asyncapi/` 的同步
+
+事件 ingest 的 schema 真值在 `contracts/asyncapi/asyncapi.yaml`；index-template 的 mapping 应当与之**对齐**。当前手动同步。
+
+## CI 行为
+
+CI 起一个 ES 8 service container；脚本失败 = CI 红。

package/src/templates/db-python-elasticsearch/files/index-template-init.json

@@ -0,0 +1,25 @@
+{
+  "index_patterns": ["events-*"],
+  "priority": 100,
+  "template": {
+    "settings": {
+      "number_of_shards": 1,
+      "number_of_replicas": 1,
+      "refresh_interval": "5s"
+    },
+    "mappings": {
+      "properties": {
+        "@timestamp": { "type": "date" },
+        "tenant_id":  { "type": "keyword" },
+        "event_type": { "type": "keyword" },
+        "user_id":    { "type": "keyword" },
+        "payload":    { "type": "object", "dynamic": true },
+        "trace_id":   { "type": "keyword" }
+      }
+    }
+  },
+  "_meta": {
+    "description": "Sample event-stream template. Replace mappings with your domain fields.",
+    "managed_by": "@wneng/create-keel"
+  }
+}

package/src/templates/db-python-elasticsearch/files/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "<%= it.options.projectName %>-server"
+version = "0.1.0"
+requires-python = ">=3.11"
+dependencies = [
+  "fastapi==0.115.5",
+  "uvicorn[standard]==0.32.0",
+  "pydantic==2.9.2",
+  "pydantic-settings==2.6.1",
+  "elasticsearch==8.15.1",
+]
+
+[project.optional-dependencies]
+dev = [
+  "ruff>=0.6.8",
+  "mypy>=1.11.0",
+  "pytest>=8.3.0",
+  "pytest-asyncio>=0.24.0",
+  "httpx>=0.27.0",
+  "pip-audit>=2.7.0",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["generated", ".venv"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "N"]
+ignore = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "lf"
+
+[tool.mypy]
+python_version = "3.11"
+strict_optional = true
+disallow_untyped_defs = true
+warn_unused_ignores = true
+exclude = ["generated", ".venv"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.setuptools.packages.find]
+include = ["app*"]
+exclude = ["tests*", "generated*", "db*"]

package/src/templates/db-python-elasticsearch/fragment.yaml

@@ -0,0 +1,19 @@
+name: db-python-elasticsearch
+version: 1.0.0
+appliesWhen:
+  backend: python
+  database: elasticsearch
+priority: 40
+files:
+  - from: files/pyproject.toml
+    to: server/pyproject.toml
+    render: true
+  - from: files/apply_templates.py
+    to: server/db/apply_templates.py
+    render: false
+  - from: files/index-template-init.json
+    to: server/db/index-templates/20260101000000_init.json
+    render: false
+  - from: files/db-README.md
+    to: server/db/README.md
+    render: true

package/src/templates/docs-skeleton/files/governance-database.md

@@ -0,0 +1,150 @@
+---
+last-reviewed: 2026-05-16
+---
+
+# 数据库治理
+
+> 本文件统一回答："SQL / 索引 / 迁移 / 种子数据放哪个目录、与 `contracts/` 如何对齐"。
+>
+> 工具与命令的细节（哪个项目用 Knex / Flyway / Alembic / golang-migrate / ES applier）见各项目的 `server/db/README.md`，本文件不重复。
+>
+> 工具决策与 mongodb / sqlite 排除理由见 [`../02-系统方案与架构/adr-0005-database-conventions.md`](../02-系统方案与架构/adr-0005-database-conventions.md)。
+
+## 1. 五类 SQL 文件的归属
+
+数据库相关的产物分五类，每类只有一个合法位置：
+
+| 类型 | 例子 | 归属 | 与契约关系 |
+|---|---|---|---|
+| **schema migration**（DDL，版本化） | `V1__create_users.sql` / `0001_init.py` / `000001_init.up.sql` | `server/db/migrations/`（Java 走 `src/main/resources/db/migration/`） | 与 `contracts/openapi/` 中的字段对齐 |
+| **生产种子数据**（字典 / 码表） | 角色码表、状态枚举、错误码 lookup | `server/db/seeds/prod/`（Knex）/ 写入迁移文件（Flyway / Alembic / golang-migrate） | **真值在 `contracts/dictionaries/`**；当前手动同步 |
+| **开发种子数据**（fixture） | 样例用户、demo 商品、调试数据 | `server/db/seeds/dev/` | 与契约无关；不进生产 |
+| **存储过程 / 函数 / 视图 / 触发器** | `usp_calculate_amount.sql`、物化视图 | `server/db/procedures/` | 写入迁移文件，与代码同等对待 |
+| **运维脚本**（一次性） | 数据回填、重建索引、清理过期数据 | `scripts/db/<date>-<topic>.sql` | 与契约无关；不进生产迁移历史 |
+| **报表 / 分析 query**（BI 看板） | 仪表板背后的 SQL、临时调研 query | `docs/09-数据与埋点/`（启用 data 角色） | 与契约无关；与数据资产对齐 |
+
+> Elasticsearch 的"migration"指**幂等的 index-template apply**，不在上述 RDBMS 表里；其归属规则：JSON template 在 `server/db/index-templates/`（Java 走 `src/main/resources/index-templates/`），applier 脚本在 `server/db/`。详见各项目 `server/db/README.md`。
+
+## 2. 三类特殊场景
+
+### 2.1 跨 service 共享同一个 DB（微服务但 DB 没拆）
+
+DB schema 升格为契约：
+
+```
+contracts/schemas/db/
+├── README.md              # 谁是 schema 拥有者（"owner service"）
+├── ddl/                   # 真值；其他 service 视为 read-only
+│   ├── core_tables.sql
+│   └── views.sql
+└── CHANGELOG.md           # 改 schema 必须 bump SemVer
+server/apps/owner/db/migrations/   # 唯一执行迁移的 service
+server/apps/consumer/db/             # 不存 DDL，只存 ORM 映射
+```
+
+只有 owner service 的 PR 能改 `contracts/schemas/db/ddl/`；consumer service 改 → CI 拒（按 contracts/ 现有规则）。
+
+### 2.2 多租户 schema-per-tenant
+
+```
+server/db/migrations/
+├── shared/                # 公共 schema（账户、租户元数据）
+└── tenant/                # 应用到每个租户 schema 的迁移
+```
+
+文档说清楚"新租户 onboarding 要跑哪些 migrations"。
+
+### 2.3 多 database per service
+
+例如：postgres 主库 + elasticsearch 用作搜索。
+
+- 选第二个 fragment：手动从对应 `db-<backend>-<other>` 复制配置
+- 在 `server/db/README.md` 里说明双库各管什么
+- CI 起两个 service container
+
+scaffolder 0.4.0 不自动支持双库；用户合并两个 fragment 的内容。
+
+## 3. 与 `contracts/` 的同步规则
+
+### 3.1 字典数据 → 生产种子
+
+`contracts/dictionaries/enums.yaml` 是字典（角色 / 错误码 / 状态枚举）的真值。改字典的 PR 必须**同步**：
+
+- 加字典项 → 同 PR 在迁移文件中加 INSERT IGNORE / ON CONFLICT DO NOTHING
+- 改字典项的 name / description → 写新迁移更新对应行（不要改既有迁移）
+- 删字典项 → Tier 4，需 ADR
+
+> 当前是**手动同步**。自动派生（codegen）留给后续 `contract-derived-seeds` 特性。
+
+### 3.2 OpenAPI 字段 → DB 列
+
+OpenAPI 中的实体字段与 DB 表的列**应当**对齐（同名、同类型映射）。手动维护；governance-lint 不强制（语义 diff 太复杂）。
+
+### 3.3 AsyncAPI 事件 → ES index template
+
+`contracts/asyncapi/asyncapi.yaml` 中的事件 schema 与 `server/db/index-templates/` 中的 mapping **应当**对齐。当前手动同步。
+
+## 4. 改动分级（参见 `change-tiers.md`）
+
+| 改动 | Tier | 备注 |
+|---|---|---|
+| 新增 migration 加表 / 加字段 | 3 | 同 PR 改 `contracts/CHANGELOG.md`（如果字段进契约） |
+| 修改既有 migration 文件 | **不允许** | 写新 migration 代替；Flyway / Alembic / golang-migrate 都拒绝 |
+| 删字段 / 改类型（破坏性） | 4 | ADR + 详细设计 + 数据迁移预案 |
+| 改 dev seed | 1/2 | 不需要同步契约 |
+| 改 prod seed（字典数据） | 3 | 同 PR 改 `contracts/dictionaries/` |
+| 改 ES index-template 的 mapping | 4 | 破坏性 - 可能需要 reindex |
+| 改 ES index-template 的 priority / settings | 2 | 局部行为调整 |
+| 升级 Knex / Flyway / Alembic / golang-migrate / ES SDK | 2 | 同 PR 改 `tech-stack-server.md` 钉版本 |
+
+## 5. CI 行为
+
+每个 (backend, database) 组合的 CI 都跑 **migrate up + migrate down** smoke test：
+
+- RDBMS：`db-migrate-smoke` job 起 service container，跑 `npm run db:migrate && npm run db:rollback`（或对应工具命令）
+- ES：`db-es-template-apply` job 起 ES service container，跑 applier 脚本一次
+
+CI **不**校验：
+- schema 内容（用 DBA tool）
+- 与 `contracts/` 字段对齐（语义 diff 太复杂）
+- 数据回填脚本的正确性（一次性脚本不进 CI）
+
+## 6. 目录布局速查（非 multi-app 模式）
+
+```
+server/
+├── db/
+│   ├── README.md                      # 工具与命令（按 backend 不同）
+│   ├── migrations/                    # Knex / Alembic / golang-migrate 路径
+│   │   └── <ts/N>_<description>.<ext>
+│   ├── index-templates/               # ES applier 模式
+│   │   └── <ts>_<description>.json
+│   ├── seeds/
+│   │   ├── prod/                      # 字典数据；与 contracts/dictionaries 对齐
+│   │   └── dev/                       # 仅本地 / 测试
+│   └── apply-templates.{cjs,py,go}    # ES applier（按 backend）
+├── src/main/resources/db/migration/   # ← Java + Flyway 的迁移路径（与 server/db/ 分离）
+└── src/main/resources/index-templates/ # ← Java + ES applier 的 template 路径
+
+contracts/
+├── dictionaries/enums.yaml            # 字典真值（→ prod seed 派生）
+├── openapi/api.yaml                   # API 字段（→ DB 列对齐）
+└── asyncapi/asyncapi.yaml             # 事件 schema（→ ES mapping 对齐）
+
+scripts/db/                            # 一次性运维（数据回填等）
+└── 2026-05-backfill-tenants.sql
+
+ops/db/                                # DB 实例 / 权限 / 备份（IaC）
+└── grants/
+```
+
+## 7. multi-app 模式
+
+每个 `server/apps/<app>/` 自己一份 `db/`。共享 schema 时（多 app 同 DB）schema 真值进 `contracts/schemas/db/`，由 owner app 唯一执行迁移。完整规则与示例见 §2.1。
+
+## 8. 不在本特性范围内的（推到下次 spec）
+
+- mongodb 支持（详见 ADR-0005）
+- sqlite 支持（详见 ADR-0005）
+- contracts/dictionaries → seed migration 自动派生
+- web/mobile/miniapp 本地数据库（IndexedDB / SQLite / Realm）

package/src/templates/docs-skeleton/fragment.yaml

@@ -117,6 +117,9 @@ files:
   - from: files/governance-change-tiers.md
     to: docs/governance/change-tiers.md
     render: false
+  - from: files/governance-database.md
+    to: docs/governance/database.md
+    render: false
   - from: files/governance-checklists.md
     to: docs/governance/checklists.md
     render: true