pgadmin4/docs/en_US/domain_constraint_dialog.rst

46 lines
2.6 KiB
ReStructuredText
Raw Normal View History

2016-05-24 07:47:35 -05:00
.. _domain_constraint:
2016-05-13 08:43:57 -05:00
2016-05-24 07:47:35 -05:00
****************************
The Domain Constraint Dialog
****************************
2016-05-13 08:43:57 -05:00
2016-05-24 07:47:35 -05:00
Use the *Domain Constraint* dialog to create a domain constraint. A domain constraint confirms that the values provided for a domain meet a defined criteria. The *Domain Constraint* dialog implements options of the ALTER DOMAIN command.
2016-05-13 08:43:57 -05:00
2016-05-24 07:47:35 -05:00
The *Domain Constraint* dialog organizes the development of a domain constraint through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
2016-05-13 08:43:57 -05:00
2016-05-20 15:39:21 -05:00
.. image:: images/domain_constraint_general.png
2016-05-13 08:43:57 -05:00
Use the fields in the *General* tab to identify the domain constraint:
2016-05-24 07:47:35 -05:00
2016-05-13 08:43:57 -05:00
* Use the *Name* field to add a descriptive name for the constraint. The name will be displayed in the *pgAdmin* tree control.
2016-05-24 07:47:35 -05:00
* Store notes about the constraint in the *Comment* field.
2016-05-13 08:43:57 -05:00
Click the *Definition* tab to continue.
2016-05-20 15:39:21 -05:00
.. image:: images/domain_constraint_definition.png
2016-05-13 08:43:57 -05:00
Use the fields in the *Definition* tab to define the domain constraint:
* Use the *Check* field to write a CHECK expression. A CHECK clause specifies a constraint that the domain must satisfy. A constraint must be an expression producing a Boolean result; include the key word VALUE to refer to the value being tested. Only those expressions that evaluate to TRUE or UNKNOWN succeed. A CHECK expressions cannot contain subqueries or refer to variables other than VALUE. When a domain has multiple CHECK constraints, they will be tested in alphabetical order by name.
* Move the *Validate?* switch to the *No* position to mark the constraint NOT VALID. If the constraint is marked NOT VALID, the constraint will not be applied to existing column data. The default value is *Yes*.
Click the *SQL* tab to continue.
2016-05-24 07:47:35 -05:00
Your entries in the *Domain Constraint* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit or switch tabs to make any changes to the SQL command.
**Example**
The following is an example of the sql command generated by user selections in the *Domain Constraint* dialog:
2016-05-20 15:39:21 -05:00
.. image:: images/domain_constraint_sql.png
2016-05-24 07:47:35 -05:00
The example shown demonstrates creating a domain constraint on the domain *timesheets* named *weekday*. It constrains a value to equal *Friday*.
2016-05-13 08:43:57 -05:00
2016-05-24 07:47:35 -05:00
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
2016-05-13 08:43:57 -05:00
* Click the *Save* button to save work.
* Click the *Cancel* button to exit without saving work.
* Click the *Reset* button to restore configuration parameters.
2016-05-24 07:47:35 -05:00
2016-05-13 08:43:57 -05:00