Skip to content

Commit 9b002cc

Browse files
committed
Doc: copy-editing in create_access_method.sgml.
Improve shaky English grammar. And markup.
1 parent 8fc571b commit 9b002cc

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

doc/src/sgml/ref/create_access_method.sgml

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,29 +57,28 @@ CREATE ACCESS METHOD <replaceable class="parameter">name</replaceable>
5757
</varlistentry>
5858

5959
<varlistentry>
60-
<term><literal>access_method_type</literal></term>
60+
<term><replaceable class="parameter">access_method_type</replaceable></term>
6161
<listitem>
6262
<para>
63-
This clause specifies type of access method to define.
63+
This clause specifies the type of access method to define.
6464
Only <literal>INDEX</literal> is supported at present.
6565
</para>
6666
</listitem>
6767
</varlistentry>
6868

6969
<varlistentry>
70-
<term><literal>HANDLER <replaceable class="parameter">handler_function</replaceable></literal></term>
70+
<term><replaceable class="parameter">handler_function</replaceable></term>
7171
<listitem>
72-
<para><replaceable class="parameter">handler_function</replaceable> is the
73-
name of a previously registered function that will be called to
74-
retrieve the struct which contains required parameters and functions
75-
of access method to the core. The handler function must take single
76-
argument of type <type>internal</>, and its return type depends on the
77-
type of access method; for <literal>INDEX</literal> access methods, it
78-
must be <type>index_am_handler</type>.
79-
</para>
80-
8172
<para>
82-
See <xref linkend="index-api"> for index access methods API.
73+
<replaceable class="parameter">handler_function</replaceable> is the
74+
name (possibly schema-qualified) of a previously registered function
75+
that represents the access method. The handler function must be
76+
declared to take a single argument of type <type>internal</>,
77+
and its return type depends on the type of access method;
78+
for <literal>INDEX</literal> access methods, it must
79+
be <type>index_am_handler</type>. The C-level API that the handler
80+
function must implement varies depending on the type of access method.
81+
The index access method API is described in <xref linkend="indexam">.
8382
</para>
8483
</listitem>
8584
</varlistentry>
@@ -90,7 +89,7 @@ CREATE ACCESS METHOD <replaceable class="parameter">name</replaceable>
9089
<title>Examples</title>
9190

9291
<para>
93-
Create an access method <literal>heptree</> with
92+
Create an index access method <literal>heptree</> with
9493
handler function <literal>heptree_handler</>:
9594
<programlisting>
9695
CREATE ACCESS METHOD heptree TYPE INDEX HANDLER heptree_handler;

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy