diff options
Diffstat (limited to 'doc/src/sgml/ref/load.sgml')
| -rw-r--r-- | doc/src/sgml/ref/load.sgml | 345 |
1 files changed, 177 insertions, 168 deletions
diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml index 66fafdc887..fc2f04ed51 100644 --- a/doc/src/sgml/ref/load.sgml +++ b/doc/src/sgml/ref/load.sgml @@ -1,170 +1,179 @@ <REFENTRY ID="SQL-LOAD"> -<REFMETA> -<REFENTRYTITLE> -LOAD -</REFENTRYTITLE> -<REFMISCINFO>SQL - Language Statements</REFMISCINFO> -</REFMETA> -<REFNAMEDIV> -<REFNAME> -LOAD -</REFNAME> -<REFPURPOSE> -Dynamically loads an object file -</REFPURPOSE> - -<REFSYNOPSISDIV> -<REFSYNOPSISDIVINFO> -<DATE>1998-09-24</DATE> -</REFSYNOPSISDIVINFO> -<SYNOPSIS> -<REPLACEABLE CLASS="PARAMETER"> -</REPLACEABLE> -LOAD '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>' -</SYNOPSIS> - -<REFSECT2 ID="R2-SQL-LOAD-1"> -<REFSECT2INFO> -<DATE>1998-09-01</DATE> -</REFSECT2INFO> -<TITLE> -Inputs -</TITLE> -<PARA> -</PARA> -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE> -</TERM> -<LISTITEM> -<PARA> -Object file for dynamic loading. - -</VARIABLELIST> - -</REFSECT2> - -<REFSECT2 ID="R2-SQL-LOAD-2"> -<REFSECT2INFO> -<DATE>1998-09-24</DATE> -</REFSECT2INFO> -<TITLE> -Outputs -</TITLE> -<PARA> - -<VARIABLELIST> -<VARLISTENTRY> -<TERM> -<returnvalue>LOAD</returnvalue> -</TERM> -<LISTITEM> -<PARA> -Message returned on successful completion. - -<VARLISTENTRY> -<TERM> -<returnvalue>ERROR: LOAD: could not open file '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>'</returnvalue> -</TERM> -<LISTITEM> -<PARA> -Message returned if the specified file is not found. The file must be visible -<emphasis>to the <productname>Postgres</productname> backend</emphasis>, -with the appropriate full path name specified, to avoid this message. - -</VARIABLELIST> - -</REFSECT2> -</REFSYNOPSISDIV> - -<REFSECT1 ID="R1-SQL-LOAD-1"> -<REFSECT1INFO> -<DATE>1998-09-24</DATE> -</REFSECT1INFO> -<TITLE> -Description -</TITLE> -<PARA> -Loads an object (or ".o") file into the -<productname>Postgres</productname> backend address space. Once a -file is loaded, all functions in that file can be accessed. This -function is used in support of user-defined types and functions. - -<para> -If a file is not loaded using -<command>LOAD</command>, -the file will be loaded automatically the first time the -function is called by <productname>Postgres</productname>. -<command>LOAD</command> -can also be used to reload an object file if it has been edited and -recompiled. Only objects created from C language files are supported -at this time. - -<REFSECT2 ID="R2-SQL-LOAD-3"> -<REFSECT2INFO> -<DATE>1998-09-24</DATE> -</REFSECT2INFO> -<TITLE> -Notes -</TITLE> -<PARA> -Functions in loaded object files should not call functions in other -object files loaded through the -<command>LOAD</command> -command. For example, all functions in file <literal>A</literal> should -call each other, functions in the standard or math libraries, or in -Postgres itself. They should not call functions defined in a different -loaded file <literal>B</literal>. - This is because if <literal>B</literal> is reloaded, the Postgres loader is -not able to relocate the calls from the functions in <literal>A</literal> into -the new address space of <literal>B</literal>. -If <literal>B</literal> is not reloaded, however, there will -not be a problem. - -<para> -Object files must be compiled to contain position independent code. -For example, -on DECstations you must use -<application>/bin/cc</application> -with the <literal>-G 0</literal> option when compiling object files to be -loaded. - -<para> -Note that if you are porting <productname>Postgres</productname> - to a new platform, <command>LOAD</command> -will have to work in order to support ADTs. - -</REFSECT2> - -<REFSECT1 ID="R1-SQL-LOAD-2"> -<TITLE> -Usage -</TITLE> -<PARA> -<ProgramListing> ---Load the file /usr/postgres/demo/circle.o --- -LOAD '/usr/postgres/demo/circle.o' -</ProgramListing> - -</REFSECT1> - -<REFSECT1 ID="R1-SQL-LOAD-3"> -<TITLE> -Compatibility -</TITLE> -<PARA> -</PARA> - -<REFSECT2 ID="R2-SQL-LOAD-4"> -<REFSECT2INFO> -<DATE>1998-09-24</DATE> -</REFSECT2INFO> -<TITLE> -SQL92 -</TITLE> -<PARA> -There is no <command>LOAD</command> in <acronym>SQL92</acronym>. - + <REFMETA> + <REFENTRYTITLE> + LOAD + </REFENTRYTITLE> + <REFMISCINFO>SQL - Language Statements</REFMISCINFO> + </REFMETA> + <REFNAMEDIV> + <REFNAME> + LOAD + </REFNAME> + <REFPURPOSE> + Dynamically loads an object file + </REFPURPOSE> + </refnamediv> + <REFSYNOPSISDIV> + <REFSYNOPSISDIVINFO> + <DATE>1998-09-24</DATE> + </REFSYNOPSISDIVINFO> + <SYNOPSIS> + <REPLACEABLE CLASS="PARAMETER"> + </REPLACEABLE> + LOAD '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>' + </SYNOPSIS> + + <REFSECT2 ID="R2-SQL-LOAD-1"> + <REFSECT2INFO> + <DATE>1998-09-01</DATE> + </REFSECT2INFO> + <TITLE> + Inputs + </TITLE> + <PARA> + </PARA> + <VARIABLELIST> + <VARLISTENTRY> + <TERM> + <REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE> + </TERM> + <LISTITEM> + <PARA> + Object file for dynamic loading. + </para> + </listitem> + </varlistentry> + </VARIABLELIST> + + </REFSECT2> + + <REFSECT2 ID="R2-SQL-LOAD-2"> + <REFSECT2INFO> + <DATE>1998-09-24</DATE> + </REFSECT2INFO> + <TITLE> + Outputs + </TITLE> + <PARA> + + <VARIABLELIST> + <VARLISTENTRY> + <TERM> + <returnvalue>LOAD</returnvalue> + </TERM> + <LISTITEM> + <PARA> + Message returned on successful completion. + </para> + </listitem> + </varlistentry> + <VARLISTENTRY> + <TERM> + <returnvalue>ERROR: LOAD: could not open file '<REPLACEABLE CLASS="PARAMETER">filename</REPLACEABLE>'</returnvalue> + </TERM> + <LISTITEM> + <PARA> + Message returned if the specified file is not found. The file must be visible + <emphasis>to the <productname>Postgres</productname> backend</emphasis>, + with the appropriate full path name specified, to avoid this message. + </para> + </listitem> + </varlistentry> + </VARIABLELIST> + </para> + </REFSECT2> + </REFSYNOPSISDIV> + + <REFSECT1 ID="R1-SQL-LOAD-1"> + <REFSECT1INFO> + <DATE>1998-09-24</DATE> + </REFSECT1INFO> + <TITLE> + Description + </TITLE> + <PARA> + Loads an object (or ".o") file into the + <productname>Postgres</productname> backend address space. Once a + file is loaded, all functions in that file can be accessed. This + function is used in support of user-defined types and functions. + </para> + <para> + If a file is not loaded using + <command>LOAD</command>, + the file will be loaded automatically the first time the + function is called by <productname>Postgres</productname>. + <command>LOAD</command> + can also be used to reload an object file if it has been edited and + recompiled. Only objects created from C language files are supported + at this time. + </para> + <REFSECT2 ID="R2-SQL-LOAD-3"> + <REFSECT2INFO> + <DATE>1998-09-24</DATE> + </REFSECT2INFO> + <TITLE> + Notes + </TITLE> + <PARA> + Functions in loaded object files should not call functions in other + object files loaded through the + <command>LOAD</command> + command. For example, all functions in file <literal>A</literal> should + call each other, functions in the standard or math libraries, or in + Postgres itself. They should not call functions defined in a different + loaded file <literal>B</literal>. + This is because if <literal>B</literal> is reloaded, the Postgres loader is + not able to relocate the calls from the functions in <literal>A</literal> into + the new address space of <literal>B</literal>. + If <literal>B</literal> is not reloaded, however, there will + not be a problem. + </para> + <para> + Object files must be compiled to contain position independent code. + For example, + on DECstations you must use + <application>/bin/cc</application> + with the <literal>-G 0</literal> option when compiling object files to be + loaded. + </para> + <para> + Note that if you are porting <productname>Postgres</productname> + to a new platform, <command>LOAD</command> + will have to work in order to support ADTs. + </para> + </REFSECT2> + </refsect1> + + <REFSECT1 ID="R1-SQL-LOAD-2"> + <TITLE> + Usage + </TITLE> + <PARA> + <ProgramListing> + --Load the file /usr/postgres/demo/circle.o + -- + LOAD '/usr/postgres/demo/circle.o' + </ProgramListing> + </para> + </REFSECT1> + + <REFSECT1 ID="R1-SQL-LOAD-3"> + <TITLE> + Compatibility + </TITLE> + <PARA> + </PARA> + + <REFSECT2 ID="R2-SQL-LOAD-4"> + <REFSECT2INFO> + <DATE>1998-09-24</DATE> + </REFSECT2INFO> + <TITLE> + SQL92 + </TITLE> + <PARA> + There is no <command>LOAD</command> in <acronym>SQL92</acronym>. + </para> + </refsect2> + </refsect1> </REFENTRY> |