Prompt file imported from h-urena/copilot-agentic-standards (.github/prompts/scaffolds/database.prompt.md). Copyright stays with the author.

Scaffold Database Setup

Name: database
Author: h-urena

Constraint: Do not write any code until all required fields in Step 0 are confirmed.

0. REQUIREMENTS_SCHEMA

1. ENV_VAR_SCHEMA

Variable	Required	Description
`DATABASE_URL`	Yes	Full connection string
`DATABASE_POOL_SIZE`	Yes (production)	Explicit pool size
`DATABASE_POOL_TIMEOUT`	Yes (production)	Timeout in seconds

Constraint: Connection string from environment variables only — never hardcoded. SSL/TLS required for remote connections. Validate at startup; fail fast if unreachable.

2. BASE_MODEL_FIELDS

Field	Type	Rule
`id`	UUID	Preferred over auto-increment for distributed systems
`created_at`	Timestamp	Set on insert; never updated
`updated_at`	Timestamp	Updated on every write
`deleted_at`	Nullable Timestamp	Soft delete only

3. MIGRATION_RULES

Rule	Constraint
Versioned	Files in version control — never manual DB edits
Idempotent	Safe to run twice
Reversible	Down migration required
Destructive	Two-step: (1) stop reading column → (2) drop column
Shared env	Never modify a migration already applied to staging/prod

4. LAYER_STRUCTURE

Layer	Responsibility
Repository	Data access only — no business logic
Service	Orchestrates repositories; owns business rules
Health check	Verify DB connectivity at `/health`

FORBIDDEN

Pattern	Reason
Hardcoded connection string	Credential exposure
No pool size config	Relies on defaults; starves production under load
Manual DB edits	Untracked schema drift
In-memory DB for integration tests	Different semantics; masks real bugs
Modifying applied migrations	Breaks reproducibility
Business logic in repository	Violates separation of concerns

# Scaffold Database Setup **Constraint:** Do not write any code until all required fields in Step 0 are confirmed. ## 0. REQUIREMENTS_SCHEMA <schema> Engine: [PostgreSQL | SQL Server | MySQL | MongoDB | SQLite] ORM: [Prisma | Drizzle | TypeORM | SQLAlchemy | Django ORM | Tortoise | EF Core] Migrations: [Built-in ORM | Alembic | Flyway | dbmate] Pooling: [Required for production: PgBouncer | built-in ORM pool | none] Tenancy: [Single DB | Schema-per-tenant | DB-per-tenant] </schema> ## 1. ENV_VAR_SCHEMA | Variable | Required | Description | |---|---|---| | `DATABASE_URL` | Yes | Full connection string | | `DATABASE_POOL_SIZE` | Yes (production) | Explicit pool size | | `DATABASE_POOL_TIMEOUT` | Yes (production) | Timeout in seconds | **Constraint:** Connection string from environment variables only — never hardcoded. SSL/TLS required for remote connections. Validate at startup; fail fast if unreachable. ## 2. BASE_MODEL_FIELDS | Field | Type | Rule | |---|---|---| | `id` | UUID | Preferred over auto-increment for distributed systems | | `created_at` | Timestamp | Set on insert; never updated | | `updated_at` | Timestamp | Updated on every write | | `deleted_at` | Nullable Timestamp | Soft delete only | ## 3. MIGRATION_RULES | Rule | Constraint | |---|---| | Versioned | Files in version control — never manual DB edits | | Idempotent | Safe to run twice | | Reversible | Down migration required | | Destructive | Two-step: (1) stop reading column → (2) drop column | | Shared env | Never modify a migration already applied to staging/prod | ## 4. LAYER_STRUCTURE | Layer | Responsibility | |---|---| | Repository | Data access only — no business logic | | Service | Orchestrates repositories; owns business rules | | Health check | Verify DB connectivity at `/health` | ## FORBIDDEN | Pattern | Reason | |---|---| | Hardcoded connection string | Credential exposure | | No pool size config | Relies on defaults; starves production under load | | Manual DB edits | Untracked schema drift | | In-memory DB for integration tests | Different semantics; masks real bugs | | Modifying applied migrations | Breaks reproducibility | | Business logic in repository | Violates separation of concerns |

{ "prompt": "# Scaffold Database Setup\n\n**Constraint:** Do not write any code until all required fields in Step 0 are confirmed.\n\n## 0. REQUIREMENTS_SCHEMA\n\n<schema>\nEngine: [PostgreSQL | SQL Server | MySQL | MongoDB | SQLite]\nORM: [Prisma | Drizzle | TypeORM | SQLAlchemy | Django ORM | Tortoise | EF Core]\nMigrations: [Built-in ORM | Alembic | Flyway | dbmate]\nPooling: [Required for production: PgBouncer | built-in ORM pool | none]\nTenancy: [Single DB | Schema-per-tenant | DB-per-tenant]\n</schema>\n\n## 1. ENV_VAR_SCHEMA\n\n| Variable | Required | Description |\n|---|---|---|\n| `DATABASE_URL` | Yes | Full connection string |\n| `DATABASE_POOL_SIZE` | Yes (production) | Explicit pool size |\n| `DATABASE_POOL_TIMEOUT` | Yes (production) | Timeout in seconds |\n\n**Constraint:** Connection string from environment variables only — never hardcoded. SSL/TLS required for remote connections. Validate at startup; fail fast if unreachable.\n\n## 2. BASE_MODEL_FIELDS\n\n| Field | Type | Rule |\n|---|---|---|\n| `id` | UUID | Preferred over auto-increment for distributed systems |\n| `created_at` | Timestamp | Set on insert; never updated |\n| `updated_at` | Timestamp | Updated on every write |\n| `deleted_at` | Nullable Timestamp | Soft delete only |\n\n## 3. MIGRATION_RULES\n\n| Rule | Constraint |\n|---|---|\n| Versioned | Files in version control — never manual DB edits |\n| Idempotent | Safe to run twice |\n| Reversible | Down migration required |\n| Destructive | Two-step: (1) stop reading column → (2) drop column |\n| Shared env | Never modify a migration already applied to staging/prod |\n\n## 4. LAYER_STRUCTURE\n\n| Layer | Responsibility |\n|---|---|\n| Repository | Data access only — no business logic |\n| Service | Orchestrates repositories; owns business rules |\n| Health check | Verify DB connectivity at `/health` |\n\n## FORBIDDEN\n\n| Pattern | Reason |\n|---|---|\n| Hardcoded connection string | Credential exposure |\n| No pool size config | Relies on defaults; starves production under load |\n| Manual DB edits | Untracked schema drift |\n| In-memory DB for integration tests | Different semantics; masks real bugs |\n| Modifying applied migrations | Breaks reproducibility |\n| Business logic in repository | Violates separation of concerns |", "variables": [], "notes": "Scaffold database setup: connection, ORM, migrations, repository pattern, health check.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/h-urena/copilot-agentic-standards", "path": ".github/prompts/scaffolds/database.prompt.md", "ref": "41a8bce9e513c5755786049c88d5ee9562b05562", "url": "https://github.com/h-urena/copilot-agentic-standards/blob/41a8bce9e513c5755786049c88d5ee9562b05562/.github/prompts/scaffolds/database.prompt.md", "key": "h-urena/copilot-agentic-standards/.github/prompts/scaffolds/database.prompt.md" } } }

database

About

Scaffold Database Setup

0. REQUIREMENTS_SCHEMA

1. ENV_VAR_SCHEMA

2. BASE_MODEL_FIELDS

3. MIGRATION_RULES

4. LAYER_STRUCTURE

FORBIDDEN

Use it

Manifest

Reviews