Документация по PostgreSQL 9.4.1
Пред.	Уровень выше		След.

ALTER FOREIGN TABLE

Название

ALTER FOREIGN TABLE -- изменить определение сторонней таблицы

Синтаксис

ALTER FOREIGN TABLE [ IF EXISTS ] имя
    действие [, ... ]
ALTER FOREIGN TABLE [ IF EXISTS ] имя
    RENAME [ COLUMN ] имя_колонки TO новое_имя_колонки
ALTER FOREIGN TABLE [ IF EXISTS ] имя
    RENAME TO новое_имя
ALTER FOREIGN TABLE [ IF EXISTS ] имя
    SET SCHEMA новая_схема

Где возможные варианты действие:

    ADD [ COLUMN ] имя_колонки тип_данных [ COLLATE правило_сортировки ] [ ограничение_колонки [ ... ] ]
    DROP [ COLUMN ] [ IF EXISTS ] имя_колонки [ RESTRICT | CASCADE ]
    ALTER [ COLUMN ] имя_колонки [ SET DATA ] TYPE тип_данных
    ALTER [ COLUMN ] имя_колонки SET DEFAULT выражение
    ALTER [ COLUMN ] имя_колонки DROP DEFAULT
    ALTER [ COLUMN ] имя_колонки { SET | DROP } NOT NULL
    ALTER [ COLUMN ] имя_колонки SET STATISTICS integer
    ALTER [ COLUMN ] имя_колонки SET ( атрибут = значение [, ... ] )
    ALTER [ COLUMN ] имя_колонки RESET ( атрибут [, ... ] )
    ALTER [ COLUMN ] имя_колонки OPTIONS ( [ ADD | SET | DROP ] параметр ['значение'] [, ... ])
    DISABLE TRIGGER [ имя_триггера | ALL | USER ]
    ENABLE TRIGGER [ имя_триггера | ALL | USER ]
    ENABLE REPLICA TRIGGER имя_триггера
    ENABLE ALWAYS TRIGGER имя_триггера
    OWNER TO новый_владелец
    OPTIONS ( [ ADD | SET | DROP ] параметр ['значение'] [, ... ])

Описание

ALTER FOREIGN TABLE меняет определение существующей сторонней таблицы. Эта команда имеет несколько разновидностей:

ADD COLUMN: Эта форма добавляет в стороннюю таблицу новую колонку, следуя тому же синтаксису, что и CREATE FOREIGN TABLE. В отличие от добавления колонки в обычную таблицу, при данной операции в базовом хранилище ничего не меняется; эта команда просто объявляет о доступности новой колонки через данную стороннюю таблицу.
DROP COLUMN [ IF EXISTS ]: Эта форма удаляет колонку из сторонней таблицы. Если что-либо зависит от этой колонки, например, представление, для успешного результата потребуется добавить CASCADE. Если указано IF EXISTS и эта колонка не существует, ошибка не происходит, вместо этого выдаётся замечание.
IF EXISTS: Не считать ошибкой, если сторонняя таблица не существует. В этом случае будет выдано замечание.
SET DATA TYPE: Эта форма меняет тип колонки в сторонней таблице.
SET/DROP DEFAULT: Эти формы задают или удаляют значение по умолчанию для колонок. Значения по умолчанию применяются только при последующих командах INSERT или UPDATE; их изменения не отражаются в строках, уже существующих в таблице.
SET/DROP NOT NULL: Устанавливает, будет ли колонка принимать значения NULL или нет.
SET STATISTICS: Эта форма задаёт цель сбора статистики по колонкам для последующих операций ANALYZE. За подробностями обратитесь к описанию подобной формы ALTER TABLE.
SET ( атрибут = значение [, ... ] ) RESET ( атрибут [, ... ] ): Эта форма задаёт или сбрасывает значения атрибутов. За подробностями обратитесь к описанию подобной формы ALTER TABLE.
DISABLE/ENABLE [ REPLICA | ALWAYS ] TRIGGER: Эти формы управляют триггерами, принадлежащими сторонней таблице. За подробностями обратитесь к описанию подобной формы ALTER TABLE.
OWNER: Эта форма меняет владельца сторонней таблицы на заданного пользователя.
RENAME: Формы RENAME меняют имя сторонней таблицы или имя колонки в сторонней таблице.
SET SCHEMA: Эта форма переносит стороннюю таблицу в другую схему.
OPTIONS ( [ ADD | SET | DROP ] параметр ['значение'] [, ... ] ): Эта форма настраивает параметры сторонней таблицы или одной из её колонок. ADD, SET и DROP определяют, какое действие будет выполнено (добавление, установка и удаление, соответственно). Если действие не задано явно, подразумевается ADD. Имена параметров не должны повторяться (хотя параметр таблицы и параметр колонки вполне могут иметь одно имя). Имена и значения параметров также проверяются библиотекой обёртки сторонних данных.

