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

Commit 934c213

Browse files
committed
Documentation cleanup
1 parent fa5c8a0 commit 934c213

13 files changed

+377
-362
lines changed

doc/src/sgml/ecpg.sgml

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.53 2003/10/17 18:57:00 tgl Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.54 2003/11/12 22:47:47 petere Exp $
33
-->
44

55
<chapter id="ecpg">
@@ -284,7 +284,7 @@ EXEC SQL COMMIT;
284284
</para>
285285

286286
<para>
287-
Single-row Select:
287+
Single-row select:
288288
<programlisting>
289289
EXEC SQL SELECT foo INTO :FooBar FROM table1 WHERE ascii = 'doodad';
290290
</programlisting>
@@ -359,7 +359,7 @@ EXEC SQL AT <replaceable>connection-name</replaceable> SELECT ...;
359359
The second option is to execute a statement to switch the current
360360
connection. That statement is:
361361
<programlisting>
362-
SET CONNECTION <replaceable>connection-name</replaceable>;
362+
EXEC SQL SET CONNECTION <replaceable>connection-name</replaceable>;
363363
</programlisting>
364364
This option is particularly convenient if many statements are to be
365365
executed on the same connection.
@@ -392,7 +392,7 @@ SET CONNECTION <replaceable>connection-name</replaceable>;
392392
write the name of a C variable into the SQL statement, prefixed by
393393
a colon. For example:
394394
<programlisting>
395-
INSERT INTO sometable VALUES (:v1, 'foo', :v2);
395+
EXEC SQL INSERT INTO sometable VALUES (:v1, 'foo', :v2);
396396
</programlisting>
397397
This statements refers to two C variables named
398398
<varname>v1</varname> and <varname>v2</varname> and also uses a
@@ -592,7 +592,7 @@ EXEC SQL BEGIN DECLARE SECTION;
592592
const char *stmt = "CREATE TABLE test1 (...);";
593593
EXEC SQL END DECLARE SECTION;
594594

595-
EXECUTE IMMEDIATE :stmt;
595+
EXEC SQL EXECUTE IMMEDIATE :stmt;
596596
</programlisting>
597597
You may not execute statements that retrieve data (e.g.,
598598
<command>SELECT</command>) this way.
@@ -611,9 +611,9 @@ EXEC SQL BEGIN DECLARE SECTION;
611611
const char *stmt = "INSERT INTO test1 VALUES(?, ?);";
612612
EXEC SQL END DECLARE SECTION;
613613

614-
PREPARE mystmt FROM :stmt;
614+
EXEC SQL PREPARE mystmt FROM :stmt;
615615
...
616-
EXECUTE mystmt USING 42, 'foobar';
616+
EXEC SQL EXECUTE mystmt USING 42, 'foobar';
617617
</programlisting>
618618
If the statement you are executing returns values, then add an
619619
<literal>INTO</literal> clause:
@@ -624,9 +624,9 @@ int v1, v2;
624624
VARCHAR v3;
625625
EXEC SQL END DECLARE SECTION;
626626

627-
PREPARE mystmt FROM :stmt;
627+
EXEC SQL PREPARE mystmt FROM :stmt;
628628
...
629-
EXECUTE mystmt INTO v1, v2, v3 USING 37;
629+
EXEC SQL EXECUTE mystmt INTO v1, v2, v3 USING 37;
630630
</programlisting>
631631
An <command>EXECUTE</command> command may have an
632632
<literal>INTO</literal> clause, a <literal>USING</literal> clause,
@@ -668,7 +668,7 @@ EXEC SQL DEALLOCATE PREPARE <replaceable>name</replaceable>;
668668
EXEC SQL ALLOCATE DESCRIPTOR <replaceable>identifier</replaceable>;
669669
</programlisting>
670670
The identifier serves as the <quote>variable name</quote> of the
671-
descriptor area. The scope of the allocated descriptor is WHAT?.
671+
descriptor area. <comment>The scope of the allocated descriptor is WHAT?.</comment>
672672
When you don't need the descriptor anymore, you should deallocate
673673
it:
674674
<programlisting>

doc/src/sgml/extend.sgml

+62-40
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.25 2003/09/11 21:42:19 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.26 2003/11/12 22:47:47 petere Exp $
33
-->
44

55
<chapter id="extend">
@@ -105,52 +105,74 @@ $Header: /cvsroot/pgsql/doc/src/sgml/extend.sgml,v 1.25 2003/09/11 21:42:19 momj
105105

106106
<para>
107107
<productname>PostgreSQL</productname> data types are divided into base
108-
types, composite types, domain types, and pseudo-types.
108+
types, composite types, domains, and pseudo-types.
109109
</para>
110110

