ALTER_FOREIGN_TABLE(7pg13)

📦 version 13.23, in opensuse-leap 16.0

💅 ALTER FOREIGN TABLE 💅

okay bestie, so this is the ALTER FOREIGN TABLE page from the PostgreSQL 13.23 docs — section 7, the one about foreign tables. if you've got a foreign table and you're like "hmm this needs a glow-up," you're literally in the right place. no cap. 🦋

✨ SYNOPSIS ✨

like, here's the shape of the thing:

ALTER FOREIGN TABLE [ IF EXISTS ] [ ONLY ] name [ * ]
    action [, ... ]
ALTER FOREIGN TABLE [ IF EXISTS ] [ ONLY ] 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

and action is one of these iconic lil numbers:

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 [ COLLATE collation ]
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 SET STORAGE { PLAIN | EXTERNAL | EXTENDED | MAIN }
ALTER [ COLUMN ] column_name OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ])
ADD table_constraint [ NOT VALID ]
VALIDATE CONSTRAINT constraint_name
DROP CONSTRAINT [ IF EXISTS ]  constraint_name [ RESTRICT | CASCADE ]
DISABLE TRIGGER [ trigger_name | ALL | USER ]
ENABLE TRIGGER [ trigger_name | ALL | USER ]
ENABLE REPLICA TRIGGER trigger_name
ENABLE ALWAYS TRIGGER trigger_name
SET WITHOUT OIDS
INHERIT parent_table
NO INHERIT parent_table
OWNER TO { new_owner | CURRENT_USER | SESSION_USER }
OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ])

🌸 DESCRIPTION 🌸

ALTER FOREIGN TABLE changes the definition of an existing foreign table. (yes, that's the whole vibe — it's a makeover command.) there are several subforms, and they all have their own little personality:

ADD COLUMN

adds a new column to the foreign table, using the same syntax as CREATE FOREIGN TABLE (CREATE_FOREIGN_TABLE(7)). and here's the tea: unlike adding a column to a regular table, nothing happens to the underlying storage — this action just declares that some new column is now accessible through the foreign table. that's it. that's the whole move. 💅

DROP COLUMN [ IF EXISTS ]

drops a column from a foreign table. you'll need to say CASCADE if anything outside the table depends on the column — views, for example. if IF EXISTS is specified and the column doesn't exist, no error is thrown; instead a notice is issued. polite. 🎀

SET DATA TYPE

changes the type of a column of a foreign table. again — no effect on any underlying storage. this action simply changes the type that PostgreSQL believes the column to have. it's giving "manifesting." ✨

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. no retroactive plot twists. 🙈

SET/DROP NOT NULL

marks a column as allowing, or not allowing, null values. simple as that bestie.

SET STATISTICS

sets the per-column statistics-gathering target for subsequent ANALYZE(7) operations. see the similar form of ALTER TABLE (ALTER_TABLE(7)) for more details.

SET ( attribute_option = value [, ... ] ) / RESET ( attribute_option [, ... ] )

sets or resets per-attribute options. again, check the similar form of ALTER TABLE (ALTER_TABLE(7)) for the deets.

SET STORAGE

sets the storage mode for a column. see the similar form of ALTER TABLE (ALTER_TABLE(7)) for more details. ⚠️ note that the storage mode has no effect unless the table's foreign-data wrapper chooses to pay attention to it. so like, it's a vibe suggestion, not a demand.

ADD table_constraint [ NOT VALID ]

adds a new constraint to a foreign table, using the same syntax as CREATE FOREIGN TABLE (CREATE_FOREIGN_TABLE(7)). currently only CHECK constraints are supported. 🫶

unlike the case when adding a constraint to a regular table, nothing is done to verify the constraint is correct — rather, this action simply declares that some new condition should be assumed to hold for all rows in the foreign table. (see the discussion in CREATE FOREIGN TABLE (CREATE_FOREIGN_TABLE(7)).) if the constraint is marked NOT VALID, then it isn't assumed to hold, but is only recorded for possible future use.

VALIDATE CONSTRAINT

marks as valid a constraint that was previously marked as NOT VALID. no action is taken to verify the constraint, but future queries will assume that it holds. trust fall. 🤝

DROP CONSTRAINT [ IF EXISTS ]

drops the specified constraint on a foreign table. if IF EXISTS is specified and the constraint doesn't exist, no error is thrown — a notice is issued instead.

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 (ALTER_TABLE(7)) for more details.

SET WITHOUT OIDS

backward compatibility syntax for removing the oid system column. since oid system columns cannot be added anymore, this never has an effect. it's a historical artifact, we stan a relic. 🏛️

INHERIT parent_table

adds the target foreign table as a new child of the specified parent table. see the similar form of ALTER TABLE (ALTER_TABLE(7)) for more details.

NO INHERIT parent_table

removes the target foreign table from the list of children of the specified parent table. it's giving "we're not related anymore." 💀

OWNER

changes the owner of the foreign table to the specified user.

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. 👑

RENAME

the RENAME forms change the name of a foreign table or the name of an individual column in a foreign table.

SET SCHEMA

moves the foreign table into another schema. relocation era. 🦋

all the actions except RENAME and SET SCHEMA can be combined into a list of multiple alterations to apply in parallel. for example, it's possible to add several columns and/or alter the type of several columns in a single command. efficiency queen. ⭐

if the command is written as ALTER FOREIGN TABLE IF EXISTS ... and the foreign table does not exist, no error is thrown. a notice is issued in this case.

💜 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. if ONLY is specified before the table name, only that table is altered. if ONLY is not specified, the table and all its descendant tables (if any) are altered. optionally, * can be specified after the table name to explicitly indicate that descendant tables are included.
  • 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.
  • table_constraint — new table constraint for the foreign table.
  • constraint_name — name of an existing constraint to drop.
  • CASCADE — automatically drop objects that depend on the dropped column or constraint (for example, views referencing the column), and in turn all objects that depend on those objects (see Section 5.14). chain reaction, lowkey scary. 🔥
  • RESTRICT — refuse to drop the column or constraint 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.
  • parent_table — a parent table to associate or de-associate with this foreign table.
  • 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. we love a low-effort keyword.

⚠️ consistency with the foreign server is NOT checked when a column is added or removed with ADD COLUMN or DROP COLUMN, a NOT NULL or CHECK 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. fr fr, that's on you bestie. 😭

refer to CREATE FOREIGN TABLE (CREATE_FOREIGN_TABLE(7)) 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);

🧚 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. zero columns, zero problems? iconic honestly. 💅

🫶 SEE ALSO 🫶

aaaand that's the whole page bestie, you ate it up. 🍓 this was PostgreSQL 13.23, dated 2025, and it lives at ALTER FOREIGN TABLE(7) — go forth and alter your foreign tables responsibly, mwah 💖✨

📦 where this page comes from