rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: copy-editing in create_access_method.sgml. 

Improve shaky English grammar.  And markup.
This commit is contained in:
Tom Lane 2016-08-16 11:35:36 -04:00
parent 8fc571b7dd
commit 9b002cc9fe
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/src/sgml/ref/create_access_method.sgml
View File

@ -57,29 +57,28 @@ CREATE ACCESS METHOD <replaceable class="parameter">name</replaceable>
</varlistentry>
<varlistentry>
<term><literal>access_method_type</literal></term>
<term><replaceable class="parameter">access_method_type</replaceable></term>
<listitem>
<para>
This clause specifies type of access method to define.
This clause specifies the type of access method to define.
Only <literal>INDEX</literal> is supported at present.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>HANDLER <replaceable class="parameter">handler_function</replaceable></literal></term>
<term><replaceable class="parameter">handler_function</replaceable></term>
<listitem>
<para><replaceable class="parameter">handler_function</replaceable> is the
name of a previously registered function that will be called to
retrieve the struct which contains required parameters and functions
of access method to the core. The handler function must take single
argument of type <type>internal</>, and its return type depends on the
type of access method; for <literal>INDEX</literal> access methods, it
must be <type>index_am_handler</type>.
</para>
<para>
See <xref linkend="index-api"> for index access methods API.
<replaceable class="parameter">handler_function</replaceable> is the
name (possibly schema-qualified) of a previously registered function
that represents the access method. The handler function must be
declared to take a single argument of type <type>internal</>,
and its return type depends on the type of access method;
for <literal>INDEX</literal> access methods, it must
be <type>index_am_handler</type>. The C-level API that the handler
function must implement varies depending on the type of access method.
The index access method API is described in <xref linkend="indexam">.
</para>
</listitem>
</varlistentry>
@ -90,7 +89,7 @@ CREATE ACCESS METHOD <replaceable class="parameter">name</replaceable>
<title>Examples</title>
<para>
Create an access method <literal>heptree</> with
Create an index access method <literal>heptree</> with
handler function <literal>heptree_handler</>:
<programlisting>
CREATE ACCESS METHOD heptree TYPE INDEX HANDLER heptree_handler;