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
|
<?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_sequence_set">
<refmeta>
<refentrytitle>sequence_set</refentrytitle>
<refmiscinfo>sql</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sequence_set</refname>
<refpurpose>Sets and returns the state of a sequence object.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_sequence_set">
<funcprototype id="fproto_sequence_set">
<funcdef>integer <function>sequence_set</function></funcdef>
<paramdef>in <parameter>name</parameter> varchar</paramdef>
<paramdef>in <parameter>state</parameter> integer</paramdef>
<paramdef>in <parameter>mode</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_sequence_set">
<title>Description</title>
<para>
The function sets and returns the state of a sequence object.
The <parameter>mode</parameter> specifies whether a check for order of values should be made.
If <parameter>mode</parameter> equals 0, the state is set regardless of the previous state.
If <parameter>mode</parameter> is non-zero,
the state is changed only if the new state is greater than the previous state.
This gives some (weak) protection from occasional 'rewind' the sequence back to values that are already in use.
</para>
</refsect1>
<refsect1 id="params_sequence_set">
<title>Parameters</title>
<refsect2><title>name</title><para>The server-wide name of a sequence.</para></refsect2>
<refsect2><title>state</title><para>A new state of the sequence.</para></refsect2>
<refsect2><title>mode</title><para>Flags if a new state of the sequence should be ignored if it is less than the current one.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_sequence_set"><title>Return Types</title>
<para>
The function returns an integer that is equal to what the next
call to <function>sequence_next</function>() will return.
</para>
</refsect1>
<refsect1 id="examples_sequence_set">
<title>Examples</title>
<example id="ex_sequence_set"><title>Different modes of sequence_set()</title>
<para>The sequence of calls demonstrates various calls of <function>sequence_set</function>().</para>
<screen><![CDATA[
select sequence_set ('sample', 5, 0);
5
1 Rows. -- 0 msec.
select sequence_next ('sample');
5
1 Rows. -- 0 msec.
select sequence_next ('sample');
6
1 Rows. -- 0 msec.
-- This has no effect because current state(6) is greater than 2.
select sequence_set ('sample', 2, 1);
7
1 Rows. -- 0 msec.
select sequence_next ('sample');
7
1 Rows. -- 0 msec.
-- But this change has effect:
select sequence_set ('sample', 2, 0);
2
1 Rows. -- 0 msec.
select sequence_next ('sample');
2
1 Rows. -- 0 msec.
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_sequence_set">
<title>See Also</title>
<para><link linkend="sequenceobjects">Sequence Objects</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_remove"><function>sequence_remove</function></link></para>
<para><link linkend="fn_registry_get"><function>registry_get</function></link></para>
<para><link linkend="fn_registry_get_all"><function>registry_get_all</function></link></para>
<para><link linkend="fn_registry_set"><function>registry_set</function></link></para>
<para><link linkend="fn_registry_name_is_protected"><function>registry_name_is_protected</function></link></para>
<para><link linkend="fn_registry_remove"><function>registry_remove</function></link></para>
</refsect1>
</refentry>
|
