CREATE TYPE

Name

CREATE TYPE -- 定义一个新数据类型

Synopsis

CREATE TYPE name AS
    ( attribute_name data_type [, ... ] )

CREATE TYPE name AS ENUM
    ( [ 'label' [, ... ] ] )

CREATE TYPE name (
    INPUT = input_function,
    OUTPUT = output_function
    [ , RECEIVE = receive_function ]
    [ , SEND = send_function ]
    [ , TYPMOD_IN = type_modifier_input_function ]
    [ , TYPMOD_OUT = type_modifier_output_function ]
    [ , ANALYZE = analyze_function ]
    [ , INTERNALLENGTH = { internallength | VARIABLE } ]
    [ , PASSEDBYVALUE ]
    [ , ALIGNMENT = alignment ]
    [ , STORAGE = storage ]
    [ , LIKE = like_type ]
    [ , CATEGORY = category ]
    [ , PREFERRED = preferred ]
    [ , DEFAULT = default ]
    [ , ELEMENT = element ]
    [ , DELIMITER = delimiter ]
)

CREATE TYPE name

描述

CREATE TYPE为当前数据库注册一个新的数据类型。定义该类型的用户成为其所有者。

如果给出模式名,那么该类型是在指定模式中创建。否则它将在当前模式中创建。类型名必需和同一模式中任何现有的类型或者域不同。因为表和数据类型有联系,所以类型名也不能和同模式中的表名字冲突。

复合类型

第一种形式的CREATE TYPE创建一个复合类型。复合类型是通过一列属性名和数据类型声明的。这样实际上和一个表的行类型一样, 但是如果只是想定义一个类型,那么使用CREATE TYPE就可以避免直接创建实际的表。一个独立的复合类型做一个函数的参数或者返回类型是非常有用的。

枚举类型

CREATE TYPE的第二种形式创建一个枚举类型,就像 Section 8.7中描述的一样。枚举类型采取一个列表的 一个或多个引用标签,其中的每一个都必须是少于NAMEDATALEN 字节长度的(在一个标准PostgreSQL构建中是64)。

基本类型

CREATE TYPE的第三种形式创建了一个新的基类型(标量 类型)。为了创建一个新的基类型,你必须是一个超级用户。(做这个限制的 原因是一个错误的类型定义可以困惑甚至摧毁服务器。)

参数可以按任意顺序出现,而不是上面显示的那样,并且大多数都是可选的。它要求要在定义类型之前先用CREATE FUNCTION注册两个或更多个函数。 支持函数input_functionoutput_function是必须的, 而函数receive_functionsend_functiontype_modifier_input_functiontype_modifier_output_functionanalyze_function是可选的。 通常,这些函数必须用C或者其它低层语言编写。

input_function函数将该类型的外部文本形式转换成可以被该类型的操作符和函数识别的内部形式。 output_function用途相反。输入函数可以声明为接受一个类型为cstring的参数, 或者接受三个类型分别为cstringoidinteger的参数。第一个参数是C字符串形式的输入文本, 第二个参数是该类型自身的OID(数组类型除外,这种情况下它们接受自身元素的类型OID), 第三个是目标字段的typmod(如果未知则传递-1)。输入函数必须返回一个自身数据类型的值。 通常,输入函数应当被声明为STRICT,否则当读取NULL输入时将被使用第一个参数为NULL进行调用, 并且必须仍然返回NULL或报错。这个特性主要是为了支持域输入函数,这种函数可能需要拒绝NULL输入。 输出函数必须被声明为接受一个新数据类型的参数,并且必须返回cstring类型。输出函数不会被使用NULL调用。

可选的receive_function把该类型的外部二进制表现形式转换成内部表现形式。 如果没有提供这个函数,那么该类型不能用二进制输入。二进制格式应该选取那种比较容易转换同时还有一定移植性的内部格式。 比如,标准的整数数据类型使用网络字节序作为外部的二进制表现形式,而内部表现形式则是机器的本机字节序。 例如,接收函数应该声明为接受一个类型为internal的参数,或者是三个类型分别为internaloidinteger的参数。 第一个参数是一个指向一个StringInfo缓冲区的、保存接受字节串的指针;可选的参数和文本输入函数一样。 接收函数必须返回一个该类型的数据值。通常接收函数应当被声明为STRICT, 否则否则当读取NULL输入时将被使用第一个参数为NULL进行调用,并且必须仍然返回NULL或报错。 这个特性主要是为了支持域接收函数,这种函数可能需要拒绝NULL输入。同样, 可选的send_function把类型的内部表现形式转换为外部二进制表现形式。如果没有提供这些函数, 那么类型就不能用二进制方式输出。发送函数必须声明为接收一个新数据类型并且必须返回bytea结果。发送函数不会被以NULL值调用。

