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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?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_string_output_gz_compress">
<refmeta>
<refentrytitle>string_output_gz_compress</refentrytitle>
<refmiscinfo>compression</refmiscinfo>
<refmiscinfo>string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>string_output_gz_compress</refname>
<refpurpose>compress a string_output with gzip algorithm</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_string_output_gz_compress">
<funcprototype id="fproto_string_output_gz_compress">
<funcdef><function>string_output_gz_compress</function></funcdef>
<paramdef>in <parameter>str_out_in</parameter> string_session</paramdef>
<paramdef>out <parameter>str_out_out</parameter> string_session</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_string_output_gz_compress"><title>Description</title>
<para>The string_output_gz_compress compresses its string_output argument using the gzip
algorithm and writes the result to another string_output given as an argument.
When successful, the number of bytes written to <parameter>str_out_out</parameter>
is returned.</para>
</refsect1>
<refsect1 id="params_string_output_gz_compress">
<title>Parameters</title>
<refsect2><title>str_out_in</title>
<para>A string session as returned by <function>string_output</function> function.</para>
</refsect2>
<refsect2><title>str_out_out</title>
<para>A string session as returned by <function>string_output</function> function.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_string_output_gz_compress"><title>Return Types</title>
<para><type>INTEGER</type> number of bytes written to <parameter>str_out_out</parameter></para>
</refsect1>
<!-- <refsect1 id="errors_string_output_gz_compress">
<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_string_output_gz_compress">
<title>Examples</title>
<example id="ex_string_output_gz_compress_1"><title>GZIP test</title>
<para>Test if the gzip implementation works.</para>
<screen><![CDATA[
create procedure
gz_test_1 (in fname varchar)
{
declare dta, dta_2, res any;
declare len integer;
res := string_output ();
dta_2 := string_output ();
dta := file_to_string_output (fname);
result_names (len);
-- send length of input to client
result (length (dta));
-- compress and return compressed size.
result (string_output_gz_compress (dta, res));
gz_uncompress (string_output_string (res), dta_2);
if (md5 (dta) <> md5 (dta_2))
signal ('SNAFU', 'GZIP algorithm implementation is faulty.');
result (length (dta));
end_result();
}
;
SQL> gz_test_1 ('tmp/test.dat');
len
INTEGER
_______________________________________________________________________________
11689
2477
11689
3 Rows. -- 11 msec.
]]></screen>
</example>
</refsect1>
<refsect1 id="seealso_string_output_gz_compress">
<title>See Also</title>
<para><link linkend="fn_string_output">string_output</link></para>
</refsect1>
</refentry>
|
