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
104
105
106
107
|
<?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_vad_install">
<refmeta>
<refentrytitle>VAD_INSTALL</refentrytitle>
<refmiscinfo>vad</refmiscinfo>
</refmeta>
<refnamediv>
<refname>VAD_INSTALL</refname>
<refpurpose>Invoke VAD installation process</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_vad_install">
<funcprototype id="fproto_vad_install">
<funcdef>varchar DB.DBA.<function>VAD_INSTALL</function></funcdef>
<paramdef>in <parameter>package_uri </parameter>varchar</paramdef>
<paramdef>in <parameter>source_type </parameter>integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>Invoke the install operation from interactive SQL or from the web user
interface. This will:</para>
<itemizedlist mark="bullet" spacing="compact">
<listitem>enter into atomic mode</listitem>
<listitem>Check for version and prerequisite package compatibility</listitem>
<listitem>Run the pre-install SQL script</listitem>
<listitem>Load all SQL code and other resources in the order given by the developer</listitem>
<listitem>Run any post install SQL code</listitem>
<listitem>If DB.DBA.VAD_INSTALL() succeeded the server comes back on-line.</listitem>
</itemizedlist>
<para>If there was a failure in mid-install, such as running out of disk or
some other serious unrecoverable database error, the server exits. The
installation can be undone manually by halting the server, deleting the
transaction log file and restarting. The server will start from the checkpoint
as if the installation was never attempted.</para></refsect1>
<refsect1 id="params"><title>Parameters</title>
<refsect2><title>package_uri</title>
<para>URI of VAD file</para></refsect2>
<refsect2><title>source_type</title>
<para>The second parameter to VAD_INSTALL controls whether the given path to the
package is taken as a filesystem path or a DAV path.
Value of 1 means the path is interpreted as a DAV path. The default value is 0
which means the VAD package is read from filesystem path.
</para></refsect2>
</refsect1>
<!--
<refsect1 id="ret"><title>Return Types</title>
<para></para></refsect1>
-->
<!--
<refsect1 id="errors"><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"><title>Examples</title>
<example id="ex_"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
-->
<refsect1 id="seealso"><title>See Also</title>
<para><link linkend="fn_vad_check_uninstallability"><function>vad_check_uninstallability()</function></link></para>
<para><link linkend="fn_vad_check_installability"><function>vad_check_installability()</function></link></para>
<para><link linkend="fn_vad_fail_check"><function>vad_fail_check()</function></link></para>
<para><link linkend="fn_vad_pack"><function>vad_pack()</function></link></para>
<para><link linkend="fn_vad_safe_exec"><function>vad_safe_exec()</function></link></para>
<para><link linkend="fn_vad_uninstall"><function>vad_uninstall()</function></link></para>
<para><link linkend="fn_vad_load_file"><function>vad_load_file()</function></link></para>
<para><link linkend="fn_vad_check"><function>vad_check()</function></link></para>
</refsect1>
</refentry>
|