这个时候你应该觉得奇怪,输入和输出函数怎么可以声明为返回新类型的结果或者是接受新类型的参数, 而且是在新类型创建之前就需要创建它们。答案是类型必须被首先定义为一个壳类型, 它只是一个除了名称和属主之外没有其他属性的占位符类型。这可以通过没有其他额外参数的CREATE TYPEname命令来完成。 然后就可以引用该壳类型定义输入输出函数。最后,CREATE TYPE把这个壳类型替换成完整的、有效的类型定义,这样就可以使用新类型了。

可选的type_modifier_input_functiontype_modifier_output_function 是需要的,如果类型支持连接到类型声明的可选约束修饰符,例如char(5)或者 numeric(30,2)PostgreSQL允许用户定义的类型 把一个或多个简单的常量或标识符作为修饰符。然而,这个信息必须能够被打包成一个单一的 非负整数值存储在系统目录中。 type_modifier_input_functioncstring元组的形式传递声明的修饰符。 它必须检查值的有效性(若是错的则抛出一个错误),如果他们是错的,返回一个存储 为列"typmod"的独立非负整型值。类型修饰符将被拒绝,如果类型 没有type_modifier_input_functiontype_modifier_output_function 将内部整数typmod值回转换回到正确的形式给用户显示。必须返回一个添加到类型名 的正确字符串的cstring值;比如numeric的函数会返回 (30,2)。允许省略 type_modifier_output_function, 在这种情况下,默认的显示格式仅仅是括在圆括号中的存储的typmod整数值。

可选的analyze_function为该数据类型的字段执行与该类型相关的统计信息收集。 缺省的时,如果该类型有个缺省的B-tree操作符类,那么ANALYZE将尝试使用该类型的"等于""小于"操作符收集信息。 对于非标量类型,这种行为很可能不合适,因此可以通过提供一个自定义的分析函数覆盖它。 分析函数必须声明为接收单独一个internal类型的参数,并且返回一个boolean结果。 分析函数的详细API在 src/include/commands/vacuum.h里。

尽管新类型的内部表现形式只有输入输出函数和其它你创建来使用该类型的函数了解, 但内部表现形式还是有几个属性必须为PostgreSQL声明。internallength是最重要的一个。 基本数据类型可定义成为定长,这时internallength是一个正整数,也可以是变长的, 这时用把internallength设为VARIABLE表示(在内部, 这个状态是通过将typlen设置为-1实现的)。所有变长类型的内部形式都必须以一个四字节整数开头, 这个整数给出此类型这个数值的全长。

可选的标记PASSEDBYVALUE表明该类型的数值是按值而不是引用传递。 你不能传递那些内部形式大于Datum类型尺寸(大多数机器上是4字节,有些是8字节)的数据类型的值。

alignment参数声明该数据类型要求的对齐存储方式。允许的数值等效于按照1,2,4,8字节边界对齐。 请注意变长类型必须有至少4字节的对齐,因为它们必须包含一个int4作为第一个部分。

storage参数允许为变长数据类型选择存储策略(定长类型只允许使用plain)。 plain声明该数据类型总是用内联的方式而不是压缩的方式存储。 extended声明系统将首先试图压缩一个长的数据值,然后如果它仍然太长的话就将它的值移出主表, 但系统将不会压缩它。external声明禁止系统进行压缩并且允许将它的值移出主表。 main 允许压缩,但是不赞成把数值移动出主表(如果实在不能放在一行里的话,仍将移动出主表), 它比extendedexternal项更愿意保存在主表里。

like_type参数提供了一个 指定数据类型的基本表示属性的可选的方法:从一些现有类型复制它们。 internallength, passedbyvalue, alignment, 和 storage的值从命名的类型 复制。(通过用LIKE子句声明他们来重写其中的一些值是可能的, 但往往是不可取的。)以这种方式声明表示法是特别有效的,当新类型 "piggybacks"的底层实现以某种形式的现有类型存在时。 whenthe low-level implementation of the new type "piggybacks" on an existing type in some fashion.

categorypreferred参数可以用于帮助控制 隐式强制用于模糊情况的。每个数据类型属于一个由ASCII字符命名的类别,并且每种 类型要么是"preferred"要么未在其类别中。解析器更喜欢强制为优先选择类型 (但仅仅是从相同类别下的其他类型),当这个规则在解决重载函数或操作符起作用时。 要获取更多详细信息请参阅Chapter 10。 对于那些没有隐式转换成其他类型或者由其他类型转换成隐式转换的类型,足以 默认保持这些设置。然而,对于有隐式转换的相关类型的一个组,标记他们全部属于 一个类别并选择"most general"类型中的一个或者两个作为范畴内首选的, 这是很有效的。当添加一个用户定义的类型到现有的内置类别时, category参数尤其有用, 如数字或字符串类型。然而,创建新的完全用户定义类型类别也是可能的。选择 任何ASCII字符而不是一个大写字母来命名这样一个类别。