Все действия, кроме RENAME и SET SCHEMA, можно объединить в один список изменений и выполнить одновременно. Например, можно добавить несколько колонок и/или изменить тип колонок одной командой.

Выполнить ALTER FOREIGN TABLE может только владелец соответствующей таблицы. Чтобы сменить схему сторонней таблицы, необходимо также иметь право CREATE в новой схеме. Чтобы сменить владельца, необходимо быть непосредственным или опосредованным членом новой роли-владельца, а эта роль должна иметь право CREATE в схеме таблицы. (С такими ограничениями при смене владельца не происходит ничего такого, что нельзя было бы сделать, имея право удалить и вновь создать таблицу. Однако суперпользователь может сменить владельца таблицы в любом случае.) Чтобы добавить колонку или изменить тип колонки, ещё требуется иметь право USAGE для её типа данных.

Параметры

имя: Имя (возможно, дополненное схемой) существующей сторонней таблицы, подлежащей изменению.
имя_колонки: Имя новой или существующей колонки.
новое_имя_колонки: Новое имя существующей колонки.
новое_имя: Новое имя таблицы.
тип_данных: Тип данных новой колонки или новый тип данных существующей колонки.
CASCADE: Автоматически удалять объекты, зависящие от удаляемой колонки (например, представления, содержащие эту колонку).
RESTRICT: Отказать в удалении колонки, если существуют зависящие от неё объекты. Это поведение по умолчанию.
имя_триггера: Имя включаемого или отключаемого триггера.
ALL: Отключает или включает все триггеры, принадлежащие сторонней таблице. (Если какие-либо из триггеров являются внутрисистемными, для этого требуются права суперпользователя. Сама система не добавляет такие триггеры в сторонние таблицы, но дополнительный код может сделать это.)
USER: Отключает или включает все триггеры, принадлежащие сторонней таблице, кроме сгенерированных внутрисистемных.
новый_владелец: Имя пользователя, назначаемого новым владельцем таблицы.
новая_схема: Имя схемы, в которую будет перемещена таблица.

Замечания

Ключевое слово COLUMN не несёт смысловой нагрузки и может быть опущено.

При добавлении или удалении колонок (ADD COLUMN/DROP COLUMN), добавлении ограничений NOT NULL или изменении типа колонки (SET DATA TYPE) согласованность этих определений с внешним сервером не гарантируется. Ответственность за соответствие определений таблицы удалённой стороне лежит на пользователе.

За более полным описанием параметров обратитесь к CREATE FOREIGN TABLE.

Примеры

Установление ограничения NOT NULL для колонки:

ALTER FOREIGN TABLE distributors ALTER COLUMN street SET NOT NULL;

Изменение параметров сторонней таблицы:

ALTER FOREIGN TABLE myschema.distributors OPTIONS (ADD opt1 'value', SET opt2, 'value2', DROP opt3 'value3');

Совместимость

Формы ADD, DROP и SET DATA TYPE соответствуют стандарту SQL. Другие формы являются собственными расширениями PostgreSQL. Кроме того, возможность указать в одной команде ALTER FOREIGN TABLE несколько операций так же является расширением.

ALTER FOREIGN TABLE DROP COLUMN позволяет удалить единственную колонку сторонней таблицы и оставить таблицу без колонок. Это является расширением стандарта SQL, который не допускает существование сторонних таблиц с нулём колонок.

Пред.	Начало	След.
ALTER FOREIGN DATA WRAPPER	Уровень выше	ALTER FUNCTION

PostgreSQL 9.4.1 Documentation
Prev	Up		Next

ALTER FOREIGN TABLE

Name

ALTER FOREIGN TABLE -- change the definition of a foreign table

Synopsis

ALTER FOREIGN TABLE [ IF EXISTS ] name
    action [, ... ]
ALTER FOREIGN TABLE [ IF EXISTS ] name
    RENAME [ COLUMN ] column_name TO new_column_name
ALTER FOREIGN TABLE [ IF EXISTS ] name
    RENAME TO new_name
ALTER FOREIGN TABLE [ IF EXISTS ] name
    SET SCHEMA new_schema

where action is one of:

    ADD [ COLUMN ] column_name data_type [ COLLATE collation ] [ column_constraint [ ... ] ]
    DROP [ COLUMN ] [ IF EXISTS ] column_name [ RESTRICT | CASCADE ]
    ALTER [ COLUMN ] column_name [ SET DATA ] TYPE data_type
    ALTER [ COLUMN ] column_name SET DEFAULT expression
    ALTER [ COLUMN ] column_name DROP DEFAULT
    ALTER [ COLUMN ] column_name { SET | DROP } NOT NULL
    ALTER [ COLUMN ] column_name SET STATISTICS integer
    ALTER [ COLUMN ] column_name SET ( attribute_option = value [, ... ] )
    ALTER [ COLUMN ] column_name RESET ( attribute_option [, ... ] )
    ALTER [ COLUMN ] column_name OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ])
    DISABLE TRIGGER [ trigger_name | ALL | USER ]
    ENABLE TRIGGER [ trigger_name | ALL | USER ]
    ENABLE REPLICA TRIGGER trigger_name
    ENABLE ALWAYS TRIGGER trigger_name
    OWNER TO new_owner
    OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ])

