Language reference
schema.tpy patterns
Types, constraints, defaults, indexes, foreign keys, and multi-model examples.
Shape
File structure
# optional provider line
database postgres
model ModelName {
field: type constraint...
}
Use # for comments. Keywords are case-insensitive.
Types
Field types
int — integerstring — text / VARCHARfloat — floating pointbool — booleanuuid — UUID primary keysdatetime — timestamp
Constraints
Field constraints
primary — primary keyrequired — required in create APIunique — UNIQUE columnnullable — allow NULL / optionalindex — create an indexdefault <value> — column defaultreferences <Model> — foreign key
Non-primary fields without nullable become NOT NULL in SQL.
Providers
database line
database sqlitedatabase postgresdatabase mysqldatabase mongodb
Usually written for you by tpy build / tpy db configure.
# 01 — starter User
database sqlite
model User {
id: uuid primary
name: string required
email: string unique required
age: int
}
# 02 — defaults + index
database postgres
model Product {
id: uuid primary
title: string required index
price: float required
active: bool default true
stock: int default 0
status: string default "draft"
notes: string nullable
created_at: datetime nullable
}
# 03 — foreign keys (references)
database postgres
model User {
id: uuid primary
email: string unique required
}
model Post {
id: uuid primary
title: string required index
body: string nullable
user_id: uuid references User
published: bool default false
}
Relations
Foreign keys & ORM
Use references <Model> on a field. Optional relations { } for eager loading:
user_id: uuid references User
relations {
belongs_to User as author via user_id
has_many Comment as comments
}
Define referenced models earlier so migrations run in order.
Defaults
Default values
Add default <value> — a number, quoted string, or true / false.
stock: int default 0
active: bool default true
status: string default "draft"
Fields with a default become optional in the create API.
Indexes
Column index
Add the index keyword to generate an index:
title: string required index
Emits CREATE INDEX idx_<table>_<column>. Primary keys are already indexed.
Migrations
File naming
Generated as ordered files from model order in the schema:
001_user_migration.py002_post_migration.py
API shape
Routes from a model
Model User → prefix /users:
GET /users/GET /users/{id}POST /users/PUT /users/{id}DELETE /users/{id}
