1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_vhost_remove">
<refmeta>
<refentrytitle>VHOST_REMOVE</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>VHOST_REMOVE</refname>
<refpurpose>remove a virtual host or virtual directory</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_vhost_remove">
<funcprototype id="fproto_vhost_remove">
<funcdef>Void DB.DBA.<function>VHOST_REMOVE</function></funcdef>
<paramdef>in <parameter>vhost</parameter> varchar</paramdef>
<paramdef>in <parameter>lhost</parameter> varchar</paramdef>
<paramdef>in <parameter>lpath</parameter> varchar</paramdef>
<paramdef>in <parameter>del_vsps</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vhost_remove"><title>Description</title>
<para><function>vhost_remove</function> is used to remove virtual hosts and virtual paths on the Virtuoso HTTP server. Effectively this procedure deletes a row in the table <computeroutput>DB.DBA.HTTP_PATH</computeroutput>.
Virtuoso supports both flavours of virtual hosting: IP-based and name-based.</para>
</refsect1>
<refsect1 id="params_vhost_remove"><title>Parameters</title>
<refsect2><title><parameter>vhost</parameter></title>
<para>A <type>string</type> containing the virtual host name that the
browser presents as Host: entry in the request headers. i.e. Name-based
virtual hosting. Default value as defined in the Virtuoso INI file.</para>
</refsect2>
<refsect2><title><parameter>lhost</parameter></title>
<para>A <type>string</type> containing the address of the network
interface the Virtuoso HTTP server uses to listen and accept connections.
Default value as defined in the Virtuoso INI file.</para>
</refsect2>
<refsect2><title><parameter>lpath</parameter></title>
<para>A <type>string</type> containing the path component of the
URI for the logical path.</para>
</refsect2>
<refsect2><title><parameter>del_vsps</parameter></title>
<para>if a positive number will indicate to the server to drop all
compilations of VSP files in this domain. Default value is 0.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_vhost_remove"><title>Return Types</title><para>The return is VOID.</para></refsect1>
<!--
<refsect1 id="errors_vhost_remove"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLSTATE</entry><entry>ERROR CODE</entry><entry>ERROR TEXT</entry><entry>DESCRIPTION</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
-->
<refsect1 id="examples_vhost_remove"><title>Examples</title>
<example id="ex_vhost_remove"><title>Removing Virtual Host Definitions</title>
<screen>
SQL> VHOST_REMOVE (vhost=>'www.foo.com:8889',
lhost=>'host.foo.com:8889',
lpath=>'/appsimple');
</screen>
<para>
Now, attempts to retrieve http://www.foo.com:8889/ will be rejected.
</para>
</example>
</refsect1>
<refsect1 id="seealso_vhost_remove"><title>See Also</title>
<para>The <link linkend="webserver">Virtuoso Web Server</link> Chapter in the Virtuoso Manual for discussion on this topic.</para>
<para><link linkend="fn_vhost_remove">vhost_remove</link>.</para>
</refsect1>
</refentry>
|