aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/create_sequence.sgml
blob: 20d03240e32a617204105d249c7f2e971164dbe6 (plain)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
<REFENTRY ID="SQL-CREATESEQUENCE">
 <REFMETA>
  <REFENTRYTITLE>
   CREATE SEQUENCE
  </REFENTRYTITLE>
  <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
 </REFMETA>
 <REFNAMEDIV>
  <REFNAME>
   CREATE SEQUENCE
  </REFNAME>
  <REFPURPOSE>
   Creates a new sequence number generator
  </REFPURPOSE>
  
 <REFSYNOPSISDIV>
  <REFSYNOPSISDIVINFO>
   <DATE>1998-04-15</DATE>
  </REFSYNOPSISDIVINFO>
  <SYNOPSIS>
   CREATE SEQUENCE <replaceable class="parameter">seqname</replaceable>
        [INCREMENT <replaceable class="parameter">increment</replaceable>]
        [MINVALUE  <replaceable class="parameter">minvalue</replaceable>]
        [MAXVALUE  <replaceable class="parameter">maxvalue</replaceable>]
        [START     <replaceable class="parameter">start</replaceable>]
        [CACHE     <replaceable class="parameter">cache</replaceable>]
        [CYCLE]
  </SYNOPSIS>
  
  <REFSECT2 ID="R2-SQL-CREATESEQUENCE-1">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Inputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">seqname</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
          The name of a sequence to be created.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">increment</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The <option>INCREMENT <replaceable class="parameter">increment</replaceable></option> clause is optional. A positive value will make an
	    ascending sequence, a negative one a descending sequence. The default value
	    is 1.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">minvalue</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The optional clause <option>MINVALUE
	   <replaceable class="parameter">minvalue</replaceable></option>
	   determines the minimum value
	   a sequence can be. The defaults are 1 and -2147483647 for
	   ascending and descending sequences, respectively.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">maxvalue</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Use the optional clause <option>MAXVALUE
	   <replaceable class="parameter">maxvalue</replaceable></option> to
	   determine the maximum
	   value for the sequence. The defaults are 2147483647 and -1 for
	   ascending and descending sequences, respectively.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">start</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The optional <option>START
	    <replaceable class="parameter">start</replaceable>
	    clause</option> enables the sequence to begin anywhere.
	   The default starting value is
	   <replaceable class="parameter">minvalue</replaceable>
	   for ascending sequences and
	   <replaceable class="parameter">maxvalue</replaceable>
	   for descending ones.
	   <comment>
	    What happens if the user specifies start outside the range?
	   </comment>
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">cache</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The <option>CACHE <replaceable class="parameter">cache</replaceable></option> option
	   enables sequence numbers to be preallocated
	   and stored in memory for faster access. The  minimum
	   value is 1 (no cache) and this is also the default.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>CYCLE</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The optional CYCLE keyword may be used to enable the sequence
	   to continue when the
	   <replaceable class="parameter">maxvalue</replaceable> or
	   <replaceable class="parameter">minvalue</replaceable> has been
	   reached by
	   an ascending or descending sequence respectively. If the limit is
	   reached, the next number generated will be whatever the
	   <replaceable class="parameter">minvalue</replaceable> or
	   <replaceable class="parameter">maxvalue</replaceable> is,
	   as appropriate.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
     </LISTITEM>
    </VARLISTENTRY>
   </variablelist>
  </REFSECT2>
  
  <REFSECT2 ID="R2-SQL-CREATESEQUENCE-2">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Outputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>CREATE</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Message returned if the command is successful.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>ERROR:  amcreate: '<replaceable class="parameter">       seqname</replaceable>' relation already exists</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   If the sequence specified already exists.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
  </REFSECT2>
 </REFSYNOPSISDIV>
 
 <REFSECT1 ID="R1-SQL-CREATESEQUENCE-1">
  <REFSECT1INFO>
   <DATE>1998-04-15</DATE>
  </REFSECT1INFO>
  <TITLE>
   Description
  </TITLE>
  <PARA>
   CREATE SEQUENCE will enter a new sequence number generator
   into the current data base. This involves creating and initialising a
   new single block
   table with the name <replaceable class="parameter">seqname</replaceable>.
   The generator will be "owned" by the user issuing the command.
  </PARA>
  <para>
   After the sequence is created, you may use the function
   <function>nextval()</function> with the
   sequence name as the argument to get a new number from the sequence.
   The function <function>currval('<replaceable class="parameter">sequence_name</replaceable>')</function> may be used
   to determine the number returned by the last call to
   <function>nextval()</function> for the
   specified sequence in the current session.
  </para>
  
  <para>
   Use a query like
   <programlisting>
    SELECT * FROM sequence_name;
   </programlisting>
   to get the parameters of a sequence.
  </para>
  <para>
   Low-level locking is used to enable multiple simultaneous
   calls to a generator.
  </para>
  
  <REFSECT2 ID="R2-SQL-CREATESEQUENCE-3">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Notes
   </TITLE>
   <PARA>
    Refer to the DROP SEQUENCE statement to remove a sequence.
   </PARA>
   <para>
    Each backend uses its own cache to store allocated numbers.
    Numbers that are cached but not used in the current session will be
    lost.
   </para>
  </REFSECT2>
 </refsect1>
 
 <REFSECT1 ID="R1-SQL-CREATESEQUENCE-2">
  <TITLE>
   Usage
  </TITLE>
  <PARA>
   Create an ascending sequence called serial, starting at 101:
  </PARA>
  <ProgramListing>
   CREATE SEQUENCE serial START 101;
  </ProgramListing>
  <para>
   Select the next number from this sequence
   <programlisting>
    SELECT NEXTVAL ('serial');
    
    nextval
    -------
        114
   </programlisting>
  </para>
  <para>
   Use this sequence in an INSERT:
   <programlisting>
    INSERT INTO distributors VALUES (NEXTVAL ('serial'),'nothing');
   </programlisting>
  </para>
 </REFSECT1>
 
 <REFSECT1 ID="R1-SQL-CREATESEQUENCE-3">
  <TITLE>
   Compatibility
  </TITLE>
  <PARA>
   CREATE SEQUENCE statement is a PostgreSQL language extension.
  </PARA>
  
  <REFSECT2 ID="R2-SQL-CREATESEQUENCE-4">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    SQL92
   </TITLE>
   <PARA>
    There is no CREATE SEQUENCE statement on SQL92.
   </PARA>
  </refsect2>
 </refsect1>
</REFENTRY>


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->