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

Improve documentation of --single-transaction option: fix markup, and

Browse Source 
don't promise more than the code actually delivers.
This commit is contained in:
Tom Lane 2006-02-13 21:29:08 +00:00
parent f5ef3d4379
commit d537e0b41b
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/src/sgml/ref/pg_restore.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.57 2006/02/12 04:04:32 momjian Exp $ --> <!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.58 2006/02/13 21:29:08 tgl Exp $ -->
<refentry id="APP-PGRESTORE"> <refentry id="APP-PGRESTORE">
<refmeta> <refmeta>
@ -454,9 +454,11 @@
<term><option>--single-transaction</option></term> <term><option>--single-transaction</option></term>
<listitem> <listitem>
<para> <para>
Force the restore to execute as a single transaction. Either all Execute the restore as a single transaction (that is, wrap the
SQL statements complete successfully, or no changes are applied. This emitted commands in <command>BEGIN</>/<command>COMMIT</>). This
option also forces --exit-on-error. ensures that either all the commands complete successfully, or no
changes are applied. This option implies
<option>--exit-on-error</>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

12
doc/src/sgml/ref/psql-ref.sgml
View File

@ -1,5 +1,5 @@
<!-- <!--
$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.159 2006/02/12 04:04:32 momjian Exp $ $PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.160 2006/02/13 21:29:08 tgl Exp $
PostgreSQL documentation PostgreSQL documentation
--> -->
@ -468,9 +468,13 @@ PostgreSQL documentation
<term><option>--single-transaction</option></term> <term><option>--single-transaction</option></term>
<listitem> <listitem>
<para> <para>
When psql executes a script with the -f option, this additional option When <application>psql</application> executes a script with the
will force the script to execute as a single transaction. Either all <option>-f</> option, adding this option wraps
SQL statements complete successfully, or no changes are applied. <command>BEGIN</>/<command>COMMIT</> around the script to execute it
as a single transaction. This ensures that either all the commands
complete successfully, or no changes are applied. (However, if the
script itself uses <command>BEGIN</> or <command>COMMIT</>, this
option will not have the desired effect!)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>