Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 3dddb2a

Browse files
committed
Doc: add a glossary entry for "domain".
Anton Voloshin and Jürgen Purtz, reviewed by Laurenz Albe Discussion: https://postgr.es/m/2ea65bdf-1380-f088-02bd-ff1a31ed265c@postgrespro.ru
1 parent 5d44fff commit 3dddb2a

File tree

6 files changed

+25
-7
lines changed

6 files changed

+25
-7
lines changed

doc/src/sgml/charset.sgml

+2-1
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,8 @@ initdb --locale=sv_SE
346346
collation. (The built-in collatable data types are
347347
<type>text</type>, <type>varchar</type>, and <type>char</type>.
348348
User-defined base types can also be marked collatable, and of course
349-
a domain over a collatable data type is collatable.) If the
349+
a <glossterm linkend="glossary-domain">domain</glossterm> over a
350+
collatable data type is collatable.) If the
350351
expression is a column reference, the collation of the expression is the
351352
defined collation of the column. If the expression is a constant, the
352353
collation is the default collation of the data type of the

doc/src/sgml/earthdistance.sgml

+2-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@
5050
<para>
5151
Data is stored in cubes that are points (both corners are the same) using 3
5252
coordinates representing the x, y, and z distance from the center of the
53-
Earth. A domain <type>earth</type> over <type>cube</type> is provided, which
53+
Earth. A <glossterm linkend="glossary-domain">domain</glossterm>
54+
<type>earth</type> over type <type>cube</type> is provided, which
5455
includes constraint checks that the value meets these restrictions and
5556
is reasonably close to the actual surface of the Earth.
5657
</para>

doc/src/sgml/glossary.sgml

+15-2
Original file line numberDiff line numberDiff line change
@@ -390,8 +390,7 @@
390390
A restriction on the values of data allowed within a
391391
<glossterm linkend="glossary-table">table</glossterm>,
392392
or in attributes of a
393-
<!-- XXX Should have term "domain". Need term "type" for that. -->
394-
<firstterm>domain</firstterm>.
393+
<glossterm linkend="glossary-domain">domain</glossterm>.
395394
</para>
396395
<para>
397396
For more information, see
@@ -508,6 +507,20 @@
508507
</glossdef>
509508
</glossentry>
510509

510+
<glossentry id="glossary-domain">
511+
<glossterm>Domain</glossterm>
512+
<glossdef>
513+
<para>
514+
A user-defined data type that is based on another underlying data type.
515+
It acts the same as the underlying type except for possibly restricting
516+
the set of allowed values.
517+
</para>
518+
<para>
519+
For more information, see <xref linkend="domains"/>.
520+
</para>
521+
</glossdef>
522+
</glossentry>
523+
511524
<glossentry id="glossary-durability">
512525
<glossterm>Durability</glossterm>
513526
<glossdef>

doc/src/sgml/information_schema.sgml

+2-1
Original file line numberDiff line numberDiff line change
@@ -2577,7 +2577,8 @@
25772577
<title><literal>domains</literal></title>
25782578

25792579
<para>
2580-
The view <literal>domains</literal> contains all domains defined in the
2580+
The view <literal>domains</literal> contains all
2581+
<glossterm linkend="glossary-domain">domains</glossterm> defined in the
25812582
current database. Only those domains are shown that the current user has
25822583
access to (by way of being the owner or having some privilege).
25832584
</para>

doc/src/sgml/lo.sgml

+2-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@
5555

5656
<para>
5757
The module also provides a data type <type>lo</type>, which is really just
58-
a domain of the <type>oid</type> type. This is useful for differentiating
58+
a <glossterm linkend="glossary-domain">domain</glossterm> over
59+
the <type>oid</type> type. This is useful for differentiating
5960
database columns that hold large object references from those that are
6061
OIDs of other things. You don't have to use the <type>lo</type> type to
6162
use the trigger, but it may be convenient to use it to keep track of which

doc/src/sgml/rowtypes.sgml

+2-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ CREATE TABLE inventory_item (
8484
restriction of the current implementation: since no constraints are
8585
associated with a composite type, the constraints shown in the table
8686
definition <emphasis>do not apply</emphasis> to values of the composite type
87-
outside the table. (To work around this, create a domain over the composite
87+
outside the table. (To work around this, create a
88+
<glossterm linkend="glossary-domain">domain</glossterm> over the composite
8889
type, and apply the desired constraints as <literal>CHECK</literal>
8990
constraints of the domain.)
9091
</para>

0 commit comments

Comments
 (0)