granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/load.sgml

   1 <!--
   2 $PostgreSQL: pgsql/doc/src/sgml/ref/load.sgml,v 1.21 2005/01/04 00:39:53 tgl Exp $
   3 -->
   4
   5 <refentry id="SQL-LOAD">
   6  <refmeta>
   7   <refentrytitle id="SQL-LOAD-TITLE">LOAD</refentrytitle>
   8   <refmiscinfo>SQL - Language Statements</refmiscinfo>
   9  </refmeta>
  10
  11  <refnamediv>
  12   <refname>LOAD</refname>
  13   <refpurpose>load or reload a shared library file</refpurpose>
  14  </refnamediv>
  15
  16  <indexterm zone="sql-load">
  17   <primary>LOAD</primary>
  18  </indexterm>
  19
  20  <refsynopsisdiv>
  21 <synopsis>
  22 LOAD '<replaceable class="PARAMETER">filename</replaceable>'
  23 </synopsis>
  24  </refsynopsisdiv>
  25
  26  <refsect1 id="sql-load-description">
  27   <title>Description</title>
  28
  29   <para>
  30    This command loads a shared library file into the <productname>PostgreSQL</>
  31    server's address space.  If the file had been loaded previously,
  32    it is first unloaded.  This command is primarily useful to unload
  33    and reload a shared library file that has been changed since the
  34    server first loaded it.  To make use of the shared library,
  35    function(s) in it need to be declared using the <xref
  36    linkend="sql-createfunction" endterm="sql-createfunction-title">
  37    command.
  38   </para>
  39
  40   <para>
  41    The file name is specified in the same way as for shared library
  42    names in <xref linkend="sql-createfunction" endterm="sql-createfunction-title">; in particular, one
  43    may rely on a search path and automatic addition of the system's standard
  44    shared library file name extension.  See <xref linkend="xfunc-c"> for
  45    more information on this topic.
  46   </para>
  47  </refsect1>
  48
  49  <refsect1 id="sql-load-compat">
  50   <title>Compatibility</title>
  51
  52   <para>
  53    <command>LOAD</command> is a <productname>PostgreSQL</productname>
  54    extension.
  55   </para>
  56  </refsect1>
  57
  58
  59  <refsect1>
  60   <title>See Also</title>
  61
  62   <para>
  63    <xref linkend="sql-createfunction" endterm="sql-createfunction-title">
  64   </para>
  65  </refsect1>
  66 </refentry>
  67
  68 <!-- Keep this comment at the end of the file
  69 Local variables:
  70 mode: sgml
  71 sgml-omittag:nil
  72 sgml-shorttag:t
  73 sgml-minimize-attributes:nil
  74 sgml-always-quote-attributes:t
  75 sgml-indent-step:1
  76 sgml-indent-data:t
  77 sgml-parent-document:nil
  78 sgml-default-dtd-file:"../reference.ced"
  79 sgml-exposed-tags:nil
  80 sgml-local-catalogs:"/usr/lib/sgml/catalog"
  81 sgml-local-ecat-files:nil
  82 End:
  83 -->