ent-schema-generator

Original：🇨🇳 Chinese

Translated

Summarize database schema design from requirement inputs and produce implementation-ready outputs for Go + Ent in this repository. Use when the input may be a prompt, Markdown requirement document, repository folder, or runnable demo behavior and you need entity extraction, field/constraint design, weak-relation ID strategy, index planning, Ent schema guidance, and concrete bind/render/service integration impacts.

1installs

Sourcego-sphere/skills

Added on2026-02-26

NPX Install

npx skill4agent add go-sphere/skills ent-schema-generator

SKILL.md Content (Chinese)

View Translation Comparison →

Ent Schema Generator

Consolidate requirement inputs into a DB schema solution that can be directly implemented in

sphere-layout

, emphasizing executability and auditability.

AI-First Workflow

Gather inputs from all available sources.

Read prompts, requirement documents (
```
.md
```
), interface definitions (
```
.proto
```
), existing schemas, service/dao/render code.
If there is demo behavior, first extract objects, state transitions, and key actions.

Extract entities and lifecycle.

Extract candidate entities from business nouns and API resources.
For each entity, clearly define: status/state, key time points, key constraints.
Split tables only when clearly necessary (optional field groups, low-frequency large fields, write hot spot conflicts).

Design fields and null strategy.

Schemas and key fields must have business comments.
Each field must clearly specify Optional/Nillable/Unique/Immutable/Default.
Use Ent's native
```
field.Enum
```
for status fields and set default values.
Unify
```
created_at/updated_at
```
; add
```
deleted_at
```
only when soft deletion is required.
Prioritize
```
NULL
```
for missing semantics, avoid empty string sentinels.

Apply ID policy.

Do not manually write
```
id
```
in the schema by default.
Prioritize using the ent generator for centralized ID configuration.
Manually write custom
```
id
```
only when explicitly required by the business, and explain the impact on bind/proto.

Choose relation strategy.

Prioritize weak association IDs (e.g.,
```
user_id
```
/
```
order_id
```
) for relation fields.
Fixed priority for many-to-many: relation-entity > array (confirm dialect support) > join table > JSON (last resort).
JSON is not a regular solution; must explain why typed/array/join table is not feasible.

Plan indexes from real query paths.

Design indexes based on real list/filter/sort/query usage paths.
Prioritize primary key/unique, high-selectivity filtering, and composite indexes for pagination and sorting.
Avoid creating single-column indexes for low-cardinality status unless there is a clear benefit.

Produce Ent + Go implementation guidance.

On the Ent side, prioritize expressing relationships with ID fields, do not enforce edges.
On the Go side, provide batch query solutions: collect IDs -> deduplicate ->
```
IDIn(...)
```
-> map backfill.
Provide chunking strategies and cross-service
```
BatchGet*
```
recommendations when IDs are large.

Add evolution and consistency safeguards.

For read optimization, allow redundant fields (e.g., name/price snapshot).
Prioritize typed/array structures; JSON is only an exception.
For weak association scenarios, must provide dangling refs checkpoints.

Repository Contract (sphere-layout)

Must explicitly align with the following generation links and access points:

Ent generation entry:
```
cmd/tools/ent/main.go
```
Bind/Mapper generation entry:
```
cmd/tools/bind/main.go
```
Unified post-command:
```
make gen/proto
```

The output must include judgments and explanations for:

```
ent tool config impact
```
: Impact on
```
IDType
```
/ ent features / autoproto.
```
bind registration impact
```
: Whether
```
createFilesConf
```
needs to be updated.
```
render/dao/service touchpoints
```
: Which layers need code supplements.

New Entity Mandatory Modification Checklist

If the scheme introduces new entities, must check each item and specify in the output:

New schema files and fields/indexes.
Registration in
```
createFilesConf
```
in
```
cmd/tools/bind/main.go
```
.
Integration with the render layer (consumption points for
```
entmap
```
/
```
entbind
```
).
DAO layer batch query helpers and deduplication strategies.
Service layer pagination/query/mapping integration.
Execution of generation commands and consumption of change diffs (entpb/proto/bind/map).

Failure Handling Constraints

The following cases are not considered complete:

Only modifying the schema without evaluating or explaining the impact on bind registration.
Not supplementing the impact explanation of
```
WithIgnoreFields
```
when involving bound fields (e.g.,
```
created_at/updated_at
```
or sensitive fields).
Output lacks post-change commands or generation diff checklists.

Output Format

Use

references/output-template.md

.

The final output must include:

11 sections of structured content.
Explanation of impacts on the sphere-layout generation link.
Post-change commands (at least
```
make gen/proto
```
and test commands).
Generation diff checklist.

Resources

```
references/best-practices.md
```
```
references/output-template.md
```
```
references/go-ent-service-patterns.md
```
```
references/ent-schema-examples.md
```

Notes

This skill is driven by AI reasoning and does not rely on local scripts to automatically generate drafts.
The default language is Chinese explanations + English technical keywords (commands/types/API names are not translated).