↑↓ 选择 ↵ 打开 ⌫ 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

百科 / SQL 命令 / 类型与运算符

SQL COMMAND · 类型与运算符

CREATE DOMAIN

定义一个新域

CREATE类型与运算符引入 10(基线)现存至 20 devel1 次语法变更

动词
CREATE
对象
DOMAIN
引入版本
10(基线)
状态
现存
语法变更次数
1
手册小节数
6

本站手册 · 18官方文档 ↗

版本轨迹

相对 PostgreSQL 17 无变化。

语法铁道图 PostgreSQL 18

沿轨道从左向右阅读,分岔表示选择,绕行表示可选,回环表示重复。方框为参数,点击带下划线的参数可展开子规则。

CREATE DOMAIN name AS data_type COLLATE collation DEFAULT expression domain_constraint
domain_constraint
CONSTRAINT constraint_name NOT NULL NULL CHECK ( expression )

语法概要

CREATE DOMAIN name [ AS ] data_type
    [ COLLATE collation ]
    [ DEFAULT expression ]
    [ domain_constraint [ ... ] ]

其中 domain_constraint 是:

[ CONSTRAINT constraint_name ]
{ NOT NULL | NULL | CHECK (expression) }

PostgreSQL 18 手册 · 查看完整参考页

描述

CREATE DOMAIN创建一个新域。域本质上是一种带有可选约束(即对允许值集合的限制)的数据类型。定义域的用户将成为其拥有者。

如果给定了模式名(例如CREATE DOMAIN myschema.mydomain ...),则该域会在指定模式中创建。否则它会在当前模式中创建。域名在其所在模式中的现有类型和域之间必须唯一。

域适合把字段上的常见约束抽象到单一位置进行维护。例如,若有多个表都包含电子邮件地址列,并且都需要同一个 CHECK 约束来验证地址语法,那么定义一个域会比在每个表上分别设置该约束更合适。

要创建域,你必须对其底层类型拥有USAGE权限。

参数

name

要创建的域名(可选地带模式限定)。

data_type

该域的底层数据类型。它可以包含数组说明符。

collation

该域的可选排序规则。如果未指定排序规则,则该域的排序规则行为与其底层数据类型相同。如果指定了COLLATE,则底层类型必须是一种支持排序规则的数据类型。

DEFAULT expression

DEFAULT子句为该域数据类型的列指定默认值。该值可以是任意不含变量的表达式(但不允许子查询)。默认表达式的数据类型必须与该域的数据类型匹配。如果未指定默认值,则默认值为空值。

默认表达式会在任何未为该列指定值的插入操作中使用。如果为某个特定列定义了默认值,它就会覆盖与该域关联的任何默认值。反过来,域默认值又会覆盖与底层数据类型关联的任何默认值。

CONSTRAINT constraint_name

约束的可选名称。如果未指定,系统会生成一个名称。

NOT NULL

该域的值不允许为空值(但见下文注解)。

NULL

该域的值允许为空值。这是默认行为。

该子句仅用于与非标准 SQL 数据库兼容。不鼓励在新应用中使用它。

CHECK (expression)

CHECK子句指定该域的值必须满足的完整性约束或测试。每个约束都必须是一个产生布尔结果的表达式。它应使用关键字VALUE来引用被测试的值。求值结果为 TRUE 或 UNKNOWN 的表达式会通过检查。如果表达式产生 FALSE 结果,就会报告错误,并且不允许将该值转换成该域类型。

当前,CHECK表达式不能包含子查询,也不能引用 VALUE之外的其他变量。

当一个域有多个CHECK约束时,会按名称的字母顺序测试它们。(9.5 之前的PostgreSQL版本并不保证CHECK约束遵循任何特定的触发顺序。)

注解

域约束,特别是NOT NULL,会在把值转换成域类型时进行检查。即便存在这样的约束,一个名义上属于该域类型的列也仍可能读出为空值。例如,在外连接查询中,如果该域列位于外连接中可为空的一侧,就可能发生这种情况。一个更微妙的例子是:

INSERT INTO tab (domcol) VALUES ((SELECT domcol FROM tab WHERE false));

这个空标量子 SELECT 会产生一个空值,该空值被视为域类型的值,因此不会再对其执行进一步的约束检查,插入也会成功。

由于 SQL 普遍假定空值是每种数据类型的合法值,因此很难彻底避免这类问题。因此,最佳实践是把域约束设计为允许空值,然后在需要时对该域类型的列应用列级NOT NULL约束,而不是直接对域类型应用这种约束。

