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
|
<?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_registry_remove">
<refmeta>
<refentrytitle>registry_remove</refentrytitle>
<refmiscinfo>sql</refmiscinfo>
</refmeta>
<refnamediv>
<refname>registry_remove</refname>
<refpurpose>Remove a variable from registry</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_registry_remove">
<funcprototype id="fproto_registry_remove">
<funcdef><function>registry_remove</function></funcdef>
<paramdef>in <parameter>name</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_registry_remove">
<title>Description</title>
<para>The function removes a given variable from registry, so future calls of registry_get returns zero.</para>
<para>Some registry variables are used solely by internal server routines so they should not be changed by any application.
Nobody can remove such a "protected" variable even if some of them can be updated by DBA.</para>
</refsect1>
<refsect1 id="params_registry_remove">
<title>Parameters</title>
<refsect2><title>name</title><para>Name of variable to be removed.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_registry_remove"><title>Return Types</title>
<para>The function returns the last saved value of a variable or zero if the specified variable does not exist.</para>
</refsect1>
<refsect1 id="errors_registry_remove">
<title>Errors</title>
<table><title>Errors signalled by registry_set</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>22023</errorcode></entry>
<entry><errorcode>SR014</errorcode></entry>
<entry><errorname>Function registry_remove needs a string as argument 1, not an arg of [datatype]</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR485</errorcode></entry>
<entry><errorname>Function registry_remove can not remove protected registry variable [name].</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_registry_remove">
<title>Examples</title>
<example id="ex_registry_remove"><title>Creation and Removal of a Registry Variable</title>
<para>This sequence of operations demonstrates that <function>registry_remove</function> reverts the effect of <function>registry_set</function>.</para>
<screen><![CDATA[
> select registry_get ('my_variable');
0
> select registry_set ('my_variable', 'my_value');
1
> select registry_get ('my_variable');
my_value
> select registry_remove ('my_variable');
my_value
> select registry_get ('my_variable');
0
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_registry_remove">
<title>See Also</title>
<para><link linkend="fn_registry_set"><function>registry_set</function></link></para>
<para><link linkend="fn_registry_get"><function>registry_get</function></link></para>
<para><link linkend="fn_registry_name_is_protected"><function>registry_name_is_protected</function></link></para>
<para><link linkend="fn_registry_get_all"><function>registry_get_all</function></link></para>
<para><link linkend="fn_sequence_get_all"><function>sequence_get_all</function></link></para>
<para><link linkend="fn_sequence_next"><function>sequence_next</function></link></para>
<para><link linkend="fn_sequence_set"><function>sequence_set</function></link></para>
<para><link linkend="fn_sequence_remove"><function>sequence_remove</function></link></para>
</refsect1>
</refentry>
|