111-
<para>
112-
Base types are those, like <type>int4</type>, that are implemented
113-
below the level of the <acronym>SQL</> language (typically in a low-level
114-
language such as C). They generally correspond to
115-
what are often known as abstract data types.
116-
<productname>PostgreSQL</productname>
117-
can only operate on such types through functions provided
118-
by the user and only understands the behavior of such
119-
types to the extent that the user describes them. Base types are
120-
further subdivided into scalar and array types. For each scalar type,
121-
a corresponding array type is automatically created that can hold
122-
variable-size arrays of that scalar type.
123-
</para>
111+
<sect2>
112+
<title>Base Types</title>
124113

125-
<para>
126-
Composite types, or row types, are created whenever the user creates a
127-
table; it's also possible to define a <quote>stand-alone</> composite
128-
type with no associated table. A composite type is simply a list of
129-
base types with associated field names. A value of a composite type
130-
is a row or record of field values. The user can access the component
131-
fields from <acronym>SQL</> queries.
132-
</para>
114+
<para>
115+
Base types are those, like <type>int4</type>, that are
116+
implemented below the level of the <acronym>SQL</> language
117+
(typically in a low-level language such as C). They generally
118+
correspond to what are often known as abstract data types.
119+
<productname>PostgreSQL</productname> can only operate on such
120+
types through functions provided by the user and only understands
121+
the behavior of such types to the extent that the user describes
122+
them. Base types are further subdivided into scalar and array
123+
types. For each scalar type, a corresponding array type is
124+
automatically created that can hold variable-size arrays of that
125+
scalar type.
126+
</para>
127+
</sect2>
133128

134-
<para>
135-
A domain type is based on a particular base
136-
type and for many purposes is interchangeable with its base type.
137-
However, a domain may have constraints that restrict its valid values
138-
to a subset of what the underlying base type would allow. Domains can
139-
be created by simple <acronym>SQL</> commands.
140-
</para>
129+
<sect2>
130+
<title>Composite Types</title>
141131

142-
<para>
143-
Finally, there are a few <quote>pseudo-types</> for special purposes.
144-
Pseudo-types cannot appear as fields of tables or composite types, but
145-
they can be used to declare the argument and result types of functions.
146-
This provides a mechanism within the type system to identify special
147-
classes of functions. <xref
148-
linkend="datatype-pseudotypes-table"> lists the existing
149-
pseudo-types.
150-
</para>
132+
<para>
133+
Composite types, or row types, are created whenever the user
134+
creates a table; it's also possible to define a
135+
<quote>stand-alone</> composite type with no associated table. A
136+
composite type is simply a list of base types with associated
137+
field names. A value of a composite type is a row or record of
138+
field values. The user can access the component fields from
139+
<acronym>SQL</> queries.
140+
</para>
141+
</sect2>
142+
143+
<sect2>
144+
<title>Domains</title>
145+
146+
<para>
147+
A domain is based on a particular base type and for many purposes
148+
is interchangeable with its base type. However, a domain may
149+
have constraints that restrict its valid values to a subset of
150+
what the underlying base type would allow.
151+
</para>
152+
153+
<para>
154+
Domains can be created using the <acronym>SQL</> commands
155+
<command>CREATE DOMAIN</command>. Their creation and use is not
156+
discussed in this chapter.
157+
</para>
158+
</sect2>
159+
160+
<sect2>
161+
<title>Pseudo-Types</title>
162+
163+
<para>
164+
There are a few <quote>pseudo-types</> for special purposes.
165+
Pseudo-types cannot appear as columns of tables or attributes of
166+
composite types, but they can be used to declare the argument and
167+
result types of functions. This provides a mechanism within the
168+
type system to identify special classes of functions. <xref
169+
linkend="datatype-pseudotypes-table"> lists the existing
170+
pseudo-types.
171+
</para>
172+
</sect2>
151173

152174
<sect2 id="extend-types-polymorphic">
153-
<title>Polymorphic Types and Functions</title>
175+
<title>Polymorphic Types</title>
154176

155177
<indexterm zone="extend-types-polymorphic">
156178
<primary>polymorphic type</primary>

doc/src/sgml/install-win32.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/install-win32.sgml,v 1.15 2003/11/04 09:55:38 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/install-win32.sgml,v 1.16 2003/11/12 22:47:47 petere Exp $
33
-->
44

55
<chapter id="install-win32">
@@ -109,7 +109,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/install-win32.sgml,v 1.15 2003/11/04 09:55:
109109

110110
<para>
111111
<application>psql</application> is compiled as a <quote>console
112-
application</>. As the Win32 console windows use a different
112+
application</>. As the Windows console windows use a different
113113
encoding than the rest of the system, you must take special care
114114
when using 8-bit characters at the <application>psql</application>
115115
prompt. When <application>psql</application> detects a problematic

0 commit comments

Comments
 (0)