v20231128-0002-add-docs-for-amcanbuildparallel.patch
text/x-patch
Filename: v20231128-0002-add-docs-for-amcanbuildparallel.patch
Type: text/x-patch
Part: 1
Patch
Format: format-patch
Series: patch v20231128-0002
Subject: add docs for amcanbuildparallel
| File | + | − |
|---|---|---|
| doc/src/sgml/indexam.sgml | 7 | 0 |
From e3f42c711c0426b85edf3a88a538e58bc0588b6e Mon Sep 17 00:00:00 2001
From: Tomas Vondra <tomas.vondra@postgresql.org>
Date: Tue, 28 Nov 2023 18:37:42 +0100
Subject: [PATCH v20231128 2/4] add docs for amcanbuildparallel
---
doc/src/sgml/indexam.sgml | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml
index f107c43d6a6..cc4135e3940 100644
--- a/doc/src/sgml/indexam.sgml
+++ b/doc/src/sgml/indexam.sgml
@@ -123,6 +123,8 @@ typedef struct IndexAmRoutine
bool ampredlocks;
/* does AM support parallel scan? */
bool amcanparallel;
+ /* does AM support parallel build? */
+ bool amcanbuildparallel;
/* does AM support columns included with clause INCLUDE? */
bool amcaninclude;
/* does AM use maintenance_work_mem? */
@@ -286,6 +288,11 @@ ambuild (Relation heapRelation,
and compute the keys that need to be inserted into the index.
The function must return a palloc'd struct containing statistics about
the new index.
+ The <structfield>amcanbuildparallel</structfield> flag indicates whether
+ the access method supports parallel index builds. When set to <literal>true</literal>,
+ the system will attempt to allocate parallel workers for the build.
+ Access methods supporting only non-parallel index builds should leave
+ this flag set to <literal>false</literal>.
</para>
<para>
--
2.42.0