mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Misc documentation fixes.

Browse Source 
- Misc grammar and punctuation fixes.

- Stylistic cleanup: use spaces between function arguments and JSON fields
  in examples. For example "foo(a,b)" -> "foo(a, b)". Add semicolon after
  last END in a few PL/pgSQL examples that were missing them.

- Make sentence that talked about "..." and ".." operators more clear,
  by avoiding to end the sentence with "..". That makes it look the same
  as "..."

- Fix syntax description for HAVING: HAVING conditions cannot be repeated

Patch by Justin Pryzby, per Yaroslav Schekin's report. Backpatch to all
supported versions, to the extent that the patch applies easily.

Discussion: https://www.postgresql.org/message-id/20201005191922.GE17626%40telsasoft.com
This commit is contained in:
Heikki Linnakangas 2020-10-19 19:28:54 +03:00
parent 1800686383
commit 1e17fb9357
17 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/sgml/catalogs.sgml
View File

@ -1365,7 +1365,7 @@
<entry><type>bool</type></entry>
<entry>
Role can log in. That is, this role can be given as the initial
session authorization identifier
session authorization identifier.
</entry>
</row>

4
doc/src/sgml/config.sgml
View File

@ -8817,8 +8817,8 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
</term>
<listitem>
<para>
If set, do not trace locks for tables below this OID. (use to avoid
output on system tables)
If set, do not trace locks for tables below this OID (used to avoid
output on system tables).
</para>
<para>
This parameter is only available if the <symbol>LOCK_DEBUG</symbol>

8
doc/src/sgml/dblink.sgml
View File

@ -167,7 +167,7 @@ SELECT dblink_connect('myconn', 'fdtest');
OK
(1 row)
SELECT * FROM dblink('myconn','SELECT * FROM foo') AS t(a int, b text, c text[]);
SELECT * FROM dblink('myconn', 'SELECT * FROM foo') AS t(a int, b text, c text[]);
a | b | c
----+---+---------------
0 | a | {a0,b0,c0}
@ -616,7 +616,7 @@ dblink_exec(text sql [, bool fail_on_error]) returns text
<para>
The SQL command that you wish to execute in the remote database,
for example
<literal>insert into foo values(0,'a','{"a0","b0","c0"}')</literal>.
<literal>insert into foo values(0, 'a', '{"a0","b0","c0"}')</literal>.
</para>
</listitem>
</varlistentry>
@ -653,7 +653,7 @@ SELECT dblink_connect('dbname=dblink_test_standby');
OK
(1 row)
SELECT dblink_exec('insert into foo values(21,''z'',''{"a0","b0","c0"}'');');
SELECT dblink_exec('insert into foo values(21, ''z'', ''{"a0","b0","c0"}'');');
dblink_exec
-----------------
INSERT 943366 1
@ -665,7 +665,7 @@ SELECT dblink_connect('myconn', 'dbname=regression');
OK
(1 row)
SELECT dblink_exec('myconn', 'insert into foo values(21,''z'',''{"a0","b0","c0"}'');');
SELECT dblink_exec('myconn', 'insert into foo values(21, ''z'', ''{"a0","b0","c0"}'');');
dblink_exec
------------------
INSERT 6432584 1

2
doc/src/sgml/func.sgml
View File

@ -20987,7 +20987,7 @@ BEGIN
obj.object_name,
obj.object_identity;
END LOOP;
END
END;
$$;
CREATE EVENT TRIGGER test_event_trigger_for_drops
ON sql_drop

2
doc/src/sgml/gin.sgml
View File

@ -565,7 +565,7 @@
</para>
<para>
<varname>gin_pending_list_limit</varname> can be overridden for individual
GIN indexes by changing storage parameters, and which allows each
GIN indexes by changing storage parameters, which allows each
GIN index to have its own cleanup threshold.
For example, it's possible to increase the threshold only for the GIN
index which can be updated heavily, and decrease it otherwise.

2
doc/src/sgml/high-availability.sgml
View File

@ -1499,7 +1499,7 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
Note that in this mode, the server will apply WAL one file at a
time, so if you use the standby server for queries (see Hot Standby),
there is a delay between an action in the master and when the
action becomes visible in the standby, corresponding the time it takes
action becomes visible in the standby, corresponding to the time it takes
to fill up the WAL file. <varname>archive_timeout</varname> can be used to make that delay
shorter. Also note that you can't combine streaming replication with
this method.

