doc: Add link targets to CREATE/ALTER FOREIGN TABLE reference pages

This adds IDs to create_foreign_table.sgml's and
alter_foreign_table.sgml's <varlistentry> and <refsect1>, similar to
other reference pages.

Author: jian he <jian.universality@gmail.com>
Reviewed-by: Quan Zongliang <quanzongliang@yeah.net>
Reviewed-by: wenhui qiu <qiuwenhuifx@gmail.com>
Discussion: https://www.postgresql.org/message-id/flat/CACJufxE6fW2jFAyTFWEYdUSDP%3D9P2yYerdksPTgxqDM4DZvvvw%40mail.gmail.com
This commit is contained in:
Peter Eisentraut 2026-02-24 11:27:49 +01:00
parent a99c6b56ff
commit dea0812cda
2 changed files with 63 additions and 63 deletions

View file

@ -58,7 +58,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</synopsis>
</refsynopsisdiv>
<refsect1>
<refsect1 id="sql-alterforeigntable-description">
<title>Description</title>
<para>
@ -66,7 +66,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
existing foreign table. There are several subforms:
<variablelist>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-add-column">
<term><literal>ADD COLUMN</literal></term>
<listitem>
<para>
@ -79,7 +79,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-drop-column">
<term><literal>DROP COLUMN [ IF EXISTS ]</literal></term>
<listitem>
<para>
@ -94,7 +94,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-data-type">
<term><literal>SET DATA TYPE</literal></term>
<listitem>
<para>
@ -106,7 +106,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-drop-default">
<term><literal>SET</literal>/<literal>DROP DEFAULT</literal></term>
<listitem>
<para>
@ -118,7 +118,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-drop-not-null">
<term><literal>SET</literal>/<literal>DROP NOT NULL</literal></term>
<listitem>
<para>
@ -127,7 +127,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-statistics">
<term><literal>SET STATISTICS</literal></term>
<listitem>
<para>
@ -140,7 +140,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-attribute-option">
<term><literal>SET ( <replaceable class="parameter">attribute_option</replaceable> = <replaceable class="parameter">value</replaceable> [, ... ] )</literal></term>
<term><literal>RESET ( <replaceable class="parameter">attribute_option</replaceable> [, ... ] )</literal></term>
<listitem>
@ -152,7 +152,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-storage-parameter">
<term>
<literal>SET STORAGE</literal>
</term>
@ -167,7 +167,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-add-table-constraint">
<term><literal>ADD <replaceable class="parameter">table_constraint</replaceable> [ NOT VALID ]</literal></term>
<listitem>
<para>
@ -190,7 +190,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-validate-constraint">
<term><literal>VALIDATE CONSTRAINT</literal></term>
<listitem>
<para>
@ -201,7 +201,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-drop-constraint">
<term><literal>DROP CONSTRAINT [ IF EXISTS ]</literal></term>
<listitem>
<para>
@ -213,7 +213,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-disable-enable-trigger">
<term><literal>DISABLE</literal>/<literal>ENABLE [ REPLICA | ALWAYS ] TRIGGER</literal></term>
<listitem>
<para>
@ -224,7 +224,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-without-oids">
<term><literal>SET WITHOUT OIDS</literal></term>
<listitem>
<para>
@ -235,7 +235,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-inherit">
<term><literal>INHERIT <replaceable class="parameter">parent_table</replaceable></literal></term>
<listitem>
<para>
@ -247,7 +247,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-no-inherit">
<term><literal>NO INHERIT <replaceable class="parameter">parent_table</replaceable></literal></term>
<listitem>
<para>
@ -257,7 +257,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-owner-to">
<term><literal>OWNER</literal></term>
<listitem>
<para>
@ -267,7 +267,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-changes-options">
<term><literal>OPTIONS ( [ ADD | SET | DROP ] <replaceable class="parameter">option</replaceable> ['<replaceable class="parameter">value</replaceable>'] [, ... ] )</literal></term>
<listitem>
<para>
@ -282,7 +282,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-rename">
<term><literal>RENAME</literal></term>
<listitem>
<para>
@ -292,7 +292,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-desc-set-schema">
<term><literal>SET SCHEMA</literal></term>
<listitem>
<para>
@ -332,12 +332,12 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</para>
</refsect1>
<refsect1>
<refsect1 id="sql-alterforeigntable-parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-name">
<term><replaceable class="parameter">name</replaceable></term>
<listitem>
<para>
@ -351,7 +351,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-column-name">
<term><replaceable class="parameter">column_name</replaceable></term>
<listitem>
<para>
@ -360,7 +360,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-new-column-name">
<term><replaceable class="parameter">new_column_name</replaceable></term>
<listitem>
<para>
@ -369,7 +369,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-new-name">
<term><replaceable class="parameter">new_name</replaceable></term>
<listitem>
<para>
@ -378,7 +378,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-data-type">
<term><replaceable class="parameter">data_type</replaceable></term>
<listitem>
<para>
@ -388,7 +388,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-table-constraint">
<term><replaceable class="parameter">table_constraint</replaceable></term>
<listitem>
<para>
@ -397,7 +397,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-constraint-name">
<term><replaceable class="parameter">constraint_name</replaceable></term>
<listitem>
<para>
@ -406,7 +406,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-cascade">
<term><literal>CASCADE</literal></term>
<listitem>
<para>
@ -418,7 +418,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-restrict">
<term><literal>RESTRICT</literal></term>
<listitem>
<para>
@ -428,7 +428,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-trigger-name">
<term><replaceable class="parameter">trigger_name</replaceable></term>
<listitem>
<para>
@ -437,7 +437,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-all">
<term><literal>ALL</literal></term>
<listitem>
<para>
@ -449,7 +449,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-user">
<term><literal>USER</literal></term>
<listitem>
<para>
@ -459,7 +459,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-parent-table">
<term><replaceable class="parameter">parent_table</replaceable></term>
<listitem>
<para>
@ -468,7 +468,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-new-owner">
<term><replaceable class="parameter">new_owner</replaceable></term>
<listitem>
<para>
@ -477,7 +477,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-alterforeigntable-parms-new-schema">
<term><replaceable class="parameter">new_schema</replaceable></term>
<listitem>
<para>
@ -488,7 +488,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</variablelist>
</refsect1>
<refsect1>
<refsect1 id="sql-alterforeigntable-notes">
<title>Notes</title>
<para>
@ -510,7 +510,7 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
</para>
</refsect1>
<refsect1>
<refsect1 id="sql-alterforeigntable-examples">
<title>Examples</title>
<para>
@ -528,7 +528,7 @@ ALTER FOREIGN TABLE myschema.distributors OPTIONS (ADD opt1 'value', SET opt2 'v
</refsect1>
<refsect1>
<refsect1 id="sql-alterforeigntable-compatibility">
<title>Compatibility</title>
<para>

View file

@ -109,12 +109,12 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</para>
</refsect1>
<refsect1>
<refsect1 id="sql-createforeigntable-parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-if-not-exists">
<term><literal>IF NOT EXISTS</literal></term>
<listitem>
<para>
@ -126,7 +126,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-table-name">
<term><replaceable class="parameter">table_name</replaceable></term>
<listitem>
<para>
@ -135,7 +135,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-column-name">
<term><replaceable class="parameter">column_name</replaceable></term>
<listitem>
<para>
@ -144,7 +144,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-data-type">
<term><replaceable class="parameter">data_type</replaceable></term>
<listitem>
<para>
@ -156,7 +156,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-collate">
<term><literal>COLLATE <replaceable>collation</replaceable></literal></term>
<listitem>
<para>
@ -167,7 +167,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-inherit">
<term><literal>INHERITS ( <replaceable>parent_table</replaceable> [, ... ] )</literal></term>
<listitem>
<para>
@ -180,7 +180,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-partition">
<term><literal>PARTITION OF <replaceable>parent_table</replaceable> { FOR VALUES <replaceable class="parameter">partition_bound_spec</replaceable> | DEFAULT }</literal></term>
<listitem>
<para>
@ -196,7 +196,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like">
<term><literal>LIKE <replaceable>source_table</replaceable> [ <replaceable>like_option</replaceable> ... ]</literal></term>
<listitem>
<para>
@ -228,7 +228,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
available options are:
<variablelist>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like-opt-comments">
<term><literal>INCLUDING COMMENTS</literal></term>
<listitem>
<para>
@ -240,7 +240,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like-opt-constraints">
<term><literal>INCLUDING CONSTRAINTS</literal></term>
<listitem>
<para>
@ -251,7 +251,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like-opt-default">
<term><literal>INCLUDING DEFAULTS</literal></term>
<listitem>
<para>
@ -265,7 +265,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like-opt-generated">
<term><literal>INCLUDING GENERATED</literal></term>
<listitem>
<para>
@ -275,7 +275,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like-opt-statistics">
<term><literal>INCLUDING STATISTICS</literal></term>
<listitem>
<para>
@ -284,7 +284,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-like-opt-all">
<term><literal>INCLUDING ALL</literal></term>
<listitem>
<para>
@ -301,7 +301,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-constraint">
<term><literal>CONSTRAINT <replaceable class="parameter">constraint_name</replaceable></literal></term>
<listitem>
<para>
@ -315,7 +315,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-not-null">
<term><literal>NOT NULL</literal> [ NO INHERIT ]</term>
<listitem>
<para>
@ -329,7 +329,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-null">
<term><literal>NULL</literal></term>
<listitem>
<para>
@ -344,7 +344,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-check">
<term><literal>CHECK ( <replaceable class="parameter">expression</replaceable> ) [ NO INHERIT ] </literal></term>
<listitem>
<para>
@ -371,7 +371,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-default">
<term><literal>DEFAULT
<replaceable>default_expr</replaceable></literal></term>
<listitem>
@ -392,7 +392,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-generated-stored">
<term><literal>GENERATED ALWAYS AS ( <replaceable>generation_expr</replaceable> ) [ STORED | VIRTUAL ]</literal><indexterm><primary>generated column</primary></indexterm></term>
<listitem>
<para>
@ -419,7 +419,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-server">
<term><replaceable class="parameter">server_name</replaceable></term>
<listitem>
<para>
@ -430,7 +430,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</listitem>
</varlistentry>
<varlistentry>
<varlistentry id="sql-createforeigntable-parms-option">
<term><literal>OPTIONS ( <replaceable class="parameter">option</replaceable> '<replaceable class="parameter">value</replaceable>' [, ...] )</literal></term>
<listitem>
<para>
@ -448,7 +448,7 @@ WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM
</refsect1>
<refsect1>
<refsect1 id="sql-createforeigntable-notes">
<title>Notes</title>
<para>