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

Commit 665c585

Browse files
committed
Doc: document the current-transaction-modes GUCs.
We had documentation of default_transaction_isolation et al, but for some reason not of transaction_isolation et al. AFAICS this is just an ancient oversight, so repair. Per bug #17077 from Yanliang Lei. Discussion: https://postgr.es/m/17077-ade8e166a01e1374@postgresql.org
1 parent f0e21f2 commit 665c585

File tree

2 files changed

+76
-3
lines changed

2 files changed

+76
-3
lines changed

doc/src/sgml/config.sgml

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3141,7 +3141,7 @@ include_dir 'conf.d'
31413141
</term>
31423142
<listitem>
31433143
<para>
3144-
This parameter enables compression of WAL using the specified
3144+
This parameter enables compression of WAL using the specified
31453145
compression method.
31463146
When enabled, the <productname>PostgreSQL</productname>
31473147
server compresses full page images written to WAL when
@@ -8434,6 +8434,68 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
84348434
</listitem>
84358435
</varlistentry>
84368436

8437+
<varlistentry id="guc-transaction-isolation" xreflabel="transaction_isolation">
8438+
<term><varname>transaction_isolation</varname> (<type>enum</type>)
8439+
<indexterm>
8440+
<primary>transaction isolation level</primary>
8441+
</indexterm>
8442+
<indexterm>
8443+
<primary><varname>transaction_isolation</varname> configuration parameter</primary>
8444+
</indexterm>
8445+
</term>
8446+
<listitem>
8447+
<para>
8448+
This parameter reflects the current transaction's isolation level.
8449+
At the beginning of each transaction, it is set to the current value
8450+
of <xref linkend="guc-default-transaction-isolation"/>.
8451+
Any subsequent attempt to change it is equivalent to a <xref
8452+
linkend="sql-set-transaction"/> command.
8453+
</para>
8454+
</listitem>
8455+
</varlistentry>
8456+
8457+
<varlistentry id="guc-transaction-read-only" xreflabel="transaction_read_only">
8458+
<term><varname>transaction_read_only</varname> (<type>boolean</type>)
8459+
<indexterm>
8460+
<primary>read-only transaction</primary>
8461+
<secondary>setting default</secondary>
8462+
</indexterm>
8463+
<indexterm>
8464+
<primary><varname>transaction_read_only</varname> configuration parameter</primary>
8465+
</indexterm>
8466+
</term>
8467+
<listitem>
8468+
<para>
8469+
This parameter reflects the current transaction's read-only status.
8470+
At the beginning of each transaction, it is set to the current value
8471+
of <xref linkend="guc-default-transaction-read-only"/>.
8472+
Any subsequent attempt to change it is equivalent to a <xref
8473+
linkend="sql-set-transaction"/> command.
8474+
</para>
8475+
</listitem>
8476+
</varlistentry>
8477+
8478+
<varlistentry id="guc-transaction-deferrable" xreflabel="transaction_deferrable">
8479+
<term><varname>transaction_deferrable</varname> (<type>boolean</type>)
8480+
<indexterm>
8481+
<primary>deferrable transaction</primary>
8482+
<secondary>setting default</secondary>
8483+
</indexterm>
8484+
<indexterm>
8485+
<primary><varname>transaction_deferrable</varname> configuration parameter</primary>
8486+
</indexterm>
8487+
</term>
8488+
<listitem>
8489+
<para>
8490+
This parameter reflects the current transaction's deferrability status.
8491+
At the beginning of each transaction, it is set to the current value
8492+
of <xref linkend="guc-default-transaction-deferrable"/>.
8493+
Any subsequent attempt to change it is equivalent to a <xref
8494+
linkend="sql-set-transaction"/> command.
8495+
</para>
8496+
</listitem>
8497+
</varlistentry>
8498+
84378499

84388500
<varlistentry id="guc-session-replication-role" xreflabel="session_replication_role">
84398501
<term><varname>session_replication_role</varname> (<type>enum</type>)
@@ -10913,7 +10975,7 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
1091310975
<productname>PostgreSQL</productname> will automatically remove
1091410976
temporary files after a backend crash. If disabled, the files will be
1091510977
retained and may be used for debugging, for example. Repeated crashes
10916-
may however result in accumulation of useless files. This parameter
10978+
may however result in accumulation of useless files. This parameter
1091710979
can only be set in the <filename>postgresql.conf</filename> file or on
1091810980
the server command line.
1091910981
</para>

doc/src/sgml/ref/set_transaction.sgml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ SET SESSION CHARACTERISTICS AS TRANSACTION <replaceable class="parameter">transa
202202
</para>
203203

204204
<para>
205-
The session default transaction modes can also be set by setting the
205+
The session default transaction modes can also be set or examined via the
206206
configuration parameters <xref linkend="guc-default-transaction-isolation"/>,
207207
<xref linkend="guc-default-transaction-read-only"/>, and
208208
<xref linkend="guc-default-transaction-deferrable"/>.
@@ -212,6 +212,17 @@ SET SESSION CHARACTERISTICS AS TRANSACTION <replaceable class="parameter">transa
212212
<command>ALTER DATABASE</command>, etc. Consult <xref linkend="runtime-config"/>
213213
for more information.
214214
</para>
215+
216+
<para>
217+
The current transaction's modes can similarly be set or examined via the
218+
configuration parameters <xref linkend="guc-transaction-isolation"/>,
219+
<xref linkend="guc-transaction-read-only"/>, and
220+
<xref linkend="guc-transaction-deferrable"/>. Setting one of these
221+
parameters acts the same as the corresponding <command>SET
222+
TRANSACTION</command> option, with the same restrictions on when it can
223+
be done. However, these parameters cannot be set in the configuration
224+
file, or from any source other than live SQL.
225+
</para>
215226
</refsect1>
216227

217228
<refsect1>

0 commit comments

Comments
 (0)