|
1 | 1 | <!--
|
2 | 2 | Documentation of the system catalogs, directed toward PostgreSQL developers
|
3 |
| - $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.116 2006/01/08 07:00:24 neilc Exp $ |
| 3 | + $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.117 2006/01/16 18:15:30 neilc Exp $ |
4 | 4 | -->
|
5 | 5 |
|
6 | 6 | <chapter id="catalogs">
|
|
284 | 284 | <entry>
|
285 | 285 | The initial value of the transition state. This is a text
|
286 | 286 | field containing the initial value in its external string
|
287 |
| - representation. If this field is null, the transition state |
288 |
| - value starts out null. |
| 287 | + representation. If this field is NULL, the transition state |
| 288 | + value starts out NULL. |
289 | 289 | </entry>
|
290 | 290 | </row>
|
291 | 291 | </tbody>
|
292 | 292 | </tgroup>
|
293 | 293 | </table>
|
294 | 294 |
|
295 | 295 | <para>
|
296 |
| - New aggregate functions are registered with the <command>CREATE |
297 |
| - AGGREGATE</command> command. See <xref linkend="xaggr"> for more |
298 |
| - information about writing aggregate functions and the meaning of |
299 |
| - the transition functions, etc. |
| 296 | + New aggregate functions are registered with the <xref |
| 297 | + linkend="sql-createaggregate" endterm="sql-createaggregate-title"> |
| 298 | + command. See <xref linkend="xaggr"> for more information about |
| 299 | + writing aggregate functions and the meaning of the transition |
| 300 | + functions, etc. |
300 | 301 | </para>
|
301 | 302 |
|
302 | 303 | </sect1>
|
|
1018 | 1019 | <entry><type>bool</type></entry>
|
1019 | 1020 | <entry></entry>
|
1020 | 1021 | <entry>
|
1021 |
| - Role may log in, that is, this role can be given as the initial |
| 1022 | + Role may log in. That is, this role can be given as the initial |
1022 | 1023 | session authorization identifier.
|
1023 | 1024 | </entry>
|
1024 | 1025 | </row>
|
|
1561 | 1562 | <entry><structfield>relukeys</structfield></entry>
|
1562 | 1563 | <entry><type>int2</type></entry>
|
1563 | 1564 | <entry></entry>
|
1564 |
| - <entry>unused (<emphasis>not</emphasis> the number of unique keys)</entry> |
| 1565 | + <entry>Unused (<emphasis>not</emphasis> the number of unique keys)</entry> |
1565 | 1566 | </row>
|
1566 | 1567 |
|
1567 | 1568 | <row>
|
1568 | 1569 | <entry><structfield>relfkeys</structfield></entry>
|
1569 | 1570 | <entry><type>int2</type></entry>
|
1570 | 1571 | <entry></entry>
|
1571 |
| - <entry>unused (<emphasis>not</emphasis> the number of foreign keys on the table)</entry> |
| 1572 | + <entry>Unused (<emphasis>not</emphasis> the number of foreign keys on the table)</entry> |
1572 | 1573 | </row>
|
1573 | 1574 |
|
1574 | 1575 | <row>
|
1575 | 1576 | <entry><structfield>relrefs</structfield></entry>
|
1576 | 1577 | <entry><type>int2</type></entry>
|
1577 | 1578 | <entry></entry>
|
1578 |
| - <entry>unused</entry> |
| 1579 | + <entry>Unused</entry> |
1579 | 1580 | </row>
|
1580 | 1581 |
|
1581 | 1582 | <row>
|
1582 | 1583 | <entry><structfield>relhasoids</structfield></entry>
|
1583 | 1584 | <entry><type>bool</type></entry>
|
1584 | 1585 | <entry></entry>
|
1585 | 1586 | <entry>
|
1586 |
| - True if we generate an OID for each row of the relation. |
| 1587 | + True if we generate an OID for each row of the relation |
1587 | 1588 | </entry>
|
1588 | 1589 | </row>
|
1589 | 1590 |
|
|
1592 | 1593 | <entry><type>bool</type></entry>
|
1593 | 1594 | <entry></entry>
|
1594 | 1595 | <entry>
|
1595 |
| - True if the table has (or once had) a primary key. |
| 1596 | + True if the table has (or once had) a primary key |
1596 | 1597 | </entry>
|
1597 | 1598 | </row>
|
1598 | 1599 |
|
|
1601 | 1602 | <entry><type>bool</type></entry>
|
1602 | 1603 | <entry></entry>
|
1603 | 1604 | <entry>True if table has rules; see
|
1604 |
| - <structname>pg_rewrite</structname> catalog. |
| 1605 | + <structname>pg_rewrite</structname> catalog |
1605 | 1606 | </entry>
|
1606 | 1607 | </row>
|
1607 | 1608 |
|
1608 | 1609 | <row>
|
1609 | 1610 | <entry><structfield>relhassubclass</structfield></entry>
|
1610 | 1611 | <entry><type>bool</type></entry>
|
1611 | 1612 | <entry></entry>
|
1612 |
| - <entry>True if table has (or once had) any inheritance children.</entry> |
| 1613 | + <entry>True if table has (or once had) any inheritance children</entry> |
1613 | 1614 | </row>
|
1614 | 1615 |
|
1615 | 1616 | <row>
|
|
1620 | 1621 | Access privileges; see
|
1621 | 1622 | <xref linkend="sql-grant" endterm="sql-grant-title"> and
|
1622 | 1623 | <xref linkend="sql-revoke" endterm="sql-revoke-title">
|
1623 |
| - for details. |
| 1624 | + for details |
1624 | 1625 | </entry>
|
1625 | 1626 | </row>
|
1626 | 1627 | </tbody>
|
|
2030 | 2031 | Access privileges; see
|
2031 | 2032 | <xref linkend="sql-grant" endterm="sql-grant-title"> and
|
2032 | 2033 | <xref linkend="sql-revoke" endterm="sql-revoke-title">
|
2033 |
| - for details. |
| 2034 | + for details |
2034 | 2035 | </entry>
|
2035 | 2036 | </row>
|
2036 | 2037 | </tbody>
|
|
2131 | 2132 | <entry><type>char</type></entry>
|
2132 | 2133 | <entry></entry>
|
2133 | 2134 | <entry>
|
2134 |
| - A code defining the specific semantics of this dependency relationship; see text. |
| 2135 | + A code defining the specific semantics of this dependency relationship; see text |
2135 | 2136 | </entry>
|
2136 | 2137 | </row>
|
2137 | 2138 |
|
|
2273 | 2274 | <entry><structfield>description</structfield></entry>
|
2274 | 2275 | <entry><type>text</type></entry>
|
2275 | 2276 | <entry></entry>
|
2276 |
| - <entry>Arbitrary text that serves as the description of this object.</entry> |
| 2277 | + <entry>Arbitrary text that serves as the description of this object</entry> |
2277 | 2278 | </row>
|
2278 | 2279 | </tbody>
|
2279 | 2280 | </tgroup>
|
|
2335 | 2336 | <entry><structfield>indisunique</structfield></entry>
|
2336 | 2337 | <entry><type>bool</type></entry>
|
2337 | 2338 | <entry></entry>
|
2338 |
| - <entry>If true, this is a unique index.</entry> |
| 2339 | + <entry>If true, this is a unique index</entry> |
2339 | 2340 | </row>
|
2340 | 2341 |
|
2341 | 2342 | <row>
|
|
2350 | 2351 | <entry><structfield>indisclustered</structfield></entry>
|
2351 | 2352 | <entry><type>bool</type></entry>
|
2352 | 2353 | <entry></entry>
|
2353 |
| - <entry>If true, the table was last clustered on this index.</entry> |
| 2354 | + <entry>If true, the table was last clustered on this index</entry> |
2354 | 2355 | </row>
|
2355 | 2356 |
|
2356 | 2357 | <row>
|
|
2385 | 2386 | <entry>Expression trees (in <function>nodeToString()</function> representation)
|
2386 | 2387 | for index attributes that are not simple column references. This is a
|
2387 | 2388 | list with one element for each zero entry in <structfield>indkey</>.
|
2388 |
| - Null if all index attributes are simple references.</entry> |
| 2389 | + NULL if all index attributes are simple references.</entry> |
2389 | 2390 | </row>
|
2390 | 2391 |
|
2391 | 2392 | <row>
|
2392 | 2393 | <entry><structfield>indpred</structfield></entry>
|
2393 | 2394 | <entry><type>text</type></entry>
|
2394 | 2395 | <entry></entry>
|
2395 | 2396 | <entry>Expression tree (in <function>nodeToString()</function> representation)
|
2396 |
| - for partial index predicate. Null if not a partial index.</entry> |
| 2397 | + for partial index predicate. NULL if not a partial index.</entry> |
2397 | 2398 | </row>
|
2398 | 2399 | </tbody>
|
2399 | 2400 | </tgroup>
|
|
2435 | 2436 | <entry><type>oid</type></entry>
|
2436 | 2437 | <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
|
2437 | 2438 | <entry>
|
2438 |
| - The OID of the child table. |
| 2439 | + The OID of the child table |
2439 | 2440 | </entry>
|
2440 | 2441 | </row>
|
2441 | 2442 |
|
|
2444 | 2445 | <entry><type>oid</type></entry>
|
2445 | 2446 | <entry><literal><link linkend="catalog-pg-class"><structname>pg_class</structname></link>.oid</literal></entry>
|
2446 | 2447 | <entry>
|
2447 |
| - The OID of the parent table. |
| 2448 | + The OID of the parent table |
2448 | 2449 | </entry>
|
2449 | 2450 | </row>
|
2450 | 2451 |
|
|
2556 | 2557 | Access privileges; see
|
2557 | 2558 | <xref linkend="sql-grant" endterm="sql-grant-title"> and
|
2558 | 2559 | <xref linkend="sql-revoke" endterm="sql-revoke-title">
|
2559 |
| - for details. |
| 2560 | + for details |
2560 | 2561 | </entry>
|
2561 | 2562 | </row>
|
2562 | 2563 | </tbody>
|
|
2683 | 2684 | <entry><structfield>listenerpid</structfield></entry>
|
2684 | 2685 | <entry><type>int4</type></entry>
|
2685 | 2686 | <entry></entry>
|
2686 |
| - <entry>PID of the server process that created this entry.</entry> |
| 2687 | + <entry>PID of the server process that created this entry</entry> |
2687 | 2688 | </row>
|
2688 | 2689 |
|
2689 | 2690 | <row>
|
|
2752 | 2753 | Access privileges; see
|
2753 | 2754 | <xref linkend="sql-grant" endterm="sql-grant-title"> and
|
2754 | 2755 | <xref linkend="sql-revoke" endterm="sql-revoke-title">
|
2755 |
| - for details. |
| 2756 | + for details |
2756 | 2757 | </entry>
|
2757 | 2758 | </row>
|
2758 | 2759 | </tbody>
|
|
3030 | 3031 | </table>
|
3031 | 3032 |
|
3032 | 3033 | <para>
|
3033 |
| - Unused column contain zeroes, for example <structfield>oprleft</structfield> is zero for a |
3034 |
| - prefix operator. |
| 3034 | + Unused column contain zeroes. For example, <structfield>oprleft</structfield> |
| 3035 | + is zero for a prefix operator. |
3035 | 3036 | </para>
|
3036 | 3037 |
|
3037 | 3038 | </sect1>
|
|
3123 | 3124 | <para>
|
3124 | 3125 | There are not currently any commands that manipulate procedural language
|
3125 | 3126 | templates; to change the built-in information, a superuser must modify
|
3126 |
| - the table using ordinary INSERT, DELETE, or UPDATE commands. It is |
3127 |
| - likely that a future release of <productname>PostgreSQL</productname> |
3128 |
| - will offer commands to change the entries in a cleaner fashion. |
| 3127 | + the table using ordinary <command>INSERT</command>, <command>DELETE</command>, |
| 3128 | + or <command>UPDATE</command> commands. It is likely that a future |
| 3129 | + release of <productname>PostgreSQL</productname> will offer |
| 3130 | + commands to change the entries in a cleaner fashion. |
3129 | 3131 | </para>
|
3130 | 3132 |
|
3131 | 3133 | <para>
|
|
3349 | 3351 | Access privileges; see
|
3350 | 3352 | <xref linkend="sql-grant" endterm="sql-grant-title"> and
|
3351 | 3353 | <xref linkend="sql-revoke" endterm="sql-revoke-title">
|
3352 |
| - for details. |
| 3354 | + for details |
3353 | 3355 | </entry>
|
3354 | 3356 | </row>
|
3355 | 3357 | </tbody>
|
|
3552 | 3554 | <entry><type>char</type></entry>
|
3553 | 3555 | <entry></entry>
|
3554 | 3556 | <entry>
|
3555 |
| - A code defining the specific semantics of this dependency relationship; see text. |
| 3557 | + A code defining the specific semantics of this dependency relationship; see text |
3556 | 3558 | </entry>
|
3557 | 3559 | </row>
|
3558 | 3560 |
|
|
3743 | 3745 | <entry></entry>
|
3744 | 3746 | <entry>
|
3745 | 3747 | Numerical statistics of the appropriate kind for the
|
3746 |
| - <replaceable>N</>th <quote>slot</quote>, or null if the slot |
3747 |
| - kind does not involve numerical values. |
| 3748 | + <replaceable>N</>th <quote>slot</quote>, or NULL if the slot |
| 3749 | + kind does not involve numerical values |
3748 | 3750 | </entry>
|
3749 | 3751 | </row>
|
3750 | 3752 |
|
|
3754 | 3756 | <entry></entry>
|
3755 | 3757 | <entry>
|
3756 | 3758 | Column data values of the appropriate kind for the
|
3757 |
| - <replaceable>N</>th <quote>slot</quote>, or null if the slot |
| 3759 | + <replaceable>N</>th <quote>slot</quote>, or NULL if the slot |
3758 | 3760 | kind does not store any data values. Each array's element
|
3759 | 3761 | values are actually of the specific column's data type, so there
|
3760 | 3762 | is no way to define these columns' type more specifically than
|
|
3831 | 3833 | Access privileges; see
|
3832 | 3834 | <xref linkend="sql-grant" endterm="sql-grant-title"> and
|
3833 | 3835 | <xref linkend="sql-revoke" endterm="sql-revoke-title">
|
3834 |
| - for details. |
| 3836 | + for details |
3835 | 3837 | </entry>
|
3836 | 3838 | </row>
|
3837 | 3839 | </tbody>
|
|
3955 | 3957 | <entry><structfield>tgargs</structfield></entry>
|
3956 | 3958 | <entry><type>bytea</type></entry>
|
3957 | 3959 | <entry></entry>
|
3958 |
| - <entry>Argument strings to pass to trigger, each null-terminated</entry> |
| 3960 | + <entry>Argument strings to pass to trigger, each NULL-terminated</entry> |
3959 | 3961 | </row>
|
3960 | 3962 | </tbody>
|
3961 | 3963 | </tgroup>
|
|
4374 | 4376 |
|
4375 | 4377 | <row>
|
4376 | 4378 | <entry><link linkend="view-pg-prepared-statements"><structname>pg_prepared_statements</structname></link></entry>
|
4377 |
| - <entry>current prepared statements</entry> |
| 4379 | + <entry>prepared statements</entry> |
4378 | 4380 | </row>
|
4379 | 4381 |
|
4380 | 4382 | <row>
|
4381 | 4383 | <entry><link linkend="view-pg-prepared-xacts"><structname>pg_prepared_xacts</structname></link></entry>
|
4382 |
| - <entry>currently prepared transactions</entry> |
| 4384 | + <entry>prepared transactions</entry> |
4383 | 4385 | </row>
|
4384 | 4386 |
|
4385 | 4387 | <row>
|
|
4684 | 4686 | <entry><type>xid</type></entry>
|
4685 | 4687 | <entry></entry>
|
4686 | 4688 | <entry>
|
4687 |
| - ID of the transaction that is holding or awaiting this lock. |
| 4689 | + ID of the transaction that is holding or awaiting this lock |
4688 | 4690 | </entry>
|
4689 | 4691 | </row>
|
4690 | 4692 | <row>
|
|
4693 | 4695 | <entry></entry>
|
4694 | 4696 | <entry>
|
4695 | 4697 | Process ID of the server process holding or awaiting this
|
4696 |
| - lock. Null if the lock is held by a prepared transaction. |
| 4698 | + lock. NULL if the lock is held by a prepared transaction. |
4697 | 4699 | </entry>
|
4698 | 4700 | </row>
|
4699 | 4701 | <row>
|
|
4801 | 4803 | <para>
|
4802 | 4804 | <structname>pg_prepared_statements</structname> contains one row
|
4803 | 4805 | for each prepared statement. Rows are added to the view when a new
|
4804 |
| - prepared statement is created, and removed when a prepared |
4805 |
| - statement is released (for example, via the <xref |
4806 |
| - linkend="sql-deallocate" endterm="sql-deallocate-title"> |
4807 |
| - command). |
| 4806 | + prepared statement is created and removed when a prepared statement |
| 4807 | + is released (for example, via the <xref linkend="sql-deallocate" |
| 4808 | + endterm="sql-deallocate-title"> command). |
4808 | 4809 | </para>
|
4809 | 4810 |
|
4810 | 4811 | <table>
|
|
4825 | 4826 | <entry><type>text</type></entry>
|
4826 | 4827 | <entry></entry>
|
4827 | 4828 | <entry>
|
4828 |
| - The identifier of the prepared statement. |
| 4829 | + The identifier of the prepared statement |
4829 | 4830 | </entry>
|
4830 | 4831 | </row>
|
4831 | 4832 | <row>
|
|
4846 | 4847 | <entry><type>timestamptz</type></entry>
|
4847 | 4848 | <entry></entry>
|
4848 | 4849 | <entry>
|
4849 |
| - The time at which the prepared statement was created. |
| 4850 | + The time at which the prepared statement was created |
4850 | 4851 | </entry>
|
4851 | 4852 | </row>
|
4852 | 4853 | <row>
|
4853 | 4854 | <entry><structfield>parameter_types</structfield></entry>
|
4854 |
| - <entry><type>oid[]</type></entry> |
| 4855 | + <entry><type>regtype[]</type></entry> |
4855 | 4856 | <entry></entry>
|
4856 | 4857 | <entry>
|
4857 |
| - The expected parameter types for the prepared statement in the form of |
4858 |
| - an array of type OIDs. |
| 4858 | + The expected parameter types for the prepared statement in the |
| 4859 | + form of an array of <type>regtype</type>. The OID corresponding |
| 4860 | + to an element of this array can be obtained by casting the |
| 4861 | + <type>regtype</type> value to <type>oid</type>. |
4859 | 4862 | </entry>
|
4860 | 4863 | </row>
|
4861 | 4864 | <row>
|
|
4866 | 4869 | <literal>true</literal> if the prepared statement was created
|
4867 | 4870 | via the <command>PREPARE</command> SQL statement;
|
4868 | 4871 | <literal>false</literal> if the statement was prepared via the
|
4869 |
| - frontend/backend protocol. |
| 4872 | + frontend/backend protocol |
4870 | 4873 | </entry>
|
4871 | 4874 | </row>
|
4872 | 4875 | </tbody>
|
|
5733 | 5736 | <entry><structfield>definition</structfield></entry>
|
5734 | 5737 | <entry><type>text</type></entry>
|
5735 | 5738 | <entry></entry>
|
5736 |
| - <entry>view definition (a reconstructed SELECT query)</entry> |
| 5739 | + <entry>view definition (a reconstructed <command>SELECT</command> query)</entry> |
5737 | 5740 | </row>
|
5738 | 5741 | </tbody>
|
5739 | 5742 | </tgroup>
|
|
0 commit comments