ALTER TYPE
ALTER TYPE — изменить определение типа
Синтаксис
ALTER TYPEимядействие[, ... ] ALTER TYPEимяOWNER TO {новый_владелец| CURRENT_USER | SESSION_USER } ALTER TYPEимяRENAME ATTRIBUTEимя_атрибутаTOновое_имя_атрибута[ CASCADE | RESTRICT ] ALTER TYPEимяRENAME TOновое_имяALTER TYPEимяSET SCHEMAновая_схемаALTER TYPEимяADD VALUE [ IF NOT EXISTS ]новое_значение_перечисления[ { BEFORE | AFTER }существующее_значение_перечисления] Гдедействиеможет быть следующим: ADD ATTRIBUTEимя_атрибутатип_данных[ COLLATEправило_сортировки] [ CASCADE | RESTRICT ] DROP ATTRIBUTE [ IF EXISTS ]имя_атрибута[ CASCADE | RESTRICT ] ALTER ATTRIBUTEимя_атрибута[ SET DATA ] TYPEтип_данных[ COLLATEправило_сортировки] [ CASCADE | RESTRICT ]
Описание
ALTER TYPE изменяет определение существующего типа. Эта команда имеет несколько разновидностей:
ADD ATTRIBUTEЭта форма добавляет в составной тип новый атрибут с тем же синтаксисом, что и CREATE TYPE.
DROP ATTRIBUTE [ IF EXISTS ]Эта форма удаляет атрибут из составного типа. Если указано
IF EXISTSи атрибут не существует, это не считается ошибкой. В этом случае выдаётся только замечание.SET DATA TYPEЭта форма меняет тип атрибута составного типа.
OWNERЭта форма меняет владельца типа.
RENAMEЭта форма меняет имя типа или имя отдельного атрибута составного типа.
SET SCHEMAЭта форма переносит тип в другую схему.
ADD VALUE [ IF NOT EXISTS ] [ BEFORE | AFTER ]Эта форма добавляет новое значение в тип-перечисление. Порядок нового значения в перечислении можно указать, добавив
BEFORE(перед) илиAFTER(после) с одним из существующих значений. Если такое указание отсутствует, новый элемент добавляется в конец списка значений.С указанием
IF NOT EXISTS, если тип уже содержит новое значение, ошибки не произойдёт: будет выдано замечание и ничего больше. Без этого указания, если такое значение уже представлено, возникнет ошибка.CASCADEАвтоматически распространять действие операции на типизированные таблицы, имеющий данный тип, и их потомки.
RESTRICTОтказать в выполнении операции, если изменяемый тип является типом типизированной таблицы. Это поведение по умолчанию.
Операции ADD ATTRIBUTE, DROP ATTRIBUTE и ALTER ATTRIBUTE можно объединить в один список множественных изменений для параллельного выполнения. Например, в одной команде можно добавить сразу несколько атрибутов и/или изменить тип нескольких атрибутов.
Выполнить ALTER TYPE может только владелец соответствующего типа. Чтобы сменить схему типа, необходимо также иметь право CREATE в новой схеме. Чтобы сменить владельца, необходимо быть непосредственным или опосредованным членом новой роли-владельца, а эта роль должна иметь право CREATE в схеме типа. (С такими ограничениями при смене владельца не происходит ничего такого, что нельзя было бы сделать, имея право удалить и вновь создать тип. Однако суперпользователь может сменить владельца типа в любом случае.) Чтобы добавить атрибут или изменить тип атрибута, также требуется иметь право USAGE для соответствующего типа данных.
Параметры
имяИмя (возможно, дополненное схемой) существующего типа, подлежащего изменению.
новое_имяНовое имя типа.
новый_владелецИмя пользователя, назначаемого новым владельцем типа.
новая_схемаНовая схема типа.
имя_атрибутаИмя атрибута, подлежащего добавлению, изменению или удалению.
новое_имя_атрибутаНовое имя атрибута
тип_данныхТип данных добавляемого атрибута, либо новый тип данных изменяемого атрибута.
новое_значение_перечисленияНовое значение добавляется в список значений перечисления. Как и все элементы перечисления, оно должно заключаться в кавычки.
существующее_значение_перечисленияСуществующие значение в перечислении, непосредственно перед или после которого по порядку перечисления будет добавлено новое значение. Как и все элементы перечисления, оно должно заключаться в кавычки.
Замечания
ALTER TYPE ... ADD VALUE (форму, добавляющую в тип-перечисление новое значение) нельзя выполнять внутри блока транзакции.
Сравнения с добавленными значениями перечисления иногда бывают медленнее сравнений, в которых задействуются только начальные члены типа-перечисления. Обычно это происходит, только если BEFORE или AFTER устанавливает порядок нового элемента не в конце списка. Однако иногда это наблюдается даже тогда, когда новое значение добавляется в конец списка (это происходит, если счётчик OID «прокручивается» с момента изначального создания типа-перечисления). Это замедление обычно несущественное, но если это важно, вернуть максимальную производительность можно, удалив и создав заново это перечисление, либо выгрузив копию базы данных и загрузив её вновь.
Примеры
Переименование типа данных:
ALTER TYPE electronic_mail RENAME TO email;
Смена владельца типа email на joe:
ALTER TYPE email OWNER TO joe;
Смена схемы типа email на customers:
ALTER TYPE email SET SCHEMA customers;
Добавление в тип нового атрибута:
ALTER TYPE compfoo ADD ATTRIBUTE f3 int;
Добавление нового значения в тип-перечисление, в определённое положение по порядку:
ALTER TYPE colors ADD VALUE 'orange' AFTER 'red';
Совместимость
Формы команды, предназначенные для добавления и удаления атрибутов, являются частью стандарта SQL; другие формы относятся к расширениям Postgres Pro.
См. также
CREATE TYPE, DROP TYPEALTER TYPE
ALTER TYPE — change the definition of a type
Synopsis
ALTER TYPEnameaction[, ... ] ALTER TYPEnameOWNER TO {new_owner| CURRENT_USER | SESSION_USER } ALTER TYPEnameRENAME ATTRIBUTEattribute_nameTOnew_attribute_name[ CASCADE | RESTRICT ] ALTER TYPEnameRENAME TOnew_nameALTER TYPEnameSET SCHEMAnew_schemaALTER TYPEnameADD VALUE [ IF NOT EXISTS ]new_enum_value[ { BEFORE | AFTER }existing_enum_value] whereactionis one of: ADD ATTRIBUTEattribute_namedata_type[ COLLATEcollation] [ CASCADE | RESTRICT ] DROP ATTRIBUTE [ IF EXISTS ]attribute_name[ CASCADE | RESTRICT ] ALTER ATTRIBUTEattribute_name[ SET DATA ] TYPEdata_type[ COLLATEcollation] [ CASCADE | RESTRICT ]
Description
ALTER TYPE changes the definition of an existing type. There are several subforms:
ADD ATTRIBUTEThis form adds a new attribute to a composite type, using the same syntax as CREATE TYPE.
DROP ATTRIBUTE [ IF EXISTS ]This form drops an attribute from a composite type. If
IF EXISTSis specified and the attribute does not exist, no error is thrown. In this case a notice is issued instead.SET DATA TYPEThis form changes the type of an attribute of a composite type.
OWNERThis form changes the owner of the type.
RENAMEThis form changes the name of the type or the name of an individual attribute of a composite type.
SET SCHEMAThis form moves the type into another schema.
ADD VALUE [ IF NOT EXISTS ] [ BEFORE | AFTER ]This form adds a new value to an enum type. The new value's place in the enum's ordering can be specified as being
BEFOREorAFTERone of the existing values. Otherwise, the new item is added at the end of the list of values.If
IF NOT EXISTSis specified, it is not an error if the type already contains the new value: a notice is issued but no other action is taken. Otherwise, an error will occur if the new value is already present.CASCADEAutomatically propagate the operation to typed tables of the type being altered, and their descendants.
RESTRICTRefuse the operation if the type being altered is the type of a typed table. This is the default.
The ADD ATTRIBUTE, DROP ATTRIBUTE, and ALTER ATTRIBUTE actions can be combined into a list of multiple alterations to apply in parallel. For example, it is possible to add several attributes and/or alter the type of several attributes in a single command.
You must own the type to use ALTER TYPE. To change the schema of a type, you must also have CREATE privilege on the new schema. To alter the owner, you must also be a direct or indirect member of the new owning role, and that role must have CREATE privilege on the type's schema. (These restrictions enforce that altering the owner doesn't do anything you couldn't do by dropping and recreating the type. However, a superuser can alter ownership of any type anyway.) To add an attribute or alter an attribute type, you must also have USAGE privilege on the data type.
Parameters
nameThe name (possibly schema-qualified) of an existing type to alter.
new_nameThe new name for the type.
new_ownerThe user name of the new owner of the type.
new_schemaThe new schema for the type.
attribute_nameThe name of the attribute to add, alter, or drop.
new_attribute_nameThe new name of the attribute to be renamed.
data_typeThe data type of the attribute to add, or the new type of the attribute to alter.
new_enum_valueThe new value to be added to an enum type's list of values. Like all enum literals, it needs to be quoted.
existing_enum_valueThe existing enum value that the new value should be added immediately before or after in the enum type's sort ordering. Like all enum literals, it needs to be quoted.
Notes
ALTER TYPE ... ADD VALUE (the form that adds a new value to an enum type) cannot be executed inside a transaction block.
Comparisons involving an added enum value will sometimes be slower than comparisons involving only original members of the enum type. This will usually only occur if BEFORE or AFTER is used to set the new value's sort position somewhere other than at the end of the list. However, sometimes it will happen even though the new value is added at the end (this occurs if the OID counter “wrapped around” since the original creation of the enum type). The slowdown is usually insignificant; but if it matters, optimal performance can be regained by dropping and recreating the enum type, or by dumping and reloading the database.
Examples
To rename a data type:
ALTER TYPE electronic_mail RENAME TO email;
To change the owner of the type email to joe:
ALTER TYPE email OWNER TO joe;
To change the schema of the type email to customers:
ALTER TYPE email SET SCHEMA customers;
To add a new attribute to a type:
ALTER TYPE compfoo ADD ATTRIBUTE f3 int;
To add a new value to an enum type in a particular sort position:
ALTER TYPE colors ADD VALUE 'orange' AFTER 'red';
Compatibility
The variants to add and drop attributes are part of the SQL standard; the other variants are Postgres Pro extensions.