Native Types

Override most scalar column types with database-specific native types

Most scalar factories accept an optional native type as their first argument to override the default column type:

import { s } from "viborm";
import { PG, MYSQL, SQLITE } from "viborm/schema";

s.string(PG.STRING.VARCHAR(255)); // varchar(255) instead of text
s.string(MYSQL.STRING.LONGTEXT);  // LONGTEXT on MySQL
s.json(PG.JSON.JSON);             // json instead of jsonb

A native type only applies when it matches the database you run against (PG.* on PostgreSQL, MYSQL.* on MySQL, SQLITE.* on SQLite); otherwise the default mapping below is used. This keeps schemas portable across databases.

Fixed decimals are the deliberate exception. s.decimal({ precision, scale }) derives its physical type from that one portable descriptor and accepts no native-type override.

Default Type Mapping

Without a native type override, scalars map to these column types:

s.dateTime() and s.time() default to timezone-aware columns on PostgreSQL; chain .withoutTimezone() for timestamp / time. .array() appends [] to the column type on PostgreSQL and stores as JSON on MySQL/SQLite.

String

Integer

Float

Decimal

Decimal native-type constants do not exist. The required descriptor is the one source of truth for validation, DDL, query lowering, results, and migrations:

s.decimal({ precision: 10, scale: 2 });

It maps to NUMERIC(10,2) on PostgreSQL, DECIMAL(10,2) on MySQL, and a checked scaled INTEGER coefficient on SQLite-family providers. This keeps one logical decimal domain exact on every database; a native override would create a second provider-specific precision or representation. See Decimal.

BigInt

Boolean

DateTime

JSON

Blob

Point (PostgreSQL only)