如果用户希望字段的数据类型缺省时不是NULL,那么可以在DEFAULT关键字里声明一个缺省值(可以被附着在特定字段上的DEFAULT子句覆盖)。

ELEMENT关键字声明数组元素的类型。比如,ELEMENT = int4定义了一个4字节整数(int4)的数组。有关数组类型的更多细节在下面描述。

可用delimiter指定用于这种类型数组的外部形式的数值之间的分隔符。缺省的分隔符是逗号(,)。请注意分隔符是和数组元素类型相关联,而不是数组类型本身。

数组类型

在创建用户定义数据类型的时候,PostgreSQL 自动创建一个与之关联的数组类型,其名字由该基本类型的名字前缀一个下划线组成, 并且若有必要使其少于NAMEDATALEN字节长度就缩减。(若如此产生 的名称与一个已存在的类型名冲突,那么将重复该过程,知道找到不冲突的名称。) 这个隐式地创建的数组类型是可变长度的,并使用内置输入和输出函数array_inarray_out。数组类型会追踪在其元素类型的所有者或模式的任何改变, 并且若元素类型是则删除它。and is dropped if the element type is.

You might reasonably ask why there is an ELEMENT option, if the system makes the correct array type automatically. The only case where it's useful to use ELEMENT is when you are making a fixed-length type that happens to be internally an array of a number of identical things, and you want to allow these things to be accessed directly by subscripting, in addition to whatever operations you plan to provide for the type as a whole. For example, type point is represented as just two floating-point numbers, which it allows to be accessed as point[0] and point[1]. Note that this facility only works for fixed-length types whose internal form is exactly a sequence of identical fixed-length fields. A subscriptable variable-length type must have the generalized internal representation used by array_in and array_out. For historical reasons (i.e., this is clearly wrong but it's far too late to change it), subscripting of fixed-length array types starts from zero, rather than from one as for variable-length arrays. 你很可能会问如果系统自动制作正确的数组类型,那为什么还要有个ELEMENT选项?使用ELEMENT的场合有二: 你定义的定长类型碰巧在内部是一个一定数目相同事物的数组,而你又想允许这N个事物可以通过下标直接关联;某些操作符将把该类型当做整体进行处理。 比如,构成point类型代表只有两个浮点数。 这个类型允许像point[0]point[1]一样访问。 请注意这个功能只适用于定长类型,并且其内部形式是一个相同定长域的序列。 一个可以下标化的变长类型必须有被 array_in 和 array_out 使用的一般化的内部表现形式。 出于历史原因,定长数组类型的下标从 0 开始,而不是像变长类型那样的从 1 开始。

参数

name

将要创建的类型名(可以有模式修饰)。

attribute_name

复合类型的一个属性(字段)的名字。

data_type

要成为一个复合类型的字段的现有数据类型的名字。

label

一个字符串常量代表一个与枚举类型的值相关的文本标签。

input_function

一个函数的名称,将数据从外部文本形式转换成内部格式。

output_function

一个函数的名称,将数据从内部格式转换成适于显示的外部文本形式。

receive_function

把数据从类型的外部二进制形式转换成内部形式的函数名称。

send_function

把数据从类型的内部形式转换成外部二进制形式的函数名称。

type_modifier_input_function

一个将一个数组的修饰符(s)类型转换为内部形式的函数的名称。

type_modifier_output_function

将类型的修饰符(s)的内部形式转换为外部文本形式的函数的名称。

analyze_function

为该数据类型执行统计分析的函数名。

internallength

一个数值常量,说明新类型的内部表现形式的长度。缺省假定它是变长的。

alignment

该数据类型的存储对齐要求。如果声明了,必须是charint2int4(缺省), double之一。

storage

该数据类型的存储策略。如果声明了,必须是plain(缺省), external,extended, main之一。

like_type

新类型将用与原有数据类型名称相同的表示法。 internallength, passedbyvalue, alignmentstorage的值会从那种 类型中复制出来,除非通过CREATE TYPE命令用明显的声明 重写。

category

这个类型的分类码(一个独立的ASCII字符)。对于"user-defined type" 默认是'U'。其他标准类别代码可以在 Table 45-45中找到。为了创建自定义类别 您也可能要选择其他的ASCII字符。

