MySQL 列类型

我们已经原生支持所有这些类型，不过如果这还不够用，你也可以随时创建 自定义类型。

important

本部分文档中的所有示例都没有使用数据库列名别名，列名是根据 TypeScript 键生成的。

如果你愿意，也可以在列名中使用数据库别名，并且还可以使用 casing API 为 Drizzle 定义一种映射策略。

你可以在这里阅读更多相关内容

important

所有整数类型（int、tinyint、smallint、mediumint、bigint）默认都是 signed，因此既允许负值也允许正值。添加 { unsigned: true } 会将列限制为仅允许非负值，但会将上限范围加倍。

integer

一个 4 字节整数，带符号范围为 -2,147,483,648 到 2,147,483,647，无符号范围为 0 到 4,294,967,295

更多信息请参考官方 MySQL 文档。

import { int, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	int: int(),
	int2: int({ unsigned: true })
});

CREATE TABLE `table` (
	`int` int,
	`int2` int unsigned
);

tinyint

一个 1 字节整数，带符号范围为 -128 到 127，无符号范围为 0 到 255

更多信息请参考官方 MySQL 文档。

import { tinyint, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	tinyint: tinyint(),
	tinyint2: tinyint({ unsigned: true })
});

CREATE TABLE `table` (
	`tinyint` tinyint,
	`tinyint2` tinyint unsigned
);

smallint

一个 2 字节整数，带符号范围为 -32,768 到 32,767，无符号范围为 0 到 65,535

更多信息请参考官方 MySQL 文档。

import { smallint, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	smallint: smallint(),
	smallint2: smallint({ unsigned: true }),
});

CREATE TABLE `table` (
	`smallint` smallint,
	`smallint2` smallint unsigned
);

mediumint

一个 3 字节整数，带符号范围为 -8,388,608 到 8,388,607，无符号范围为 0 到 16,777,215

更多信息请参考官方 MySQL 文档。

import { mediumint, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	mediumint: mediumint(),
	mediumint2: mediumint({ unsigned: true })
});

CREATE TABLE `table` (
	`mediumint` mediumint,
	`mediumint2` mediumint unsigned
);

bigint

一个 8 字节整数，带符号范围为 -2^63 到 2^63-1，无符号范围为 0 到 2^64-1

更多信息请参考官方 MySQL 文档。

import { bigint, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	bigint: bigint({ mode: 'number' }),
	bigintUnsigned: bigint({ mode: 'number', unsigned: true })
});

bigint("...", { mode: 'number' | 'bigint' | 'string' });

// You can also specify unsigned option for bigint
bigint("...", { mode: 'number' | 'bigint' | 'string', unsigned: true });

CREATE TABLE `table` (
	`bigint` bigint,
	`bigintUnsigned` bigint unsigned
);

我们省略了 bigint(M) 中 M 的配置，因为它表示该数值类型的显示宽度

---

real

一个浮点数

有关更多信息，请参阅官方 MySQL 文档。

import { real, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	real: real()
});

CREATE TABLE `table` (
	`real` real
);

import { real, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	realPrecision: real({ precision: 1 }),
	realPrecisionScale: real({ precision: 1, scale: 1 }),
});

CREATE TABLE `table` (
	`realPrecision` real(1),
	`realPrecisionScale` real(1, 1)
);

decimal

一种精确的定点数。DECIMAL(M, D) 可存储最多 M 位总数字，其中小数点后有 D 位数字。最大精度为 65 位数字

有关更多信息，请参阅官方 MySQL 文档。

import { decimal, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	decimal: decimal(),
	decimalNum: decimal({ precision: 30, mode: 'number' }),
	decimalBig: decimal({ precision: 30, mode: 'bigint' }),
	decimal2: decimal({ precision: 30, scale: 10 }),
});

CREATE TABLE `table` (
	`decimal` decimal,
	`decimalNum` decimal(30),
	`decimalBig` decimal(30),
	`decimal2` decimal(30,10)
);

double

一个 8 字节的双精度浮点数，用于表示近似数值数据

有关更多信息，请参阅官方 MySQL 文档。

import { double, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	double: double()
});

CREATE TABLE `table` (
	`double` double
);

import { double, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	doublePrecision: double({ precision: 1 }),
	doublePrecisionScale: double({ precision: 1, scale: 1 })
});

CREATE TABLE `table` (
	`doublePrecision` double(1),
	`doublePrecisionScale` double(1,1)
);

float

一个 4 字节的单精度浮点数，用于表示近似数值数据

有关更多信息，请参阅官方 MySQL 文档。

import { float, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	float: float()
});

CREATE TABLE `table` (
	`float` float
);

---

serial

SERIAL 是 BIGINT UNSIGNED NOT NULL AUTO_INCREMENT UNIQUE 的别名。

更多信息请参阅官方 MySQL 文档。

import { serial, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	serial: serial()
});

CREATE TABLE `table` (
	`serial` serial
);

---

binary

