public inbox for [email protected]
help / color / mirror / Atom feed[PATCH 3/6] Add backlinks to progress reporting documentation
2+ messages / 2 participants
[nested] [flat]
* [PATCH 3/6] Add backlinks to progress reporting documentation
@ 2021-02-05 22:11 Matthias van de Meent <[email protected]>
0 siblings, 0 replies; 2+ messages in thread
From: Matthias van de Meent @ 2021-02-05 22:11 UTC (permalink / raw)
Previously, for most progress-reported features, the only place the
feature was mentioned is in the progress reporting document itself.
This makes the progress reporting more discoverable from the reported
commands.
---
doc/src/sgml/ref/analyze.sgml | 7 +++++++
doc/src/sgml/ref/cluster.sgml | 6 ++++++
doc/src/sgml/ref/copy.sgml | 14 ++++++++++++++
doc/src/sgml/ref/create_index.sgml | 8 ++++++++
doc/src/sgml/ref/pg_basebackup.sgml | 1 +
doc/src/sgml/ref/reindex.sgml | 7 +++++++
doc/src/sgml/ref/vacuum.sgml | 11 +++++++++++
7 files changed, 54 insertions(+)
diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml
index 7d816c87c6..9db9070b62 100644
--- a/doc/src/sgml/ref/analyze.sgml
+++ b/doc/src/sgml/ref/analyze.sgml
@@ -273,6 +273,12 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
will not record new statistics for that table. Any existing statistics
will be retained.
</para>
+
+ <para>
+ Each backend running the <command>ANALYZE</command> command will report their
+ progress to the <structname>pg_stat_progress_analyze</structname> view.
+ See <xref linkend="analyze-progress-reporting"/> for details.
+ </para>
</refsect1>
<refsect1>
@@ -291,6 +297,7 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
<member><xref linkend="app-vacuumdb"/></member>
<member><xref linkend="runtime-config-resource-vacuum-cost"/></member>
<member><xref linkend="autovacuum"/></member>
+ <member><xref linkend="analyze-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>
diff --git a/doc/src/sgml/ref/cluster.sgml b/doc/src/sgml/ref/cluster.sgml
index 5dd21a0189..5c2270f71b 100644
--- a/doc/src/sgml/ref/cluster.sgml
+++ b/doc/src/sgml/ref/cluster.sgml
@@ -192,6 +192,11 @@ CLUSTER [VERBOSE]
are periodically reclustered.
</para>
+ <para>
+ Each backend running the <command>CLUSTER</command> command will report their
+ progress to the <structname>pg_stat_progress_cluster</structname> view.
+ See <xref linkend="cluster-progress-reporting"/> for details.
+ </para>
</refsect1>
<refsect1>
@@ -242,6 +247,7 @@ CLUSTER <replaceable class="parameter">index_name</replaceable> ON <replaceable
<simplelist type="inline">
<member><xref linkend="app-clusterdb"/></member>
+ <member><xref linkend="cluster-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>
diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml
index 0fca6583af..af3ce72561 100644
--- a/doc/src/sgml/ref/copy.sgml
+++ b/doc/src/sgml/ref/copy.sgml
@@ -82,6 +82,12 @@ COPY { <replaceable class="parameter">table_name</replaceable> [ ( <replaceable
specified, data is transmitted via the connection between the
client and the server.
</para>
+
+ <para>
+ Each backend running the <command>COPY</command> command will report their
+ progress to the <structname>pg_stat_progress_copy</structname> view.
+ See <xref linkend="copy-progress-reporting"/> for details.
+ </para>
</refsect1>
<refsect1>
@@ -1052,4 +1058,12 @@ COPY [ BINARY ] <replaceable class="parameter">table_name</replaceable>
[ WITH NULL AS '<replaceable class="parameter">null_string</replaceable>' ]
</synopsis></para>
</refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <simplelist type="inline">
+ <member><xref linkend="copy-progress-reporting"/></member>
+ </simplelist>
+ </refsect1>
</refentry>
diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml
index a5271a9f8f..278058f500 100644
--- a/doc/src/sgml/ref/create_index.sgml
+++ b/doc/src/sgml/ref/create_index.sgml
@@ -865,6 +865,13 @@ Indexes:
will interpret it as <literal>USING gist</literal>, to simplify conversion
of old databases to GiST.
</para>
+
+ <para>
+ Each backend running the <command>CREATE INDEX</command> command will
+ report their progress to the
+ <structname>pg_stat_progress_create_index</structname> view.
+ See <xref linkend="create-index-progress-reporting"/> for details.
+ </para>
</refsect1>
<refsect1>
@@ -978,6 +985,7 @@ CREATE INDEX CONCURRENTLY sales_quantity_index ON sales_table (quantity);
<member><xref linkend="sql-alterindex"/></member>
<member><xref linkend="sql-dropindex"/></member>
<member><xref linkend="sql-reindex"/></member>
+ <member><xref linkend="create-index-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>
diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index 5754ad5aa6..14cc88a852 100644
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -904,6 +904,7 @@ PostgreSQL documentation
<simplelist type="inline">
<member><xref linkend="app-pgdump"/></member>
+ <member><xref linkend="basebackup-progress-reporting"/></member>
</simplelist>
</refsect1>
diff --git a/doc/src/sgml/ref/reindex.sgml b/doc/src/sgml/ref/reindex.sgml
index 07795b5737..f69f5db403 100644
--- a/doc/src/sgml/ref/reindex.sgml
+++ b/doc/src/sgml/ref/reindex.sgml
@@ -493,6 +493,12 @@ Indexes:
is reindexed concurrently, those indexes will be skipped. (It is possible
to reindex such indexes without the <command>CONCURRENTLY</command> option.)
</para>
+
+ <para>
+ Each backend running the <command>REINDEX</command> command will report
+ their progress to the <structname>pg_stat_progress_create_index</structname>
+ view. See <xref linkend="create-index-progress-reporting"/> for details.
+ </para>
</refsect2>
</refsect1>
@@ -551,6 +557,7 @@ REINDEX TABLE CONCURRENTLY my_broken_table;
<member><xref linkend="sql-createindex"/></member>
<member><xref linkend="sql-dropindex"/></member>
<member><xref linkend="app-reindexdb"/></member>
+ <member><xref linkend="create-index-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>
diff --git a/doc/src/sgml/ref/vacuum.sgml b/doc/src/sgml/ref/vacuum.sgml
index 4bb624979b..bab3d00313 100644
--- a/doc/src/sgml/ref/vacuum.sgml
+++ b/doc/src/sgml/ref/vacuum.sgml
@@ -393,6 +393,15 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet
information about automatic and manual vacuuming, see
<xref linkend="routine-vacuuming"/>.
</para>
+ <para>
+ Each backend running the <command>VACUUM</command> command without the
+ <literal>FULL</literal> option will report their progress in the
+ <structname>pg_stat_progress_vacuum</structname> view. Backends running
+ <command>VACUUM</command> with the <literal>FULL</literal> option report
+ progress in the <structname>pg_stat_progress_cluster</structname> instead.
+ See <xref linkend="vacuum-progress-reporting"/> and
+ <xref linkend="cluster-progress-reporting"/> for details.
+ </para>
</refsect1>
<refsect1>
@@ -422,6 +431,8 @@ VACUUM (VERBOSE, ANALYZE) onek;
<member><xref linkend="app-vacuumdb"/></member>
<member><xref linkend="runtime-config-resource-vacuum-cost"/></member>
<member><xref linkend="autovacuum"/></member>
+ <member><xref linkend="vacuum-progress-reporting"/></member>
+ <member><xref linkend="cluster-progress-reporting"/></member>
</simplelist>
</refsect1>
</refentry>
--
2.26.2
--------------DA8D60BF026F7ACE69A9AEE5
Content-Type: text/x-patch; charset=UTF-8;
name="v7-0004-0002-review.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
filename="v7-0004-0002-review.patch"
^ permalink raw reply [nested|flat] 2+ messages in thread
* Re: Remove MSVC scripts from the tree
@ 2023-11-08 08:41 Peter Eisentraut <[email protected]>
0 siblings, 0 replies; 2+ messages in thread
From: Peter Eisentraut @ 2023-11-08 08:41 UTC (permalink / raw)
To: Michael Paquier <[email protected]>; +Cc: Postgres hackers <[email protected]>
On 12.10.23 07:23, Michael Paquier wrote:
>> - Is src/backend/utils/README.Gen_dummy_probes still correct after this?
>> AFAICT, the Perl-based MSVC build system uses Gen_dummy_probes.pl, but the
>> meson build uses Gen_dummy_probes.sed even on Windows. Is that correct,
>> intended?
> Interesting point. This may depend on the environment at the end? As
> far as I can see, sed is currently a hard requirement in the meson
> build and we'd fail if the command cannot be used. The buildfarm
> machines that test meson are able to find sed, making
> Gen_dummy_probes.pl not necessary:
> https://buildfarm.postgresql.org/cgi-bin/show_stage_log.pl?nm=drongo&dt=2023-10-11%2020%3A21%3A1...
>
> So the $1000 question is: could there be a point in keeping the perl
> script around if sed cannot be found? The buildfarm coverage is
> currently saying no thanks to chocolatey, at least. The VM images
> compiled by Andres for the CI seem to have the same opinion.
I don't think we should rely on sed being there on Windows. Maybe it's
true now on the handful of buildfarm/CI machines and early adopters, but
do we have any indication that that is systematic or just an accident?
Since we definitely require Perl now, we could just as well use the Perl
script and avoid this issue.
Attached is a Perl version of the sed script, converted by hand (so not
the super-verbose s2p thing). It's basically just the sed script with
semicolons added and the backslashes in the regular expressions moved
around. I think we could use something like that for all platforms now.
Attachments:
[text/x-perl-script] Gen_dummy_probes2.pl (1.2K, ../../[email protected]/2-Gen_dummy_probes2.pl)
download | inline:
#-------------------------------------------------------------------------
# Perl script to create dummy probes.h file when dtrace is not available
#
# Copyright (c) 2008-2023, PostgreSQL Global Development Group
#
# src/backend/utils/Gen_dummy_probes.pl
#-------------------------------------------------------------------------
use strict;
use warnings;
m/^[ ]*probe / || next;
s/^[ ]*probe ([^(]*)(.*);/$1$2/;
s/__/_/g;
y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/;
s/^/#define TRACE_POSTGRESQL_/;
s/\([^,)]{1,}\)/(INT1)/;
s/\([^,)]{1,}, [^,)]{1,}\)/(INT1, INT2)/;
s/\([^,)]{1,}, [^,)]{1,}, [^,)]{1,}\)/(INT1, INT2, INT3)/;
s/\([^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}\)/(INT1, INT2, INT3, INT4)/;
s/\([^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}\)/(INT1, INT2, INT3, INT4, INT5)/;
s/\([^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}\)/(INT1, INT2, INT3, INT4, INT5, INT6)/;
s/\([^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}\)/(INT1, INT2, INT3, INT4, INT5, INT6, INT7)/;
s/\([^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}, [^,)]{1,}\)/(INT1, INT2, INT3, INT4, INT5, INT6, INT7, INT8)/;
s/$/ do {} while (0)/;
print;
s/\(.*$/_ENABLED() (0)/;
print;
^ permalink raw reply [nested|flat] 2+ messages in thread
end of thread, other threads:[~2023-11-08 08:41 UTC | newest]
Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2021-02-05 22:11 [PATCH 3/6] Add backlinks to progress reporting documentation Matthias van de Meent <[email protected]>
2023-11-08 08:41 Re: Remove MSVC scripts from the tree Peter Eisentraut <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox