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
|
<?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_pack">
<refmeta>
<refentrytitle>VAD_PACK</refentrytitle>
<refmiscinfo>vad</refmiscinfo>
</refmeta>
<refnamediv>
<refname>VAD_PACK</refname>
<refpurpose>get VAD resource</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_vad_pack">
<funcprototype id="fproto_vad_pack">
<funcdef>varchar DB.DBA.<function>VAD_PACK</function></funcdef>
<paramdef>in <parameter>sticker_uri </parameter>varchar</paramdef>
<paramdef>in <parameter>base_uri_of_resources </parameter>varchar</paramdef>
<paramdef>in <parameter>package_uri </parameter>varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>This function gets the resource identified by the sticker_uri, which contains
the vad:package root element. The URIs present there are interpreted in the context
of the base_uri_of_resources and the individual resources are fetched. These are
parsed to make sure that they are syntactically correct and the resources are
appended to the generated package resource, which is stored into the result_uri.
vad_pack() returns a human-readable log of error and warning messages, vad_pack()
will signal errors if some resources or database objects will be unavailable.
By convention, VAD package files have the extension '.vad'. </para></refsect1>
<refsect1 id="params"><title>Parameters</title>
<refsect2><title>sticker_url</title>
<para>stickers file URI</para></refsect2>
<refsect2><title>base_uri_of_resources</title>
<para>inlined resources root</para></refsect2>
<refsect2><title>package_uri</title>
<para>path of output VAD file</para></refsect2>
</refsect1>
<refsect1 id="ret"><title>Return Types</title>
<para>vad_pack() returns a human-readable log of error and warning messages, vad_pack()
will signal errors if some resources or database objects will be unavailable.</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_install"><function>vad_install()</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>
|