PostgreSQL假定CHECK 约束的条件是不可变的,也就是说,对于相同的输入值,它们总会给出相同的结果。正是基于这一假设,系统只会在值首次被转换为域类型时检查 CHECK约束,而不会在其他时候检查。(这与表 CHECK约束的处理方式基本相同,如第 5.5.1 节所述。)

打破这一假设的一种常见方式是,在CHECK表达式中引用用户定义函数,然后改变该函数的行为。PostgreSQL 不禁止这样做,但如果此时已有存储的域类型值违反了CHECK 约束,系统也不会注意到。这会导致后续数据库转储和恢复失败。推荐的处理方式是先删除该约束(使用ALTER DOMAIN),调整函数定义,然后重新添加约束,从而重新根据已存储数据进行检查。

此外,确保域的CHECK表达式不会抛出错误也是一种良好实践。

示例

这个示例创建us_postal_code数据类型,然后在一个表定义中使用该类型。这里使用正则表达式测试来验证该值看起来是否为一个合法的美国邮政编码:

CREATE DOMAIN us_postal_code AS TEXT
CHECK(
   VALUE ~ '^\d{5}$'
OR VALUE ~ '^\d{5}-\d{4}$'
);

CREATE TABLE us_snail_addy (
  address_id SERIAL PRIMARY KEY,
  street1 TEXT NOT NULL,
  street2 TEXT,
  street3 TEXT,
  city TEXT NOT NULL,
  postal us_postal_code NOT NULL
);

兼容性

命令CREATE DOMAIN符合 SQL 标准。

本命令中的NOT NULL语法是 PostgreSQL扩展。(对于非复合数据类型,符合标准的等价写法是CHECK (VALUE IS NOT NULL)。不过,正如“注解”一节所述,这类约束在实践中最好还是避免使用。)NULL“约束”也是PostgreSQL扩展(另见Compatibility)。

另见

语法演化

相邻大版本之间的差异,新的在前。版本号链接到对应快照。

  1. PostgreSQL 17← 16语法变化

    + [ domain_constraint [ ... ] ]− [ constraint [ ... ] ]正文更新
  2. PostgreSQL 16← 15正文更新

    正文更新
  3. PostgreSQL 12← 11正文更新

    正文更新
  4. PostgreSQL 11← 10正文更新

    正文更新

同组命令

命令动词对象版本变动最近变更
TYPES & OPERATORS类型与运算符23 条↑
CREATE CASTCREATECAST —
定义一种新的类型转换现存
DROP CASTDROPCAST —
移除一个类型转换现存
CREATE COLLATIONCREATECOLLATION 162 次
定义一种新排序规则现存
ALTER COLLATIONALTERCOLLATION 141 次
更改排序规则的定义现存
DROP COLLATIONDROPCOLLATION —
删除一个排序规则现存
CREATE CONVERSIONCREATECONVERSION —
定义一个新的编码转换现存
ALTER CONVERSIONALTERCONVERSION 141 次
更改一个转换的定义现存
DROP CONVERSIONDROPCONVERSION —
移除一个转换现存
CREATE DOMAINCREATEDOMAIN 171 次
定义一个新域现存
ALTER DOMAINALTERDOMAIN 142 次
更改一个域的定义现存
DROP DOMAINDROPDOMAIN —
移除一个域现存
CREATE OPERATORCREATEOPERATOR 192 次
定义一个新的操作符现存
ALTER OPERATORALTEROPERATOR 172 次
更改一个操作符的定义现存
DROP OPERATORDROPOPERATOR 141 次
移除一个操作符现存
CREATE OPERATOR CLASSCREATEOPERATOR CLASS —
定义一个新的操作符类现存
ALTER OPERATOR CLASSALTEROPERATOR CLASS 141 次
更改一个操作符类的定义现存
DROP OPERATOR CLASSDROPOPERATOR CLASS —
移除一个操作符类现存
CREATE OPERATOR FAMILYCREATEOPERATOR FAMILY —
定义一个新的操作符族现存
ALTER OPERATOR FAMILYALTEROPERATOR FAMILY 141 次
更改一个操作符族的定义现存
DROP OPERATOR FAMILYDROPOPERATOR FAMILY —
移除一个操作符族现存
CREATE TYPECREATETYPE 141 次
定义一种新数据类型现存
ALTER TYPEALTERTYPE 142 次
更改类型的定义现存
DROP TYPEDROPTYPE —
移除一个数据类型现存