ALTER TABLE

Name

ALTER TABLE -- Modifies table properties

Synopsis

ALTER TABLE [ ONLY ] table [ * ] 
    ADD [ COLUMN ] column type [ column_constraint [ ... ] ]
ALTER TABLE [ ONLY ] table [ * ]
    ALTER [ COLUMN ] column { SET DEFAULT value | DROP DEFAULT }
ALTER TABLE [ ONLY ] table [ * ]
    ALTER [ COLUMN ] column SET STATISTICS integer
ALTER TABLE [ ONLY ] table [ * ] RENAME [ COLUMN ] column TO newcolumn
ALTER TABLE table RENAME TO new_table
ALTER TABLE table ADD table_constraint_definition
ALTER TABLE [ ONLY ] table 
     DROP CONSTRAINT constraint { RESTRICT | CASCADE }
ALTER TABLE table OWNER TO new_owner 
  

Inputs

table

The name of an existing table that you want to alter:

  • ONLY table changes apply only to the current table

  • table * changes apply to the current table and its children

  • table changes apply depending on the inheritance mode from configuration option SQL_INHERITANCE. (Refer to the section on Run Time Configuration in the Red Hat Database Administrator and User's Guide.)

column

Name of a new or existing column.

type

Type of the new column.

newcolumn

New name for an existing column.

newtable

New name for the table.

table constraint definition

New table constraint for the table

newowner

The user name of the new owner of the table.

Outputs

ALTER

Message returned from column or table renaming.

ERROR: ALTER TABLE: "reason"

Message returned if table or column is not available or if some other error reason is encountered.

Description

ALTER TABLE changes the definition of an existing table.

You must own the table in order to change its schema.

Notes

The keyword COLUMN is superfluous and can be omitted.

In the current implementation of ADD COLUMN, default and NOT NULL clauses for the new column are not supported. You can use the SET DEFAULT form of ALTER TABLE to set the default later. (You will also have to update the already existing rows to the new default value, using UPDATE.)

In DROP CONSTRAINT, the RESTRICT keyword is required, although dependencies are not yet checked. The CASCADE option is unsupported. Currently DROP CONSTRAINT drops only CHECK constraints. To remove a PRIMARY or UNIQUE constraint, drop the relevant index using the DROP INDEX command. To remove FOREIGN KEY constraints you need to recreate and reload the table, using other parameters to the CREATE TABLE command.

For example, to drop all constraints on a table distributors:
CREATE TABLE temp AS SELECT * FROM distributors;
DROP TABLE distributors;
CREATE TABLE distributors AS SELECT * FROM temp;
DROP TABLE temp;

You must own the table in order to change it. Changing any part of the schema of a system catalog is not permitted. Refer to the Section called Inheritance in Chapter 1 for more information on inheritance.

Refer to CREATE TABLE for a further description of valid arguments.

Usage

Create a table to be used in the following examples:
CREATE TABLE tmp (initial int4);

To add a column of type int4 to a table:
ALTER TABLE tmp ADD COLUMN a int4;

To rename an existing column:
ALTER TABLE tmp RENAME COLUMN a TO aa;

To rename an existing table:
ALTER TABLE tmp RENAME TO tmpa;

To add a check constraint to a table:
ALTER TABLE distributors ADD CONSTRAINT zipchk 
   CHECK (char_length(zipcode) = 5);

To remove a check constraint from a table and all its children:
ALTER TABLE distributors DROP CONSTRAINT zipchk RESTRICT;

To add a foreign key constraint to a table:
CREATE TABLE tmpx (a int4 primary key);
ALTER TABLE tmpa ADD CONSTRAINT tmpconstr foreign key(b) 
reference tmpx(a) MATCH FULL;

To add a (multicolumn) unique constraint to a table:
ALTER TABLE distributors ADD CONSTRAINT dist_id_zipcode_key
   UNIQUE (dist_id, zipcode);

To add an automatically named primary key constraint to a table (note that a table can only ever have one primary key):
ALTER TABLE distributors ADD PRIMARY KEY (dist_id);

Compatibility

SQL92

The ADD COLUMN form is compliant with the exception that it does not support defaults and NOT NULL constraints, as explained above. The ALTER COLUMN form is in full compliance.

SQL92 specifies some additional capabilities for ALTER TABLE statement which are not yet directly supported by PostgreSQL:

ALTER TABLE table DROP [ COLUMN ] column { RESTRICT | CASCADE }
      

Removes a column from a table. Currently, you must recreate and reload the table in order to remove an existing column:
CREATE TABLE temp AS SELECT did, city FROM distributors;    
DROP TABLE distributors;
CREATE TABLE distributors (
    did      DECIMAL(3)  DEFAULT 1,
    name     VARCHAR(40) NOT NULL
);
INSERT INTO distributors SELECT * FROM temp;
DROP TABLE temp;

The clauses to rename tables, columns, indexes, and sequences are PostgreSQL extensions to SQL92.