2
doc/src/sgml/indexam.sgml
View File

@ -543,7 +543,7 @@ amgettuple (IndexScanDesc scan,
will pass the caller's snapshot test. On success, <function>amgettuple</function>
must also set <literal>scan-&gt;xs_recheck</literal> to true or false.
False means it is certain that the index entry matches the scan keys.
true means this is not certain, and the conditions represented by the
True means this is not certain, and the conditions represented by the
scan keys must be rechecked against the heap tuple after fetching it.
This provision supports <quote>lossy</quote> index operators.
Note that rechecking will extend only to the scan conditions; a partial

2
doc/src/sgml/isn.sgml
View File

@ -14,7 +14,7 @@
hard-coded list of prefixes; this list of prefixes is also used to hyphenate
numbers on output. Since new prefixes are assigned from time to time, the
list of prefixes may be out of date. It is hoped that a future version of
this module will obtained the prefix list from one or more tables that
this module will obtain the prefix list from one or more tables that
can be easily updated by users as needed; however, at present, the
list can only be updated by modifying the source code and recompiling.
Alternatively, prefix validation and hyphenation support may be

2
doc/src/sgml/mvcc.sgml
View File

@ -1239,7 +1239,7 @@ ERROR: could not serialize access due to read/write dependencies among transact
<para>
The <literal>FOR UPDATE</literal> lock mode
is also acquired by any <command>DELETE</command> on a row, and also by an
<command>UPDATE</command> that modifies the values on certain columns. Currently,
<command>UPDATE</command> that modifies the values of certain columns. Currently,
the set of columns considered for the <command>UPDATE</command> case are those that
have a unique index on them that can be used in a foreign key (so partial
indexes and expressional indexes are not considered), but this may change

2
doc/src/sgml/parallel.sgml
View File

@ -496,7 +496,7 @@ EXPLAIN SELECT * FROM pgbench_accounts WHERE filler LIKE '%x%';
</para>
<para>
The following operations are always parallel restricted.
The following operations are always parallel restricted:
</para>
<itemizedlist>

12
doc/src/sgml/plpgsql.sgml
View File

@ -1121,7 +1121,7 @@ BEGIN
SELECT users.userid INTO STRICT userid
FROM users WHERE users.username = get_userid.username;
RETURN userid;
END
END;
$$ LANGUAGE plpgsql;
</programlisting>
On failure, this function might produce an error message such as
@ -1799,7 +1799,7 @@ BEGIN
RETURN NEXT r; -- return current row of SELECT
END LOOP;
RETURN;
END
END;
$BODY$
LANGUAGE plpgsql;
@ -1827,7 +1827,7 @@ BEGIN
END IF;
RETURN;
END
END;
$BODY$
LANGUAGE plpgsql;
@ -1901,7 +1901,7 @@ DECLARE myvar int := 5;
BEGIN
CALL triple(myvar);
RAISE NOTICE 'myvar = %', myvar; -- prints 15
END
END;
$$;
</programlisting>
</para>
@ -3501,7 +3501,7 @@ BEGIN
ROLLBACK;
END IF;
END LOOP;
END
END;
$$;
CALL transaction_test1();
@ -5103,7 +5103,7 @@ DECLARE
f1 int;
BEGIN
RETURN f1;
END
END;
$$ LANGUAGE plpgsql;
WARNING: variable "f1" shadows a previously defined variable
LINE 3: f1 int;

2
doc/src/sgml/protocol.sgml
View File

@ -2730,7 +2730,7 @@ The commands accepted in replication mode are:
<para>
Every sent transaction contains zero or more DML messages (Insert,
Update, Delete). In case of a cascaded setup it can also contain Origin
messages. The origin message indicated that the transaction originated on
messages. The origin message indicates that the transaction originated on
different replication node. Since a replication node in the scope of logical
replication protocol can be pretty much anything, the only identifier
is the origin name. It's downstream's responsibility to handle this as

2
doc/src/sgml/ref/select.sgml
View File

@ -38,7 +38,7 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replac
[ FROM <replaceable class="parameter">from_item</replaceable> [, ...] ]
[ WHERE <replaceable class="parameter">condition</replaceable> ]
[ GROUP BY <replaceable class="parameter">grouping_element</replaceable> [, ...] ]
[ HAVING <replaceable class="parameter">condition</replaceable> [, ...] ]
[ HAVING <replaceable class="parameter">condition</replaceable> ]
[ WINDOW <replaceable class="parameter">window_name</replaceable> AS ( <replaceable class="parameter">window_definition</replaceable> ) [, ...] ]
[ { UNION | INTERSECT | EXCEPT } [ ALL | DISTINCT ] <replaceable class="parameter">select</replaceable> ]
[ ORDER BY <replaceable class="parameter">expression</replaceable> [ ASC | DESC | USING <replaceable class="parameter">operator</replaceable> ] [ NULLS { FIRST | LAST } ] [, ...] ]

2
doc/src/sgml/ref/select_into.sgml
View File

@ -28,7 +28,7 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replac
[ FROM <replaceable class="parameter">from_item</replaceable> [, ...] ]
[ WHERE <replaceable class="parameter">condition</replaceable> ]
[ GROUP BY <replaceable class="parameter">expression</replaceable> [, ...] ]
[ HAVING <replaceable class="parameter">condition</replaceable> [, ...] ]
[ HAVING <replaceable class="parameter">condition</replaceable> ]
[ WINDOW <replaceable class="parameter">window_name</replaceable> AS ( <replaceable class="parameter">window_definition</replaceable> ) [, ...] ]
[ { UNION | INTERSECT | EXCEPT } [ ALL | DISTINCT ] <replaceable class="parameter">select</replaceable> ]
[ ORDER BY <replaceable class="parameter">expression</replaceable> [ ASC | DESC | USING <replaceable class="parameter">operator</replaceable> ] [ NULLS { FIRST | LAST } ] [, ...] ]

6
doc/src/sgml/rules.sgml
View File

@ -769,7 +769,7 @@ SELECT t1.a, t2.b, t1.ctid FROM t1, t2 WHERE t1.a = t2.a;
</para>
<para>
The benefit of implementing views with the rule system is,
The benefit of implementing views with the rule system is
that the planner has all
the information about which tables have to be scanned plus the
relationships between these tables plus the restrictive
@ -781,7 +781,7 @@ SELECT t1.a, t2.b, t1.ctid FROM t1, t2 WHERE t1.a = t2.a;
the best path to execute the query, and the more information
the planner has, the better this decision can be. And
the rule system as implemented in <productname>PostgreSQL</productname>
ensures, that this is all information available about the query
ensures that this is all information available about the query
up to that point.
</para>
</sect2>
@ -2086,7 +2086,7 @@ CREATE FUNCTION tricky(text, text) RETURNS bool AS $$
BEGIN
RAISE NOTICE '% =&gt; %', $1, $2;
RETURN true;
END
END;
$$ LANGUAGE plpgsql COST 0.0000000000000000000001;
SELECT * FROM phone_number WHERE tricky(person, phone);

4
doc/src/sgml/seg.sgml
View File

@ -197,8 +197,8 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH";
</table>
<para>
Because <literal>...</literal> is widely used in data sources, it is allowed
as an alternative spelling of <literal>..</literal>. Unfortunately, this
Because the <literal>...</literal> operator is widely used in data sources, it is allowed
as an alternative spelling of the <literal>..</literal> operator. Unfortunately, this
creates a parsing ambiguity: it is not clear whether the upper bound
in <literal>0...23</literal> is meant to be <literal>23</literal> or <literal>0.23</literal>.
This is resolved by requiring at least one digit before the decimal

30
doc/src/sgml/textsearch.sgml
View File

@ -2401,7 +2401,7 @@ ALTER TEXT SEARCH CONFIGURATION astro_en
positions in <type>tsvector</type>, which in turn affect ranking:
<screen>
SELECT to_tsvector('english','in the list of stop words');
SELECT to_tsvector('english', 'in the list of stop words');
to_tsvector
----------------------------
'list':3 'stop':5 'word':6
@ -2411,12 +2411,12 @@ SELECT to_tsvector('english','in the list of stop words');
calculated for documents with and without stop words are quite different:
<screen>
SELECT ts_rank_cd (to_tsvector('english','in the list of stop words'), to_tsquery('list &amp; stop'));
SELECT ts_rank_cd (to_tsvector('english', 'in the list of stop words'), to_tsquery('list &amp; stop'));
ts_rank_cd
------------
0.05
SELECT ts_rank_cd (to_tsvector('english','list stop words'), to_tsquery('list &amp; stop'));
SELECT ts_rank_cd (to_tsvector('english', 'list stop words'), to_tsquery('list &amp; stop'));
ts_rank_cd
------------
0.1
@ -2475,12 +2475,12 @@ CREATE TEXT SEARCH DICTIONARY public.simple_dict (
Now we can test our dictionary:
<screen>
SELECT ts_lexize('public.simple_dict','YeS');
SELECT ts_lexize('public.simple_dict', 'YeS');
ts_lexize
-----------
{yes}
SELECT ts_lexize('public.simple_dict','The');
SELECT ts_lexize('public.simple_dict', 'The');
ts_lexize
-----------
{}
@ -2496,12 +2496,12 @@ SELECT ts_lexize('public.simple_dict','The');
<screen>
ALTER TEXT SEARCH DICTIONARY public.simple_dict ( Accept = false );
SELECT ts_lexize('public.simple_dict','YeS');
SELECT ts_lexize('public.simple_dict', 'YeS');
ts_lexize
-----------
SELECT ts_lexize('public.simple_dict','The');
SELECT ts_lexize('public.simple_dict', 'The');
ts_lexize
-----------
{}
@ -2615,7 +2615,7 @@ indices index*
Then we will get these results:
<screen>
mydb=# CREATE TEXT SEARCH DICTIONARY syn (template=synonym, synonyms='synonym_sample');
mydb=# SELECT ts_lexize('syn','indices');
mydb=# SELECT ts_lexize('syn', 'indices');
ts_lexize
-----------
{index}
@ -2623,13 +2623,13 @@ mydb=# SELECT ts_lexize('syn','indices');
mydb=# CREATE TEXT SEARCH CONFIGURATION tst (copy=simple);
mydb=# ALTER TEXT SEARCH CONFIGURATION tst ALTER MAPPING FOR asciiword WITH syn;
mydb=# SELECT to_tsvector('tst','indices');
mydb=# SELECT to_tsvector('tst', 'indices');
to_tsvector
-------------
'index':1
(1 row)
mydb=# SELECT to_tsquery('tst','indices');
mydb=# SELECT to_tsquery('tst', 'indices');
to_tsquery
------------
'index':*
@ -2641,7 +2641,7 @@ mydb=# SELECT 'indexes are very useful'::tsvector;
'are' 'indexes' 'useful' 'very'
(1 row)
mydb=# SELECT 'indexes are very useful'::tsvector @@ to_tsquery('tst','indices');
mydb=# SELECT 'indexes are very useful'::tsvector @@ to_tsquery('tst', 'indices');
?column?
----------
t
@ -3336,7 +3336,7 @@ ts_debug(<optional> <replaceable class="parameter">config</replaceable> <type>re
Here is a simple example:
<screen>
SELECT * FROM ts_debug('english','a fat cat sat on a mat - it ate a fat rats');
SELECT * FROM ts_debug('english', 'a fat cat sat on a mat - it ate a fat rats');
alias | description | token | dictionaries | dictionary | lexemes
-----------+-----------------+-------+----------------+--------------+---------
asciiword | Word, all ASCII | a | {english_stem} | english_stem | {}
@ -3387,7 +3387,7 @@ ALTER TEXT SEARCH CONFIGURATION public.english
</programlisting>
<screen>
SELECT * FROM ts_debug('public.english','The Brightest supernovaes');
SELECT * FROM ts_debug('public.english', 'The Brightest supernovaes');
alias | description | token | dictionaries | dictionary | lexemes
-----------+-----------------+-------------+-------------------------------+----------------+-------------
asciiword | Word, all ASCII | The | {english_ispell,english_stem} | english_ispell | {}
@ -3426,7 +3426,7 @@ SELECT * FROM ts_debug('public.english','The Brightest supernovaes');
<screen>
SELECT alias, token, dictionary, lexemes
FROM ts_debug('public.english','The Brightest supernovaes');
FROM ts_debug('public.english', 'The Brightest supernovaes');
alias | token | dictionary | lexemes
-----------+-------------+----------------+-------------
asciiword | The | english_ispell | {}
@ -3574,7 +3574,7 @@ SELECT ts_lexize('english_stem', 'a');
where this can be confusing:
<screen>
SELECT ts_lexize('thesaurus_astro','supernovae stars') is null;
SELECT ts_lexize('thesaurus_astro', 'supernovae stars') is null;
?column?
----------
t