preferred

若在其类型类别中该类型是优先类别,则为真,否则为假。默认是假。 在已有类型类别中药特别小心创建一个新的优先类型,因为这能引起 性能上的惊人变化。

default

该类型的缺省值。若省略则为 NULL。

element

被创建的类型是数组;这个声明数组元素的类型。

delimiter

数组元素之间分隔符。

注意

Because there are no restrictions on use of a data type once it's been created, creating a base type is tantamount to granting public execute permission on the functions mentioned in the type definition. This is usually not an issue for the sorts of functions that are useful in a type definition. But you might want to think twice before designing a type in a way that would require "secret" information to be used while converting it to or from external form. 因为一旦类型被创建之后对它的使用就没有限制,所以创建一个基本类型就等价 于授予所有用户执行类型定义中指定的各个函数的权限。这对于大多数类型定义 中指定的函数来说不会造成什么不良问题。 但是如果你设计的新类型在内部形式和外部形式之间转换的时候使用"敏感信息", 那么你仍然要再三考虑、多加小心。

PostgreSQL8.3版本之前,一个生成的元组类型的 名称总是带下划线(_)前缀的完全元素类型的名字。(类型名 限制在比其他名少一个。)尽管这仍然是常见的情况,元组类型名称可能会在最大 长度名称或者下划线开始的用户类型名冲突情况变化。不推荐根据该约定写代码。 相反地,使用pg_type.typarray来定位与给定类型 相关的元组类型。

避免使用以下划线打头的类型和表名是明智的。尽管服务器将改变生成的元组类型名称 以避免与用户给定名称产生冲突,但仍然有混乱的风险,特别是与假定以下划线开始的 类型名总表示数组的老客户端软件

PostgreSQL8.2之前的版本中,并不存在CREATE TYPE name语法。 创建新的基本类型之前必须首先创建其输入函数。这样,PostgreSQL将会首先把新类型的名字 看作输入函数的返回类型并隐含创建壳类型,然后这个壳类型将被随后定义的输入输出函数引用。 这种老式的方法目前仍然被支持,但已经反对使用,将来可能不再支持。同样, 为了避免函数定义中的临时壳类型偶然地搞乱系统表,当输入函数用C语言书写时, 将只能用这种方法创建壳类型。

PostgreSQL7.3以前,要通过使用占位伪类型opaque代替函数的前向引用来避免创建壳类型。 7.3之前cstring参数和结果同样需要声明伪opaque。要支持加载旧的转储文件, CREATE TYPE将接受那些用opaque声明的输入输出函数, 但是它将发出一条通知并且用正确的类型改变函数的声明。

例子

这个例子创建一个复合类型并且在一个函数定义中使用它:

CREATE TYPE compfoo AS (f1 int, f2 text);

CREATE FUNCTION getfoo() RETURNS SETOF compfoo AS $$
    SELECT fooid, fooname FROM foo
$$ LANGUAGE SQL;

该示例创建了一个枚举类型并将其用于表定义:

CREATE TYPE bug_status AS ENUM ('new', 'open', 'closed');

CREATE TABLE bug (
    id serial,
    description text,
    status bug_status
);

这个命令创建box数据类型,并且将这种类型用于一个表定义:

CREATE TYPE box;

CREATE FUNCTION my_box_in_function(cstring) RETURNS box AS ... ;
CREATE FUNCTION my_box_out_function(box) RETURNS cstring AS ... ;

CREATE TYPE box (
    INTERNALLENGTH = 16,
    INPUT = my_box_in_function,
    OUTPUT = my_box_out_function
);

CREATE TABLE myboxes (
    id integer,
    description box
);

如果box的内部结构是一个四个float4的数组,可以使用:

CREATE TYPE box (
    INTERNALLENGTH = 16,
    INPUT = my_box_in_function,
    OUTPUT = my_box_out_function,
    ELEMENT = float4
);

来允许一个box的数值成分成员可以用下标访问。否则该类型和前面的行为一样。

这条命令创建一个大对象类型并将其用于一个表定义:

CREATE TYPE bigobj (
    INPUT = lo_filein, OUTPUT = lo_fileout,
    INTERNALLENGTH = VARIABLE
);
CREATE TABLE big_objs (
    id integer,
    obj bigobj
);

更多的例子,包括合适的输入和输出函数,位于Section 35.11

兼容性

CREATE TYPE命令是PostgreSQL扩展。 在SQL里有一个CREATE TYPE语句,但是细节和PostgreSQL有比较大区别。

又见

CREATE FUNCTION, DROP TYPE, ALTER TYPE, CREATE DOMAIN