Description

ALTER FOREIGN TABLE changes the definition of an existing foreign table. There are several subforms:

ADD COLUMN: This form adds a new column to the foreign table, using the same syntax as CREATE FOREIGN TABLE. Unlike the case when adding a column to a regular table, nothing happens to the underlying storage: this action simply declares that some new column is now accessible through the foreign table.
DROP COLUMN [ IF EXISTS ]: This form drops a column from a foreign table. You will need to say CASCADE if anything outside the table depends on the column; for example, views. If IF EXISTS is specified and the column does not exist, no error is thrown. In this case a notice is issued instead.
IF EXISTS: Do not throw an error if the foreign table does not exist. A notice is issued in this case.
SET DATA TYPE: This form changes the type of a column of a foreign table.
SET/DROP DEFAULT: These forms set or remove the default value for a column. Default values only apply in subsequent INSERT or UPDATE commands; they do not cause rows already in the table to change.
SET/DROP NOT NULL: Mark a column as allowing, or not allowing, null values.
SET STATISTICS: This form sets the per-column statistics-gathering target for subsequent ANALYZE operations. See the similar form of ALTER TABLE for more details.
SET ( attribute_option = value [, ... ] ) RESET ( attribute_option [, ... ] ): This form sets or resets per-attribute options. See the similar form of ALTER TABLE for more details.
DISABLE/ENABLE [ REPLICA | ALWAYS ] TRIGGER: These forms configure the firing of trigger(s) belonging to the foreign table. See the similar form of ALTER TABLE for more details.
OWNER: This form changes the owner of the foreign table to the specified user.
RENAME: The RENAME forms change the name of a foreign table or the name of an individual column in a foreign table.
SET SCHEMA: This form moves the foreign table into another schema.
OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ] ): Change options for the foreign table or one of its columns. ADD, SET, and DROP specify the action to be performed. ADD is assumed if no operation is explicitly specified. Duplicate option names are not allowed (although it's OK for a table option and a column option to have the same name). Option names and values are also validated using the foreign data wrapper library.

All the actions except RENAME and SET SCHEMA can be combined into a list of multiple alterations to apply in parallel. For example, it is possible to add several columns and/or alter the type of several columns in a single command.

You must own the table to use ALTER FOREIGN TABLE. To change the schema of a foreign table, 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 table's schema. (These restrictions enforce that altering the owner doesn't do anything you couldn't do by dropping and recreating the table. However, a superuser can alter ownership of any table anyway.) To add a column or alter a column type, you must also have USAGE privilege on the data type.

Parameters

name: The name (possibly schema-qualified) of an existing foreign table to alter.
column_name: Name of a new or existing column.
new_column_name: New name for an existing column.
new_name: New name for the table.
data_type: Data type of the new column, or new data type for an existing column.
CASCADE: Automatically drop objects that depend on the dropped column (for example, views referencing the column).
RESTRICT: Refuse to drop the column if there are any dependent objects. This is the default behavior.
trigger_name: Name of a single trigger to disable or enable.
ALL: Disable or enable all triggers belonging to the foreign table. (This requires superuser privilege if any of the triggers are internally generated triggers. The core system does not add such triggers to foreign tables, but add-on code could do so.)
USER: Disable or enable all triggers belonging to the foreign table except for internally generated triggers.
new_owner: The user name of the new owner of the table.
new_schema: The name of the schema to which the table will be moved.

Notes

The key word COLUMN is noise and can be omitted.

Consistency with the foreign server is not checked when a column is added or removed with ADD COLUMN or DROP COLUMN, a NOT NULL constraint is added, or a column type is changed with SET DATA TYPE. It is the user's responsibility to ensure that the table definition matches the remote side.

Refer to CREATE FOREIGN TABLE for a further description of valid parameters.

Examples

To mark a column as not-null:

ALTER FOREIGN TABLE distributors ALTER COLUMN street SET NOT NULL;

To change options of a foreign table:

ALTER FOREIGN TABLE myschema.distributors OPTIONS (ADD opt1 'value', SET opt2, 'value2', DROP opt3 'value3');

Compatibility

The forms ADD, DROP, and SET DATA TYPE conform with the SQL standard. The other forms are PostgreSQL extensions of the SQL standard. Also, the ability to specify more than one manipulation in a single ALTER FOREIGN TABLE command is an extension.

ALTER FOREIGN TABLE DROP COLUMN can be used to drop the only column of a foreign table, leaving a zero-column table. This is an extension of SQL, which disallows zero-column foreign tables.

Prev	Home	Next
ALTER FOREIGN DATA WRAPPER	Up	ALTER FUNCTION