This is one stop global knowledge base where you can learn about all the products, solutions and support features.
pg_opfamily
The catalog
pg_opfamily
defines operator families. Each operator family is a collection of operators and associated support routines that implement the semantics specified for a particular index access method. Furthermore, the operators in a family are all
“
compatible
”
, in a way that is specified by the access method. The operator family concept allows cross-data-type operators to be used with indexes and to be reasoned about using knowledge of access method semantics.
Operator families are described at length in Section 38.16.
Table 53.35.
pg_opfamily
Columns
Column Type Description |
---|
Row identifier |
Index access method operator family is for |
Name of this operator family |
Namespace of this operator family |
Owner of the operator family |
The majority of the information defining an operator family is not in its
pg_opfamily
row, but in the associated rows in
pg_amop
,
pg_amproc
, and
pg_opclass
.
When an object is created, it is assigned an owner. The owner is normally the role that executed the creation statement. For most kinds of objects, the initial state is that only the owner (or a superuser) can do anything with the object. To allow other roles to use it, privileges must be granted.
There are different kinds of privileges:
SELECT
,
INSERT
,
UPDATE
,
DELETE
,
TRUNCATE
,
REFERENCES
,
TRIGGER
,
CREATE
,
CONNECT
,
TEMPORARY
,
EXECUTE
,
USAGE
,
SET
and
ALTER SYSTEM
. The privileges applicable to a particular object vary depending on the object's type (table, function, etc.). More detail about the meanings of these privileges appears below. The following sections and chapters will also show you how these privileges are used.
The right to modify or destroy an object is inherent in being the object's owner, and cannot be granted or revoked in itself. (However, like all privileges, that right can be inherited by members of the owning role; see Section 22.3.)
An object can be assigned to a new owner with an
ALTER
command of the appropriate kind for the object, for example
ALTER TABLEtable_name
OWNER TOnew_owner
;
Superusers can always do this; ordinary roles can only do it if they are both the current owner of the object (or a member of the owning role) and a member of the new owning role.
To assign privileges, the
GRANT
command is used. For example, if
joe
is an existing role, and
accounts
is an existing table, the privilege to update the table can be granted with:
GRANT UPDATE ON accounts TO joe;
Writing
ALL
in place of a specific privilege grants all privileges that are relevant for the object type.
The special
“
role
”
name
PUBLIC
can be used to grant a privilege to every role on the system. Also,
“
group
”
roles can be set up to help manage privileges when there are many users of a database — for details see Chapter 22.
To revoke a previously-granted privilege, use the fittingly named REVOKE command:
REVOKE ALL ON accounts FROM PUBLIC;
Ordinarily, only the object's owner (or a superuser) can grant or revoke privileges on an object. However, it is possible to grant a privilege “ with grant option ” , which gives the recipient the right to grant it in turn to others. If the grant option is subsequently revoked then all who received the privilege from that recipient (directly or through a chain of grants) will lose the privilege. For details see the GRANT and REVOKE reference pages.
An object's owner can choose to revoke their own ordinary privileges, for example to make a table read-only for themselves as well as others. But owners are always treated as holding all grant options, so they can always re-grant their own privileges.
The available privileges are:
SELECT
Allows
SELECT
from any column, or specific column(s), of a table, view, materialized view, or other table-like object. Also allows use of
COPY TO
. This privilege is also needed to reference existing column values in
UPDATE
or
DELETE
. For sequences, this privilege also allows use of the
currval
function. For large objects, this privilege allows the object to be read.
INSERT
Allows
INSERT
of a new row into a table, view, etc. Can be granted on specific column(s), in which case only those columns may be assigned to in the
INSERT
command (other columns will therefore receive default values). Also allows use of
COPY FROM
.
UPDATE
Allows
UPDATE
of any column, or specific column(s), of a table, view, etc. (In practice, any nontrivial
UPDATE
command will require
SELECT
privilege as well, since it must reference table columns to determine which rows to update, and/or to compute new values for columns.)
SELECT ... FOR UPDATE
and
SELECT ... FOR SHARE
also require this privilege on at least one column, in addition to the
SELECT
privilege. For sequences, this privilege allows use of the
nextval
and
setval
functions. For large objects, this privilege allows writing or truncating the object.
DELETE
Allows
DELETE
of a row from a table, view, etc. (In practice, any nontrivial
DELETE
command will require
SELECT
privilege as well, since it must reference table columns to determine which rows to delete.)
TRUNCATE
Allows
TRUNCATE
on a table.
REFERENCES
Allows creation of a foreign key constraint referencing a table, or specific column(s) of a table.
TRIGGER
Allows creation of a trigger on a table, view, etc.
CREATE
For databases, allows new schemas and publications to be created within the database, and allows trusted extensions to be installed within the database.
For schemas, allows new objects to be created within the schema. To rename an existing object, you must own the object and have this privilege for the containing schema.
For tablespaces, allows tables, indexes, and temporary files to be created within the tablespace, and allows databases to be created that have the tablespace as their default tablespace.
Note that revoking this privilege will not alter the existence or location of existing objects.
CONNECT
Allows the grantee to connect to the database. This privilege is checked at connection startup (in addition to checking any restrictions imposed by
pg_hba.conf
).
TEMPORARY
Allows temporary tables to be created while using the database.
EXECUTE
Allows calling a function or procedure, including use of any operators that are implemented on top of the function. This is the only type of privilege that is applicable to functions and procedures.
USAGE
For procedural languages, allows use of the language for the creation of functions in that language. This is the only type of privilege that is applicable to procedural languages.
For schemas, allows access to objects contained in the schema (assuming that the objects' own privilege requirements are also met). Essentially this allows the grantee to “ look up ” objects within the schema. Without this permission, it is still possible to see the object names, e.g., by querying system catalogs. Also, after revoking this permission, existing sessions might have statements that have previously performed this lookup, so this is not a completely secure way to prevent object access.
For sequences, allows use of the
currval
and
nextval
functions.
For types and domains, allows use of the type or domain in the creation of tables, functions, and other schema objects. (Note that this privilege does not control all “ usage ” of the type, such as values of the type appearing in queries. It only prevents objects from being created that depend on the type. The main purpose of this privilege is controlling which users can create dependencies on a type, which could prevent the owner from changing the type later.)
For foreign-data wrappers, allows creation of new servers using the foreign-data wrapper.
For foreign servers, allows creation of foreign tables using the server. Grantees may also create, alter, or drop their own user mappings associated with that server.
SET
Allows a server configuration parameter to be set to a new value within the current session. (While this privilege can be granted on any parameter, it is meaningless except for parameters that would normally require superuser privilege to set.)
ALTER SYSTEM
Allows a server configuration parameter to be configured to a new value using the ALTER SYSTEM command.
The privileges required by other commands are listed on the reference page of the respective command.
PostgreSQL grants privileges on some types of objects to
PUBLIC
by default when the objects are created. No privileges are granted to
PUBLIC
by default on tables, table columns, sequences, foreign data wrappers, foreign servers, large objects, schemas, tablespaces, or configuration parameters. For other types of objects, the default privileges granted to
PUBLIC
are as follows:
CONNECT
and
TEMPORARY
(create temporary tables) privileges for databases;
EXECUTE
privilege for functions and procedures; and
USAGE
privilege for languages and data types (including domains). The object owner can, of course,
REVOKE
both default and expressly granted privileges. (For maximum security, issue the
REVOKE
in the same transaction that creates the object; then there is no window in which another user can use the object.) Also, these default privilege settings can be overridden using the
ALTER DEFAULT PRIVILEGES
command.
Table 5.1 shows the one-letter abbreviations that are used for these privilege types in ACL (Access Control List) values. You will see these letters in the output of the psql commands listed below, or when looking at ACL columns of system catalogs.
Table 5.1. ACL Privilege Abbreviations
Privilege | Abbreviation | Applicable Object Types |
---|---|---|
SELECT
|
r
(
“
read
”
)
|
LARGE OBJECT
,
SEQUENCE
,
TABLE
(and table-like objects), table column
|
INSERT
|
a
(
“
append
”
)
|
TABLE
, table column
|
UPDATE
|
w
(
“
write
”
)
|
LARGE OBJECT
,
SEQUENCE
,
TABLE
, table column
|
DELETE
|
d
|
TABLE
|
TRUNCATE
|
D
|
TABLE
|
REFERENCES
|
x
|
TABLE
, table column
|
TRIGGER
|
t
|
TABLE
|
CREATE
|
C
|
DATABASE
,
SCHEMA
,
TABLESPACE
|
CONNECT
|
c
|
DATABASE
|
TEMPORARY
|
T
|
DATABASE
|
EXECUTE
|
X
|
FUNCTION
,
PROCEDURE
|
USAGE
|
U
|
DOMAIN
,
FOREIGN DATA WRAPPER
,
FOREIGN SERVER
,
LANGUAGE
,
SCHEMA
,
SEQUENCE
,
TYPE
|
SET
|
s
|
PARAMETER
|
ALTER SYSTEM
|
A
|
PARAMETER
|
Table 5.2 summarizes the privileges available for each type of SQL object, using the abbreviations shown above. It also shows the psql command that can be used to examine privilege settings for each object type.
Table 5.2. Summary of Access Privileges
Object Type | All Privileges |
Default
PUBLIC
Privileges
|
psql Command |
---|---|---|---|
DATABASE
|
CTc
|
Tc
|
\l
|
DOMAIN
|
U
|
U
|
\dD+
|
FUNCTION
or
PROCEDURE
|
X
|
X
|
\df+
|
FOREIGN DATA WRAPPER
|
U
|
none |
\dew+
|
FOREIGN SERVER
|
U
|
none |
\des+
|
LANGUAGE
|
U
|
U
|
\dL+
|
LARGE OBJECT
|
rw
|
none |
\dl+
|
PARAMETER
|
sA
|
none |
\dconfig+
|
SCHEMA
|
UC
|
none |
\dn+
|
SEQUENCE
|
rwU
|
none |
\dp
|
TABLE
(and table-like objects)
|
arwdDxt
|
none |
\dp
|
Table column |
arwx
|
none |
\dp
|
TABLESPACE
|
C
|
none |
\db+
|
TYPE
|
U
|
U
|
\dT+
|
The privileges that have been granted for a particular object are displayed as a list of
aclitem
entries, where each
aclitem
describes the permissions of one grantee that have been granted by a particular grantor. For example,
calvin=r*w/hobbes
specifies that the role
calvin
has the privilege
SELECT
(
r
) with grant option (
*
) as well as the non-grantable privilege
UPDATE
(
w
), both granted by the role
hobbes
. If
calvin
also has some privileges on the same object granted by a different grantor, those would appear as a separate
aclitem
entry. An empty grantee field in an
aclitem
stands for
PUBLIC
.
As an example, suppose that user
miriam
creates table
mytable
and does:
GRANT SELECT ON mytable TO PUBLIC; GRANT SELECT, UPDATE, INSERT ON mytable TO admin; GRANT SELECT (col1), UPDATE (col1) ON mytable TO miriam_rw;
Then
psql
's
\dp
command would show:
=> \dp mytable Access privileges Schema | Name | Type | Access privileges | Column privileges | Policies --------+---------+-------+-----------------------+-----------------------+---------- public | mytable | table | miriam=arwdDxt/miriam+| col1: +| | | | =r/miriam +| miriam_rw=rw/miriam | | | | admin=arw/miriam | | (1 row)
If the
“
Access privileges
”
column is empty for a given object, it means the object has default privileges (that is, its privileges entry in the relevant system catalog is null). Default privileges always include all privileges for the owner, and can include some privileges for
PUBLIC
depending on the object type, as explained above. The first
GRANT
or
REVOKE
on an object will instantiate the default privileges (producing, for example,
miriam=arwdDxt/miriam
) and then modify them per the specified request. Similarly, entries are shown in
“
Column privileges
”
only for columns with nondefault privileges. (Note: for this purpose,
“
default privileges
”
always means the built-in default privileges for the object's type. An object whose privileges have been affected by an
ALTER DEFAULT PRIVILEGES
command will always be shown with an explicit privilege entry that includes the effects of the
ALTER
.)
Notice that the owner's implicit grant options are not marked in the access privileges display. A
*
will appear only when grant options have been explicitly granted to someone.
When an object is created, it is assigned an owner. The owner is normally the role that executed the creation statement. For most kinds of objects, the initial state is that only the owner (or a superuser) can do anything with the object. To allow other roles to use it, privileges must be granted.
There are different kinds of privileges:
SELECT
,
INSERT
,
UPDATE
,
DELETE
,
TRUNCATE
,
REFERENCES
,
TRIGGER
,
CREATE
,
CONNECT
,
TEMPORARY
,
EXECUTE
,
USAGE
,
SET
and
ALTER SYSTEM
. The privileges applicable to a particular object vary depending on the object's type (table, function, etc.). More detail about the meanings of these privileges appears below. The following sections and chapters will also show you how these privileges are used.
The right to modify or destroy an object is inherent in being the object's owner, and cannot be granted or revoked in itself. (However, like all privileges, that right can be inherited by members of the owning role; see Section 22.3.)
An object can be assigned to a new owner with an
ALTER
command of the appropriate kind for the object, for example
ALTER TABLEtable_name
OWNER TOnew_owner
;
Superusers can always do this; ordinary roles can only do it if they are both the current owner of the object (or a member of the owning role) and a member of the new owning role.
To assign privileges, the
GRANT
command is used. For example, if
joe
is an existing role, and
accounts
is an existing table, the privilege to update the table can be granted with:
GRANT UPDATE ON accounts TO joe;
Writing
ALL
in place of a specific privilege grants all privileges that are relevant for the object type.
The special
“
role
”
name
PUBLIC
can be used to grant a privilege to every role on the system. Also,
“
group
”
roles can be set up to help manage privileges when there are many users of a database — for details see Chapter 22.
To revoke a previously-granted privilege, use the fittingly named REVOKE command:
REVOKE ALL ON accounts FROM PUBLIC;
Ordinarily, only the object's owner (or a superuser) can grant or revoke privileges on an object. However, it is possible to grant a privilege “ with grant option ” , which gives the recipient the right to grant it in turn to others. If the grant option is subsequently revoked then all who received the privilege from that recipient (directly or through a chain of grants) will lose the privilege. For details see the GRANT and REVOKE reference pages.
An object's owner can choose to revoke their own ordinary privileges, for example to make a table read-only for themselves as well as others. But owners are always treated as holding all grant options, so they can always re-grant their own privileges.
The available privileges are:
SELECT
Allows
SELECT
from any column, or specific column(s), of a table, view, materialized view, or other table-like object. Also allows use of
COPY TO
. This privilege is also needed to reference existing column values in
UPDATE
or
DELETE
. For sequences, this privilege also allows use of the
currval
function. For large objects, this privilege allows the object to be read.
INSERT
Allows
INSERT
of a new row into a table, view, etc. Can be granted on specific column(s), in which case only those columns may be assigned to in the
INSERT
command (other columns will therefore receive default values). Also allows use of
COPY FROM
.
UPDATE
Allows
UPDATE
of any column, or specific column(s), of a table, view, etc. (In practice, any nontrivial
UPDATE
command will require
SELECT
privilege as well, since it must reference table columns to determine which rows to update, and/or to compute new values for columns.)
SELECT ... FOR UPDATE
and
SELECT ... FOR SHARE
also require this privilege on at least one column, in addition to the
SELECT
privilege. For sequences, this privilege allows use of the
nextval
and
setval
functions. For large objects, this privilege allows writing or truncating the object.
DELETE
Allows
DELETE
of a row from a table, view, etc. (In practice, any nontrivial
DELETE
command will require
SELECT
privilege as well, since it must reference table columns to determine which rows to delete.)
TRUNCATE
Allows
TRUNCATE
on a table.
REFERENCES
Allows creation of a foreign key constraint referencing a table, or specific column(s) of a table.
TRIGGER
Allows creation of a trigger on a table, view, etc.
CREATE
For databases, allows new schemas and publications to be created within the database, and allows trusted extensions to be installed within the database.
For schemas, allows new objects to be created within the schema. To rename an existing object, you must own the object and have this privilege for the containing schema.
For tablespaces, allows tables, indexes, and temporary files to be created within the tablespace, and allows databases to be created that have the tablespace as their default tablespace.
Note that revoking this privilege will not alter the existence or location of existing objects.
CONNECT
Allows the grantee to connect to the database. This privilege is checked at connection startup (in addition to checking any restrictions imposed by
pg_hba.conf
).
TEMPORARY
Allows temporary tables to be created while using the database.
EXECUTE
Allows calling a function or procedure, including use of any operators that are implemented on top of the function. This is the only type of privilege that is applicable to functions and procedures.
USAGE
For procedural languages, allows use of the language for the creation of functions in that language. This is the only type of privilege that is applicable to procedural languages.
For schemas, allows access to objects contained in the schema (assuming that the objects' own privilege requirements are also met). Essentially this allows the grantee to “ look up ” objects within the schema. Without this permission, it is still possible to see the object names, e.g., by querying system catalogs. Also, after revoking this permission, existing sessions might have statements that have previously performed this lookup, so this is not a completely secure way to prevent object access.
For sequences, allows use of the
currval
and
nextval
functions.
For types and domains, allows use of the type or domain in the creation of tables, functions, and other schema objects. (Note that this privilege does not control all “ usage ” of the type, such as values of the type appearing in queries. It only prevents objects from being created that depend on the type. The main purpose of this privilege is controlling which users can create dependencies on a type, which could prevent the owner from changing the type later.)
For foreign-data wrappers, allows creation of new servers using the foreign-data wrapper.
For foreign servers, allows creation of foreign tables using the server. Grantees may also create, alter, or drop their own user mappings associated with that server.
SET
Allows a server configuration parameter to be set to a new value within the current session. (While this privilege can be granted on any parameter, it is meaningless except for parameters that would normally require superuser privilege to set.)
ALTER SYSTEM
Allows a server configuration parameter to be configured to a new value using the ALTER SYSTEM command.
The privileges required by other commands are listed on the reference page of the respective command.
PostgreSQL grants privileges on some types of objects to
PUBLIC
by default when the objects are created. No privileges are granted to
PUBLIC
by default on tables, table columns, sequences, foreign data wrappers, foreign servers, large objects, schemas, tablespaces, or configuration parameters. For other types of objects, the default privileges granted to
PUBLIC
are as follows:
CONNECT
and
TEMPORARY
(create temporary tables) privileges for databases;
EXECUTE
privilege for functions and procedures; and
USAGE
privilege for languages and data types (including domains). The object owner can, of course,
REVOKE
both default and expressly granted privileges. (For maximum security, issue the
REVOKE
in the same transaction that creates the object; then there is no window in which another user can use the object.) Also, these default privilege settings can be overridden using the
ALTER DEFAULT PRIVILEGES
command.
Table 5.1 shows the one-letter abbreviations that are used for these privilege types in ACL (Access Control List) values. You will see these letters in the output of the psql commands listed below, or when looking at ACL columns of system catalogs.
Table 5.1. ACL Privilege Abbreviations
Privilege | Abbreviation | Applicable Object Types |
---|---|---|
SELECT
|
r
(
“
read
”
)
|
LARGE OBJECT
,
SEQUENCE
,
TABLE
(and table-like objects), table column
|
INSERT
|
a
(
“
append
”
)
|
TABLE
, table column
|
UPDATE
|
w
(
“
write
”
)
|
LARGE OBJECT
,
SEQUENCE
,
TABLE
, table column
|
DELETE
|
d
|
TABLE
|
TRUNCATE
|
D
|
TABLE
|
REFERENCES
|
x
|
TABLE
, table column
|
TRIGGER
|
t
|
TABLE
|
CREATE
|
C
|
DATABASE
,
SCHEMA
,
TABLESPACE
|
CONNECT
|
c
|
DATABASE
|
TEMPORARY
|
T
|
DATABASE
|
EXECUTE
|
X
|
FUNCTION
,
PROCEDURE
|
USAGE
|
U
|
DOMAIN
,
FOREIGN DATA WRAPPER
,
FOREIGN SERVER
,
LANGUAGE
,
SCHEMA
,
SEQUENCE
,
TYPE
|
SET
|
s
|
PARAMETER
|
ALTER SYSTEM
|
A
|
PARAMETER
|
Table 5.2 summarizes the privileges available for each type of SQL object, using the abbreviations shown above. It also shows the psql command that can be used to examine privilege settings for each object type.
Table 5.2. Summary of Access Privileges
Object Type | All Privileges |
Default
PUBLIC
Privileges
|
psql Command |
---|---|---|---|
DATABASE
|
CTc
|
Tc
|
\l
|
DOMAIN
|
U
|
U
|
\dD+
|
FUNCTION
or
PROCEDURE
|
X
|
X
|
\df+
|
FOREIGN DATA WRAPPER
|
U
|
none |
\dew+
|
FOREIGN SERVER
|
U
|
none |
\des+
|
LANGUAGE
|
U
|
U
|
\dL+
|
LARGE OBJECT
|
rw
|
none |
\dl+
|
PARAMETER
|
sA
|
none |
\dconfig+
|
SCHEMA
|
UC
|
none |
\dn+
|
SEQUENCE
|
rwU
|
none |
\dp
|
TABLE
(and table-like objects)
|
arwdDxt
|
none |
\dp
|
Table column |
arwx
|
none |
\dp
|
TABLESPACE
|
C
|
none |
\db+
|
TYPE
|
U
|
U
|
\dT+
|
The privileges that have been granted for a particular object are displayed as a list of
aclitem
entries, where each
aclitem
describes the permissions of one grantee that have been granted by a particular grantor. For example,
calvin=r*w/hobbes
specifies that the role
calvin
has the privilege
SELECT
(
r
) with grant option (
*
) as well as the non-grantable privilege
UPDATE
(
w
), both granted by the role
hobbes
. If
calvin
also has some privileges on the same object granted by a different grantor, those would appear as a separate
aclitem
entry. An empty grantee field in an
aclitem
stands for
PUBLIC
.
As an example, suppose that user
miriam
creates table
mytable
and does:
GRANT SELECT ON mytable TO PUBLIC; GRANT SELECT, UPDATE, INSERT ON mytable TO admin; GRANT SELECT (col1), UPDATE (col1) ON mytable TO miriam_rw;
Then
psql
's
\dp
command would show:
=> \dp mytable Access privileges Schema | Name | Type | Access privileges | Column privileges | Policies --------+---------+-------+-----------------------+-----------------------+---------- public | mytable | table | miriam=arwdDxt/miriam+| col1: +| | | | =r/miriam +| miriam_rw=rw/miriam | | | | admin=arw/miriam | | (1 row)
If the
“
Access privileges
”
column is empty for a given object, it means the object has default privileges (that is, its privileges entry in the relevant system catalog is null). Default privileges always include all privileges for the owner, and can include some privileges for
PUBLIC
depending on the object type, as explained above. The first
GRANT
or
REVOKE
on an object will instantiate the default privileges (producing, for example,
miriam=arwdDxt/miriam
) and then modify them per the specified request. Similarly, entries are shown in
“
Column privileges
”
only for columns with nondefault privileges. (Note: for this purpose,
“
default privileges
”
always means the built-in default privileges for the object's type. An object whose privileges have been affected by an
ALTER DEFAULT PRIVILEGES
command will always be shown with an explicit privilege entry that includes the effects of the
ALTER
.)
Notice that the owner's implicit grant options are not marked in the access privileges display. A
*
will appear only when grant options have been explicitly granted to someone.
A domain is a user-defined data type that is based on another underlying type . Optionally, it can have constraints that restrict its valid values to a subset of what the underlying type would allow. Otherwise it behaves like the underlying type — for example, any operator or function that can be applied to the underlying type will work on the domain type. The underlying type can be any built-in or user-defined base type, enum type, array type, composite type, range type, or another domain.
For example, we could create a domain over integers that accepts only positive integers:
CREATE DOMAIN posint AS integer CHECK (VALUE > 0); CREATE TABLE mytable (id posint); INSERT INTO mytable VALUES(1); -- works INSERT INTO mytable VALUES(-1); -- fails
When an operator or function of the underlying type is applied to a domain value, the domain is automatically down-cast to the underlying type. Thus, for example, the result of
mytable.id - 1
is considered to be of type
integer
not
posint
. We could write
(mytable.id - 1)::posint
to cast the result back to
posint
, causing the domain's constraints to be rechecked. In this case, that would result in an error if the expression had been applied to an
id
value of 1. Assigning a value of the underlying type to a field or variable of the domain type is allowed without writing an explicit cast, but the domain's constraints will be checked.
For additional information see CREATE DOMAIN .
A domain is a user-defined data type that is based on another underlying type . Optionally, it can have constraints that restrict its valid values to a subset of what the underlying type would allow. Otherwise it behaves like the underlying type — for example, any operator or function that can be applied to the underlying type will work on the domain type. The underlying type can be any built-in or user-defined base type, enum type, array type, composite type, range type, or another domain.
For example, we could create a domain over integers that accepts only positive integers:
CREATE DOMAIN posint AS integer CHECK (VALUE > 0); CREATE TABLE mytable (id posint); INSERT INTO mytable VALUES(1); -- works INSERT INTO mytable VALUES(-1); -- fails
When an operator or function of the underlying type is applied to a domain value, the domain is automatically down-cast to the underlying type. Thus, for example, the result of
mytable.id - 1
is considered to be of type
integer
not
posint
. We could write
(mytable.id - 1)::posint
to cast the result back to
posint
, causing the domain's constraints to be rechecked. In this case, that would result in an error if the expression had been applied to an
id
value of 1. Assigning a value of the underlying type to a field or variable of the domain type is allowed without writing an explicit cast, but the domain's constraints will be checked.
For additional information see CREATE DOMAIN .
Data types are a way to limit the kind of data that can be stored in a table. For many applications, however, the constraint they provide is too coarse. For example, a column containing a product price should probably only accept positive values. But there is no standard data type that accepts only positive numbers. Another issue is that you might want to constrain column data with respect to other columns or rows. For example, in a table containing product information, there should be only one row for each product number.
To that end, SQL allows you to define constraints on columns and tables. Constraints give you as much control over the data in your tables as you wish. If a user attempts to store data in a column that would violate a constraint, an error is raised. This applies even if the value came from the default value definition.
A check constraint is the most generic constraint type. It allows you to specify that the value in a certain column must satisfy a Boolean (truth-value) expression. For instance, to require positive product prices, you could use:
CREATE TABLE products (
product_no integer,
name text,
price numeric CHECK (price > 0)
);
As you see, the constraint definition comes after the data type, just like default value definitions. Default values and constraints can be listed in any order. A check constraint consists of the key word
CHECK
followed by an expression in parentheses. The check constraint expression should involve the column thus constrained, otherwise the constraint would not make too much sense.
You can also give the constraint a separate name. This clarifies error messages and allows you to refer to the constraint when you need to change it. The syntax is:
CREATE TABLE products (
product_no integer,
name text,
price numeric CONSTRAINT positive_price CHECK (price > 0)
);
So, to specify a named constraint, use the key word
CONSTRAINT
followed by an identifier followed by the constraint definition. (If you don't specify a constraint name in this way, the system chooses a name for you.)
A check constraint can also refer to several columns. Say you store a regular price and a discounted price, and you want to ensure that the discounted price is lower than the regular price:
CREATE TABLE products (
product_no integer,
name text,
price numeric CHECK (price > 0),
discounted_price numeric CHECK (discounted_price > 0),
CHECK (price > discounted_price)
);
The first two constraints should look familiar. The third one uses a new syntax. It is not attached to a particular column, instead it appears as a separate item in the comma-separated column list. Column definitions and these constraint definitions can be listed in mixed order.
We say that the first two constraints are column constraints, whereas the third one is a table constraint because it is written separately from any one column definition. Column constraints can also be written as table constraints, while the reverse is not necessarily possible, since a column constraint is supposed to refer to only the column it is attached to. ( PostgreSQL doesn't enforce that rule, but you should follow it if you want your table definitions to work with other database systems.) The above example could also be written as:
CREATE TABLE products ( product_no integer, name text, price numeric, CHECK (price > 0), discounted_price numeric, CHECK (discounted_price > 0), CHECK (price > discounted_price) );
or even:
CREATE TABLE products ( product_no integer, name text, price numeric CHECK (price > 0), discounted_price numeric, CHECK (discounted_price > 0 AND price > discounted_price) );
It's a matter of taste.
Names can be assigned to table constraints in the same way as column constraints:
CREATE TABLE products (
product_no integer,
name text,
price numeric,
CHECK (price > 0),
discounted_price numeric,
CHECK (discounted_price > 0),
CONSTRAINT valid_discount CHECK (price > discounted_price)
);
It should be noted that a check constraint is satisfied if the check expression evaluates to true or the null value. Since most expressions will evaluate to the null value if any operand is null, they will not prevent null values in the constrained columns. To ensure that a column does not contain null values, the not-null constraint described in the next section can be used.
PostgreSQL
does not support
CHECK
constraints that reference table data other than the new or updated row being checked. While a
CHECK
constraint that violates this rule may appear to work in simple tests, it cannot guarantee that the database will not reach a state in which the constraint condition is false (due to subsequent changes of the other row(s) involved). This would cause a database dump and restore to fail. The restore could fail even when the complete database state is consistent with the constraint, due to rows not being loaded in an order that will satisfy the constraint. If possible, use
UNIQUE
,
EXCLUDE
, or
FOREIGN KEY
constraints to express cross-row and cross-table restrictions.
If what you desire is a one-time check against other rows at row insertion, rather than a continuously-maintained consistency guarantee, a custom trigger can be used to implement that. (This approach avoids the dump/restore problem because pg_dump does not reinstall triggers until after restoring data, so that the check will not be enforced during a dump/restore.)
PostgreSQL
assumes that
CHECK
constraints' conditions are immutable, that is, they will always give the same result for the same input row. This assumption is what justifies examining
CHECK
constraints only when rows are inserted or updated, and not at other times. (The warning above about not referencing other table data is really a special case of this restriction.)
An example of a common way to break this assumption is to reference a user-defined function in a
CHECK
expression, and then change the behavior of that function.
PostgreSQL
does not disallow that, but it will not notice if there are rows in the table that now violate the
CHECK
constraint. That would cause a subsequent database dump and restore to fail. The recommended way to handle such a change is to drop the constraint (using
ALTER TABLE
), adjust the function definition, and re-add the constraint, thereby rechecking it against all table rows.
A not-null constraint simply specifies that a column must not assume the null value. A syntax example:
CREATE TABLE products ( product_no integer NOT NULL, name text NOT NULL, price numeric );
A not-null constraint is always written as a column constraint. A not-null constraint is functionally equivalent to creating a check constraint
CHECK (
, but in
PostgreSQL
creating an explicit not-null constraint is more efficient. The drawback is that you cannot give explicit names to not-null constraints created this way.
column_name
IS NOT NULL)
Of course, a column can have more than one constraint. Just write the constraints one after another:
CREATE TABLE products ( product_no integer NOT NULL, name text NOT NULL, price numeric NOT NULL CHECK (price > 0) );
The order doesn't matter. It does not necessarily determine in which order the constraints are checked.
The
NOT NULL
constraint has an inverse: the
NULL
constraint. This does not mean that the column must be null, which would surely be useless. Instead, this simply selects the default behavior that the column might be null. The
NULL
constraint is not present in the SQL standard and should not be used in portable applications. (It was only added to
PostgreSQL
to be compatible with some other database systems.) Some users, however, like it because it makes it easy to toggle the constraint in a script file. For example, you could start with:
CREATE TABLE products ( product_no integer NULL, name text NULL, price numeric NULL );
and then insert the
NOT
key word where desired.
In most database designs the majority of columns should be marked not null.
Unique constraints ensure that the data contained in a column, or a group of columns, is unique among all the rows in the table. The syntax is:
CREATE TABLE products (
product_no integer UNIQUE,
name text,
price numeric
);
when written as a column constraint, and:
CREATE TABLE products (
product_no integer,
name text,
price numeric,
UNIQUE (product_no)
);
when written as a table constraint.
To define a unique constraint for a group of columns, write it as a table constraint with the column names separated by commas:
CREATE TABLE example (
a integer,
b integer,
c integer,
UNIQUE (a, c)
);
This specifies that the combination of values in the indicated columns is unique across the whole table, though any one of the columns need not be (and ordinarily isn't) unique.
You can assign your own name for a unique constraint, in the usual way:
CREATE TABLE products (
product_no integer CONSTRAINT must_be_different UNIQUE,
name text,
price numeric
);
Adding a unique constraint will automatically create a unique B-tree index on the column or group of columns listed in the constraint. A uniqueness restriction covering only some rows cannot be written as a unique constraint, but it is possible to enforce such a restriction by creating a unique partial index.
In general, a unique constraint is violated if there is more than one row in the table where the values of all of the columns included in the constraint are equal. By default, two null values are not considered equal in this comparison. That means even in the presence of a unique constraint it is possible to store duplicate rows that contain a null value in at least one of the constrained columns. This behavior can be changed by adding the clause
NULLS NOT DISTINCT
, like
CREATE TABLE products (
product_no integer UNIQUE NULLS NOT DISTINCT,
name text,
price numeric
);
or
CREATE TABLE products (
product_no integer,
name text,
price numeric,
UNIQUE NULLS NOT DISTINCT (product_no)
);
The default behavior can be specified explicitly using
NULLS DISTINCT
. The default null treatment in unique constraints is implementation-defined according to the SQL standard, and other implementations have a different behavior. So be careful when developing applications that are intended to be portable.
A primary key constraint indicates that a column, or group of columns, can be used as a unique identifier for rows in the table. This requires that the values be both unique and not null. So, the following two table definitions accept the same data:
CREATE TABLE products ( product_no integer UNIQUE NOT NULL, name text, price numeric );
CREATE TABLE products (
product_no integer PRIMARY KEY,
name text,
price numeric
);
Primary keys can span more than one column; the syntax is similar to unique constraints:
CREATE TABLE example (
a integer,
b integer,
c integer,
PRIMARY KEY (a, c)
);
Adding a primary key will automatically create a unique B-tree index on the column or group of columns listed in the primary key, and will force the column(s) to be marked
NOT NULL
.
A table can have at most one primary key. (There can be any number of unique and not-null constraints, which are functionally almost the same thing, but only one can be identified as the primary key.) Relational database theory dictates that every table must have a primary key. This rule is not enforced by PostgreSQL , but it is usually best to follow it.
Primary keys are useful both for documentation purposes and for client applications. For example, a GUI application that allows modifying row values probably needs to know the primary key of a table to be able to identify rows uniquely. There are also various ways in which the database system makes use of a primary key if one has been declared; for example, the primary key defines the default target column(s) for foreign keys referencing its table.
A foreign key constraint specifies that the values in a column (or a group of columns) must match the values appearing in some row of another table. We say this maintains the referential integrity between two related tables.
Say you have the product table that we have used several times already:
CREATE TABLE products ( product_no integer PRIMARY KEY, name text, price numeric );
Let's also assume you have a table storing orders of those products. We want to ensure that the orders table only contains orders of products that actually exist. So we define a foreign key constraint in the orders table that references the products table:
CREATE TABLE orders (
order_id integer PRIMARY KEY,
product_no integer REFERENCES products (product_no),
quantity integer
);
Now it is impossible to create orders with non-NULL
product_no
entries that do not appear in the products table.
We say that in this situation the orders table is the referencing table and the products table is the referenced table. Similarly, there are referencing and referenced columns.
You can also shorten the above command to:
CREATE TABLE orders (
order_id integer PRIMARY KEY,
product_no integer REFERENCES products,
quantity integer
);
because in absence of a column list the primary key of the referenced table is used as the referenced column(s).
You can assign your own name for a foreign key constraint, in the usual way.
A foreign key can also constrain and reference a group of columns. As usual, it then needs to be written in table constraint form. Here is a contrived syntax example:
CREATE TABLE t1 (
a integer PRIMARY KEY,
b integer,
c integer,
FOREIGN KEY (b, c) REFERENCES other_table (c1, c2)
);
Of course, the number and type of the constrained columns need to match the number and type of the referenced columns.
Sometimes it is useful for the “ other table ” of a foreign key constraint to be the same table; this is called a self-referential foreign key. For example, if you want rows of a table to represent nodes of a tree structure, you could write
CREATE TABLE tree ( node_id integer PRIMARY KEY, parent_id integer REFERENCES tree, name text, ... );
A top-level node would have NULL
parent_id
, while non-NULL
parent_id
entries would be constrained to reference valid rows of the table.
A table can have more than one foreign key constraint. This is used to implement many-to-many relationships between tables. Say you have tables about products and orders, but now you want to allow one order to contain possibly many products (which the structure above did not allow). You could use this table structure:
CREATE TABLE products ( product_no integer PRIMARY KEY, name text, price numeric ); CREATE TABLE orders ( order_id integer PRIMARY KEY, shipping_address text, ... ); CREATE TABLE order_items ( product_no integer REFERENCES products, order_id integer REFERENCES orders, quantity integer, PRIMARY KEY (product_no, order_id) );
Notice that the primary key overlaps with the foreign keys in the last table.
We know that the foreign keys disallow creation of orders that do not relate to any products. But what if a product is removed after an order is created that references it? SQL allows you to handle that as well. Intuitively, we have a few options:
Disallow deleting a referenced product
Delete the orders as well
Something else?
To illustrate this, let's implement the following policy on the many-to-many relationship example above: when someone wants to remove a product that is still referenced by an order (via
order_items
), we disallow it. If someone removes an order, the order items are removed as well:
CREATE TABLE products ( product_no integer PRIMARY KEY, name text, price numeric ); CREATE TABLE orders ( order_id integer PRIMARY KEY, shipping_address text, ... ); CREATE TABLE order_items ( product_no integer REFERENCES products ON DELETE RESTRICT, order_id integer REFERENCES orders ON DELETE CASCADE, quantity integer, PRIMARY KEY (product_no, order_id) );
Restricting and cascading deletes are the two most common options.
RESTRICT
prevents deletion of a referenced row.
NO ACTION
means that if any referencing rows still exist when the constraint is checked, an error is raised; this is the default behavior if you do not specify anything. (The essential difference between these two choices is that
NO ACTION
allows the check to be deferred until later in the transaction, whereas
RESTRICT
does not.)
CASCADE
specifies that when a referenced row is deleted, row(s) referencing it should be automatically deleted as well. There are two other options:
SET NULL
and
SET DEFAULT
. These cause the referencing column(s) in the referencing row(s) to be set to nulls or their default values, respectively, when the referenced row is deleted. Note that these do not excuse you from observing any constraints. For example, if an action specifies
SET DEFAULT
but the default value would not satisfy the foreign key constraint, the operation will fail.
The appropriate choice of
ON DELETE
action depends on what kinds of objects the related tables represent. When the referencing table represents something that is a component of what is represented by the referenced table and cannot exist independently, then
CASCADE
could be appropriate. If the two tables represent independent objects, then
RESTRICT
or
NO ACTION
is more appropriate; an application that actually wants to delete both objects would then have to be explicit about this and run two delete commands. In the above example, order items are part of an order, and it is convenient if they are deleted automatically if an order is deleted. But products and orders are different things, and so making a deletion of a product automatically cause the deletion of some order items could be considered problematic. The actions
SET NULL
or
SET DEFAULT
can be appropriate if a foreign-key relationship represents optional information. For example, if the products table contained a reference to a product manager, and the product manager entry gets deleted, then setting the product's product manager to null or a default might be useful.
The actions
SET NULL
and
SET DEFAULT
can take a column list to specify which columns to set. Normally, all columns of the foreign-key constraint are set; setting only a subset is useful in some special cases. Consider the following example:
CREATE TABLE tenants (
tenant_id integer PRIMARY KEY
);
CREATE TABLE users (
tenant_id integer REFERENCES tenants ON DELETE CASCADE,
user_id integer NOT NULL,
PRIMARY KEY (tenant_id, user_id)
);
CREATE TABLE posts (
tenant_id integer REFERENCES tenants ON DELETE CASCADE,
post_id integer NOT NULL,
author_id integer,
PRIMARY KEY (tenant_id, post_id),
FOREIGN KEY (tenant_id, author_id) REFERENCES users ON DELETE SET NULL (author_id)
);
Without the specification of the column, the foreign key would also set the column
tenant_id
to null, but that column is still required as part of the primary key.
Analogous to
ON DELETE
there is also
ON UPDATE
which is invoked when a referenced column is changed (updated). The possible actions are the same, except that column lists cannot be specified for
SET NULL
and
SET DEFAULT
. In this case,
CASCADE
means that the updated values of the referenced column(s) should be copied into the referencing row(s).
Normally, a referencing row need not satisfy the foreign key constraint if any of its referencing columns are null. If
MATCH FULL
is added to the foreign key declaration, a referencing row escapes satisfying the constraint only if all its referencing columns are null (so a mix of null and non-null values is guaranteed to fail a
MATCH FULL
constraint). If you don't want referencing rows to be able to avoid satisfying the foreign key constraint, declare the referencing column(s) as
NOT NULL
.
A foreign key must reference columns that either are a primary key or form a unique constraint. This means that the referenced columns always have an index (the one underlying the primary key or unique constraint); so checks on whether a referencing row has a match will be efficient. Since a
DELETE
of a row from the referenced table or an
UPDATE
of a referenced column will require a scan of the referencing table for rows matching the old value, it is often a good idea to index the referencing columns too. Because this is not always needed, and there are many choices available on how to index, declaration of a foreign key constraint does not automatically create an index on the referencing columns.
More information about updating and deleting data is in Chapter 6. Also see the description of foreign key constraint syntax in the reference documentation for CREATE TABLE .
Exclusion constraints ensure that if any two rows are compared on the specified columns or expressions using the specified operators, at least one of these operator comparisons will return false or null. The syntax is:
CREATE TABLE circles ( c circle, EXCLUDE USING gist (c WITH &&) );
See also
CREATE TABLE ... CONSTRAINT ... EXCLUDE
for details.
Adding an exclusion constraint will automatically create an index of the type specified in the constraint declaration.