diff options
author | Tom Lane <tgl@sss.pgh.pa.us> | 2018-05-21 11:41:42 -0400 |
---|---|---|
committer | Tom Lane <tgl@sss.pgh.pa.us> | 2018-05-21 11:41:42 -0400 |
commit | f755a152d4e3e6f913c6b7b6afe1785b1171c1cb (patch) | |
tree | 9b41cd5b2fa3f56628429244a2925ae97ad032eb /doc/src | |
parent | 3f5e3a98443c7f437465d79e4b99a0a661ae1b9b (diff) |
Improve spelling of new FINALFUNC_MODIFY aggregate attribute.
I'd used SHARABLE as a value originally, but Peter Eisentraut points out
that dictionaries agree that SHAREABLE is the preferred spelling.
Run around and change that before it's too late.
Discussion: https://postgr.es/m/d2e1afd4-659c-50d6-1b20-7cfd3675e909@2ndquadrant.com
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/ref/create_aggregate.sgml | 19 | ||||
-rw-r--r-- | doc/src/sgml/xaggr.sgml | 4 |
2 files changed, 12 insertions, 11 deletions
diff --git a/doc/src/sgml/ref/create_aggregate.sgml b/doc/src/sgml/ref/create_aggregate.sgml index a4aaae876ec..b8cd2e7af90 100644 --- a/doc/src/sgml/ref/create_aggregate.sgml +++ b/doc/src/sgml/ref/create_aggregate.sgml @@ -27,7 +27,7 @@ CREATE AGGREGATE <replaceable class="parameter">name</replaceable> ( [ <replacea [ , SSPACE = <replaceable class="parameter">state_data_size</replaceable> ] [ , FINALFUNC = <replaceable class="parameter">ffunc</replaceable> ] [ , FINALFUNC_EXTRA ] - [ , FINALFUNC_MODIFY = { READ_ONLY | SHARABLE | READ_WRITE } ] + [ , FINALFUNC_MODIFY = { READ_ONLY | SHAREABLE | READ_WRITE } ] [ , COMBINEFUNC = <replaceable class="parameter">combinefunc</replaceable> ] [ , SERIALFUNC = <replaceable class="parameter">serialfunc</replaceable> ] [ , DESERIALFUNC = <replaceable class="parameter">deserialfunc</replaceable> ] @@ -38,7 +38,7 @@ CREATE AGGREGATE <replaceable class="parameter">name</replaceable> ( [ <replacea [ , MSSPACE = <replaceable class="parameter">mstate_data_size</replaceable> ] [ , MFINALFUNC = <replaceable class="parameter">mffunc</replaceable> ] [ , MFINALFUNC_EXTRA ] - [ , MFINALFUNC_MODIFY = { READ_ONLY | SHARABLE | READ_WRITE } ] + [ , MFINALFUNC_MODIFY = { READ_ONLY | SHAREABLE | READ_WRITE } ] [ , MINITCOND = <replaceable class="parameter">minitial_condition</replaceable> ] [ , SORTOP = <replaceable class="parameter">sort_operator</replaceable> ] [ , PARALLEL = { SAFE | RESTRICTED | UNSAFE } ] @@ -51,7 +51,7 @@ CREATE AGGREGATE <replaceable class="parameter">name</replaceable> ( [ [ <replac [ , SSPACE = <replaceable class="parameter">state_data_size</replaceable> ] [ , FINALFUNC = <replaceable class="parameter">ffunc</replaceable> ] [ , FINALFUNC_EXTRA ] - [ , FINALFUNC_MODIFY = { READ_ONLY | SHARABLE | READ_WRITE } ] + [ , FINALFUNC_MODIFY = { READ_ONLY | SHAREABLE | READ_WRITE } ] [ , INITCOND = <replaceable class="parameter">initial_condition</replaceable> ] [ , PARALLEL = { SAFE | RESTRICTED | UNSAFE } ] [ , HYPOTHETICAL ] @@ -66,7 +66,7 @@ CREATE AGGREGATE <replaceable class="parameter">name</replaceable> ( [ , SSPACE = <replaceable class="parameter">state_data_size</replaceable> ] [ , FINALFUNC = <replaceable class="parameter">ffunc</replaceable> ] [ , FINALFUNC_EXTRA ] - [ , FINALFUNC_MODIFY = { READ_ONLY | SHARABLE | READ_WRITE } ] + [ , FINALFUNC_MODIFY = { READ_ONLY | SHAREABLE | READ_WRITE } ] [ , COMBINEFUNC = <replaceable class="parameter">combinefunc</replaceable> ] [ , SERIALFUNC = <replaceable class="parameter">serialfunc</replaceable> ] [ , DESERIALFUNC = <replaceable class="parameter">deserialfunc</replaceable> ] @@ -77,7 +77,7 @@ CREATE AGGREGATE <replaceable class="parameter">name</replaceable> ( [ , MSSPACE = <replaceable class="parameter">mstate_data_size</replaceable> ] [ , MFINALFUNC = <replaceable class="parameter">mffunc</replaceable> ] [ , MFINALFUNC_EXTRA ] - [ , MFINALFUNC_MODIFY = { READ_ONLY | SHARABLE | READ_WRITE } ] + [ , MFINALFUNC_MODIFY = { READ_ONLY | SHAREABLE | READ_WRITE } ] [ , MINITCOND = <replaceable class="parameter">minitial_condition</replaceable> ] [ , SORTOP = <replaceable class="parameter">sort_operator</replaceable> ] ) @@ -419,7 +419,7 @@ SELECT col FROM tab ORDER BY col USING sortop LIMIT 1; </varlistentry> <varlistentry> - <term><literal>FINALFUNC_MODIFY</literal> = { <literal>READ_ONLY</literal> | <literal>SHARABLE</literal> | <literal>READ_WRITE</literal> }</term> + <term><literal>FINALFUNC_MODIFY</literal> = { <literal>READ_ONLY</literal> | <literal>SHAREABLE</literal> | <literal>READ_WRITE</literal> }</term> <listitem> <para> This option specifies whether the final function is a pure function @@ -585,7 +585,7 @@ SELECT col FROM tab ORDER BY col USING sortop LIMIT 1; </varlistentry> <varlistentry> - <term><literal>MFINALFUNC_MODIFY</literal> = { <literal>READ_ONLY</literal> | <literal>SHARABLE</literal> | <literal>READ_WRITE</literal> }</term> + <term><literal>MFINALFUNC_MODIFY</literal> = { <literal>READ_ONLY</literal> | <literal>SHAREABLE</literal> | <literal>READ_WRITE</literal> }</term> <listitem> <para> This option is like <literal>FINALFUNC_MODIFY</literal>, but it describes @@ -678,12 +678,13 @@ SELECT col FROM tab ORDER BY col USING sortop LIMIT 1; Likewise, while an aggregate final function is normally expected not to modify its input values, sometimes it is impractical to avoid modifying the transition-state argument. Such behavior must be declared using - the <literal>FINALFUNC_MODIFY</literal> parameter. The <literal>READ_WRITE</literal> + the <literal>FINALFUNC_MODIFY</literal> parameter. + The <literal>READ_WRITE</literal> value indicates that the final function modifies the transition state in unspecified ways. This value prevents use of the aggregate as a window function, and it also prevents merging of transition states for aggregate calls that share the same input values and transition functions. - The <literal>SHARABLE</literal> value indicates that the transition function + The <literal>SHAREABLE</literal> value indicates that the transition function cannot be applied after the final function, but multiple final-function calls can be performed on the ending transition state value. This value prevents use of the aggregate as a window function, but it allows merging diff --git a/doc/src/sgml/xaggr.sgml b/doc/src/sgml/xaggr.sgml index 1514e5c388e..4155b01ece1 100644 --- a/doc/src/sgml/xaggr.sgml +++ b/doc/src/sgml/xaggr.sgml @@ -491,8 +491,8 @@ SELECT percentile_disc(0.5) WITHIN GROUP (ORDER BY income) FROM households; to continue adding input rows by executing the transition function again later. This means the final function is not <literal>READ_ONLY</literal>; it must be declared in <xref linkend="sql-createaggregate"/> - as <literal>READ_WRITE</literal>, or as <literal>SHARABLE</literal> if it's - possible for additional final-function calls to make use of the + as <literal>READ_WRITE</literal>, or as <literal>SHAREABLE</literal> if + it's possible for additional final-function calls to make use of the already-sorted state. </para> |