BINARY(M) 存储一个固定长度的字节字符串，长度恰好为 M 字节（如果省略，M 默认值为 1）。
在插入时，较短的值会用 0x00 字节在右侧填充以达到 M 字节；在检索时，不会去除任何填充。在比较中，所有字节都具有重要性，包括 ORDER BY 和 DISTINCT 操作

更多信息请参阅 MySQL 官方 文档。

import { binary, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	binary: binary(),
	binary2: binary({ length: 10 }),
});

CREATE TABLE `table` (
	`binary` binary,
	`binary2` binary(10)
);

varbinary

VARBINARY(M) 存储一个长度可变的字节字符串，最多可达 M 字节（按需使用 M）。
对于 VARBINARY，插入时不会填充，检索时也不会去除任何字节。在比较中，所有字节都具有重要性，包括 ORDER BY 和 DISTINCT 操作

更多信息请参阅 MySQL 官方 文档。

import { varbinary, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	varbinary: varbinary({ length: 2 }),
});

CREATE TABLE `table` (
	`varbinary` varbinary(2)
);

---

blob

BLOB 是一种二进制大对象，可以存储可变大小的数据，最大长度为 65,535 字节（64 KB）

更多信息请参阅 MySQL 官方 文档。

import { blob, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	blob: blob()
});

CREATE TABLE `table` (
	`blob` blob
);

你可以指定 buffer 或 string 模式：

// 将被推断为 `Buffer`
blob: blob({ mode: "buffer" }),

// 将被推断为 `string`
blob: blob({ mode: "string" }),

buffer 模式是使用 blob 的默认方式。 Drizzle 会将 blob 值表示为 Buffer 实例

string 模式将 blob 值表示为 UTF-8 编码字符串，这在将文本数据存储到 blob 列中时会很有用

tinyblob

一个最大长度为 255 字节的 BLOB 列

更多信息请参阅 MySQL 官方 文档。

import { tinyblob, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	tinyblob: tinyblob()
});

CREATE TABLE `table` (
	`tinyblob` tinyblob
);

你可以指定 buffer 或 string 模式：

// 将被推断为 `Buffer`
tinyblob: tinyblob({ mode: "buffer" }),

// 将被推断为 `string`
tinyblob: tinyblob({ mode: "string" }),

buffer 模式是使用 blob 的默认方式。 Drizzle 会将 blob 值表示为 Buffer 实例

string 模式将 blob 值表示为 UTF-8 编码字符串，这在将文本数据存储到 blob 列中时会很有用

mediumblob

一个最大长度为 16,777,215 字节（16 MB）的 BLOB 列

更多信息请参阅 MySQL 官方 文档。

import { mediumblob, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	mediumblob: mediumblob()
});

CREATE TABLE `table` (
	`mediumblob` mediumblob
);

你可以指定 buffer 或 string 模式：

// 将被推断为 `Buffer`
mediumblob: mediumblob({ mode: "buffer" }),

// 将被推断为 `string`
mediumblob: mediumblob({ mode: "string" }),

buffer 模式是使用 blob 的默认方式。 Drizzle 会将 blob 值表示为 Buffer 实例

string 模式将 blob 值表示为 UTF-8 编码字符串，这在将文本数据存储到 blob 列中时会很有用

longblob

一个最大长度为 4,294,967,295 字节（4 GB）的 BLOB 列

更多信息请参阅 MySQL 官方 文档。

import { longblob, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	longblob: longblob()
});

CREATE TABLE `table` (
	`longblob` longblob
);

你可以指定 buffer 或 string 模式：

// 将被推断为 `Buffer`
longblob: longblob({ mode: "buffer" }),

// 将被推断为 `string`
longblob: longblob({ mode: "string" }),

buffer 模式是使用 blob 的默认方式。 Drizzle 会将 blob 值表示为 Buffer 实例

string 模式将 blob 值表示为 UTF-8 编码字符串，这在将文本数据存储到 blob 列中时会很有用

---

char

CHAR(M) 列的长度在创建表时会固定为你声明的长度。M 可以是从 0 到 255 的任意值，默认值为 1 存储 CHAR 值时，会在右侧填充空格以达到指定长度。检索 CHAR 值时，除非启用了 PAD_CHAR_TO_FULL_LENGTH SQL 模式，否则会移除尾随空格。

更多信息请参阅官方 MySQL 文档。

你可以定义 { enum: ["value1", "value2"] } 配置来推断插入和查询类型，它不会检查运行时值。

import { char, mysqlTable } from "drizzle-orm/mysql-core";

export const table = mysqlTable('table', {
	char: char(),
});

// 将被推断为 char: "value1" | "value2" | null
char: char({ enum: ["value1", "value2"] })

CREATE TABLE `table` (
	`char` char
);

varchar

VARCHAR 列中的值是可变长度字符串。
VARCHAR(M) 最多存储 M 个字符，其中 M 的范围是 0 到 65,535 存储 VARCHAR 值时不会进行填充。根据标准 SQL，存储和检索值时都会保留尾随空格。

更多信息请参阅官方 MySQL 文档。