postgresql/doc/src/sgml/ref/load.sgml
Peter Eisentraut bb4eefe7bf doc: Improve DocBook XML validity
DocBook XML is superficially compatible with DocBook SGML but has a
slightly stricter DTD that we have been violating in a few cases.
Although XSLT doesn't care whether the document is valid, the style
sheets don't necessarily process invalid documents correctly, so we need
to work toward fixing this.

This first commit moves the indexterms in refentry elements to an
allowed position.  It has no impact on the output.
2014-02-23 21:31:08 -05:00

80 lines
2.1 KiB
Plaintext

<!--
doc/src/sgml/ref/load.sgml
-->
<refentry id="SQL-LOAD">
<indexterm zone="sql-load">
<primary>LOAD</primary>
</indexterm>
<refmeta>
<refentrytitle>LOAD</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>LOAD</refname>
<refpurpose>load a shared library file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
LOAD '<replaceable class="PARAMETER">filename</replaceable>'
</synopsis>
</refsynopsisdiv>
<refsect1 id="sql-load-description">
<title>Description</title>
<para>
This command loads a shared library file into the <productname>PostgreSQL</>
server's address space. If the file has been loaded already,
the command does nothing. Shared library files that contain C functions
are automatically loaded whenever one of their functions is called.
Therefore, an explicit <command>LOAD</> is usually only needed to
load a library that modifies the server's behavior through <quote>hooks</>
rather than providing a set of functions.
</para>
<para>
The file name is specified in the same way as for shared library
names in <xref linkend="sql-createfunction">; in particular, one
can rely on a search path and automatic addition of the system's standard
shared library file name extension. See <xref linkend="xfunc-c"> for
more information on this topic.
</para>
<indexterm>
<primary><filename>$libdir/plugins</></primary>
</indexterm>
<para>
Non-superusers can only apply <command>LOAD</> to library files
located in <filename>$libdir/plugins/</> &mdash; the specified
<replaceable class="PARAMETER">filename</replaceable> must begin
with exactly that string. (It is the database administrator's
responsibility to ensure that only <quote>safe</> libraries
are installed there.)
</para>
</refsect1>
<refsect1 id="sql-load-compat">
<title>Compatibility</title>
<para>
<command>LOAD</command> is a <productname>PostgreSQL</productname>
extension.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="sql-createfunction">
</para>
</refsect1>
</refentry>