← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/postgresql-9.1/oneiric-security

« back to all changes in this revision

Viewing changes to doc/src/sgml/html/sql-alterindex.html

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/html/sql-alterindex.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 
2
<HTML
 
3
><HEAD
 
4
><TITLE
 
5
>ALTER INDEX</TITLE
 
6
><META
 
7
NAME="GENERATOR"
 
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 
9
REV="MADE"
 
10
HREF="mailto:pgsql-docs@postgresql.org"><LINK
 
11
REL="HOME"
 
12
TITLE="PostgreSQL 9.1beta1 Documentation"
 
13
HREF="index.html"><LINK
 
14
REL="UP"
 
15
TITLE="SQL Commands"
 
16
HREF="sql-commands.html"><LINK
 
17
REL="PREVIOUS"
 
18
TITLE="ALTER GROUP"
 
19
HREF="sql-altergroup.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="ALTER LANGUAGE"
 
22
HREF="sql-alterlanguage.html"><LINK
 
23
REL="STYLESHEET"
 
24
TYPE="text/css"
 
25
HREF="stylesheet.css"><META
 
26
HTTP-EQUIV="Content-Type"
 
27
CONTENT="text/html; charset=ISO-8859-1"><META
 
28
NAME="creation"
 
29
CONTENT="2011-04-27T21:20:33"></HEAD
 
30
><BODY
 
31
CLASS="REFENTRY"
 
32
><DIV
 
33
CLASS="NAVHEADER"
 
34
><TABLE
 
35
SUMMARY="Header navigation table"
 
36
WIDTH="100%"
 
37
BORDER="0"
 
38
CELLPADDING="0"
 
39
CELLSPACING="0"
 
40
><TR
 
41
><TH
 
42
COLSPAN="5"
 
43
ALIGN="center"
 
44
VALIGN="bottom"
 
45
><A
 
46
HREF="index.html"
 
47
>PostgreSQL 9.1beta1 Documentation</A
 
48
></TH
 
49
></TR
 
50
><TR
 
51
><TD
 
52
WIDTH="10%"
 
53
ALIGN="left"
 
54
VALIGN="top"
 
55
><A
 
56
TITLE="ALTER GROUP"
 
57
HREF="sql-altergroup.html"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="10%"
 
63
ALIGN="left"
 
64
VALIGN="top"
 
65
><A
 
66
TITLE="ALTER GROUP"
 
67
HREF="sql-altergroup.html"
 
68
>Fast Backward</A
 
69
></TD
 
70
><TD
 
71
WIDTH="60%"
 
72
ALIGN="center"
 
73
VALIGN="bottom"
 
74
></TD
 
75
><TD
 
76
WIDTH="10%"
 
77
ALIGN="right"
 
78
VALIGN="top"
 
79
><A
 
80
TITLE="ALTER LANGUAGE"
 
81
HREF="sql-alterlanguage.html"
 
82
>Fast Forward</A
 
83
></TD
 
84
><TD
 
85
WIDTH="10%"
 
86
ALIGN="right"
 
87
VALIGN="top"
 
88
><A
 
89
TITLE="ALTER LANGUAGE"
 
90
HREF="sql-alterlanguage.html"
 
91
ACCESSKEY="N"
 
92
>Next</A
 
93
></TD
 
94
></TR
 
95
></TABLE
 
96
><HR
 
97
ALIGN="LEFT"
 
98
WIDTH="100%"></DIV
 
99
><H1
 
100
><A
 
101
NAME="SQL-ALTERINDEX"
 
102
></A
 
103
>ALTER INDEX</H1
 
104
><DIV
 
105
CLASS="REFNAMEDIV"
 
106
><A
 
107
NAME="AEN60614"
 
108
></A
 
109
><H2
 
110
>Name</H2
 
111
>ALTER INDEX&nbsp;--&nbsp;change the definition of an index</DIV
 
112
><DIV
 
113
CLASS="REFSYNOPSISDIV"
 
114
><A
 
115
NAME="AEN60619"
 
116
></A
 
117
><H2
 
118
>Synopsis</H2
 
119
><PRE
 
120
CLASS="SYNOPSIS"
 
121
>ALTER INDEX <TT
 
122
CLASS="REPLACEABLE"
 
123
><I
 
124
>name</I
 
125
></TT
 
126
> RENAME TO <TT
 
127
CLASS="REPLACEABLE"
 
128
><I
 
129
>new_name</I
 
130
></TT
 
131
>
 
132
ALTER INDEX <TT
 
133
CLASS="REPLACEABLE"
 
134
><I
 
135
>name</I
 
136
></TT
 
137
> SET TABLESPACE <TT
 
138
CLASS="REPLACEABLE"
 
139
><I
 
140
>tablespace_name</I
 
141
></TT
 
142
>
 
143
ALTER INDEX <TT
 
144
CLASS="REPLACEABLE"
 
145
><I
 
146
>name</I
 
147
></TT
 
148
> SET ( <TT
 
149
CLASS="REPLACEABLE"
 
150
><I
 
151
>storage_parameter</I
 
152
></TT
 
153
> = <TT
 
154
CLASS="REPLACEABLE"
 
155
><I
 
156
>value</I
 
157
></TT
 
158
> [, ... ] )
 
159
ALTER INDEX <TT
 
160
CLASS="REPLACEABLE"
 
161
><I
 
162
>name</I
 
163
></TT
 
164
> RESET ( <TT
 
165
CLASS="REPLACEABLE"
 
166
><I
 
167
>storage_parameter</I
 
168
></TT
 
169
> [, ... ] )</PRE
 
170
></DIV
 
171
><DIV
 
172
CLASS="REFSECT1"
 
173
><A
 
174
NAME="AEN60630"
 
175
></A
 
176
><H2
 
177
>Description</H2
 
178
><P
 
179
>   <TT
 
180
CLASS="COMMAND"
 
181
>ALTER INDEX</TT
 
182
> changes the definition of an existing index.
 
183
   There are several subforms:
 
184
 
 
185
  <P
 
186
></P
 
187
></P><DIV
 
188
CLASS="VARIABLELIST"
 
189
><DL
 
190
><DT
 
191
><TT
 
192
CLASS="LITERAL"
 
193
>RENAME</TT
 
194
></DT
 
195
><DD
 
196
><P
 
197
>      The <TT
 
198
CLASS="LITERAL"
 
199
>RENAME</TT
 
200
> form changes the name of the index.
 
201
      There is no effect on the stored data.
 
202
     </P
 
203
></DD
 
204
><DT
 
205
><TT
 
206
CLASS="LITERAL"
 
207
>SET TABLESPACE</TT
 
208
></DT
 
209
><DD
 
210
><P
 
211
>      This form changes the index's tablespace to the specified tablespace and
 
212
      moves the data file(s) associated with the index to the new tablespace.
 
213
      See also
 
214
      <A
 
215
HREF="sql-createtablespace.html"
 
216
>CREATE TABLESPACE</A
 
217
>.
 
218
     </P
 
219
></DD
 
220
><DT
 
221
><TT
 
222
CLASS="LITERAL"
 
223
>SET ( <TT
 
224
CLASS="REPLACEABLE"
 
225
><I
 
226
>storage_parameter</I
 
227
></TT
 
228
> = <TT
 
229
CLASS="REPLACEABLE"
 
230
><I
 
231
>value</I
 
232
></TT
 
233
> [, ... ] )</TT
 
234
></DT
 
235
><DD
 
236
><P
 
237
>      This form changes one or more index-method-specific storage parameters
 
238
      for the index.  See
 
239
      <A
 
240
HREF="sql-createindex.html"
 
241
>CREATE INDEX</A
 
242
>
 
243
      for details on the available parameters.  Note that the index contents
 
244
      will not be modified immediately by this command; depending on the
 
245
      parameter you might need to rebuild the index with
 
246
      <A
 
247
HREF="sql-reindex.html"
 
248
>REINDEX</A
 
249
>
 
250
      to get the desired effects.
 
251
     </P
 
252
></DD
 
253
><DT
 
254
><TT
 
255
CLASS="LITERAL"
 
256
>RESET ( <TT
 
257
CLASS="REPLACEABLE"
 
258
><I
 
259
>storage_parameter</I
 
260
></TT
 
261
> [, ... ] )</TT
 
262
></DT
 
263
><DD
 
264
><P
 
265
>      This form resets one or more index-method-specific storage parameters to
 
266
      their defaults.  As with <TT
 
267
CLASS="LITERAL"
 
268
>SET</TT
 
269
>, a <TT
 
270
CLASS="LITERAL"
 
271
>REINDEX</TT
 
272
>
 
273
      might be needed to update the index entirely.
 
274
     </P
 
275
></DD
 
276
></DL
 
277
></DIV
 
278
><P>
 
279
  </P
 
280
></DIV
 
281
><DIV
 
282
CLASS="REFSECT1"
 
283
><A
 
284
NAME="AEN60664"
 
285
></A
 
286
><H2
 
287
>Parameters</H2
 
288
><P
 
289
></P
 
290
><DIV
 
291
CLASS="VARIABLELIST"
 
292
><DL
 
293
><DT
 
294
><TT
 
295
CLASS="REPLACEABLE"
 
296
><I
 
297
>name</I
 
298
></TT
 
299
></DT
 
300
><DD
 
301
><P
 
302
>        The name (possibly schema-qualified) of an existing index to
 
303
        alter.
 
304
       </P
 
305
></DD
 
306
><DT
 
307
><TT
 
308
CLASS="REPLACEABLE"
 
309
><I
 
310
>new_name</I
 
311
></TT
 
312
></DT
 
313
><DD
 
314
><P
 
315
>        The new name for the index.
 
316
       </P
 
317
></DD
 
318
><DT
 
319
><TT
 
320
CLASS="REPLACEABLE"
 
321
><I
 
322
>tablespace_name</I
 
323
></TT
 
324
></DT
 
325
><DD
 
326
><P
 
327
>        The tablespace to which the index will be moved.
 
328
       </P
 
329
></DD
 
330
><DT
 
331
><TT
 
332
CLASS="REPLACEABLE"
 
333
><I
 
334
>storage_parameter</I
 
335
></TT
 
336
></DT
 
337
><DD
 
338
><P
 
339
>        The name of an index-method-specific storage parameter.
 
340
       </P
 
341
></DD
 
342
><DT
 
343
><TT
 
344
CLASS="REPLACEABLE"
 
345
><I
 
346
>value</I
 
347
></TT
 
348
></DT
 
349
><DD
 
350
><P
 
351
>        The new value for an index-method-specific storage parameter.
 
352
        This might be a number or a word depending on the parameter.
 
353
       </P
 
354
></DD
 
355
></DL
 
356
></DIV
 
357
></DIV
 
358
><DIV
 
359
CLASS="REFSECT1"
 
360
><A
 
361
NAME="AEN60692"
 
362
></A
 
363
><H2
 
364
>Notes</H2
 
365
><P
 
366
>    These operations are also possible using
 
367
    <A
 
368
HREF="sql-altertable.html"
 
369
>ALTER TABLE</A
 
370
>.
 
371
    <TT
 
372
CLASS="COMMAND"
 
373
>ALTER INDEX</TT
 
374
> is in fact just an alias for the forms
 
375
    of <TT
 
376
CLASS="COMMAND"
 
377
>ALTER TABLE</TT
 
378
> that apply to indexes.
 
379
   </P
 
380
><P
 
381
>    There was formerly an <TT
 
382
CLASS="COMMAND"
 
383
>ALTER INDEX OWNER</TT
 
384
> variant, but
 
385
    this is now ignored (with a warning).  An index cannot have an owner
 
386
    different from its table's owner.  Changing the table's owner
 
387
    automatically changes the index as well.
 
388
   </P
 
389
><P
 
390
>    Changing any part of a system catalog index is not permitted.
 
391
   </P
 
392
></DIV
 
393
><DIV
 
394
CLASS="REFSECT1"
 
395
><A
 
396
NAME="AEN60701"
 
397
></A
 
398
><H2
 
399
>Examples</H2
 
400
><P
 
401
>   To rename an existing index:
 
402
</P><PRE
 
403
CLASS="PROGRAMLISTING"
 
404
>ALTER INDEX distributors RENAME TO suppliers;</PRE
 
405
><P>
 
406
  </P
 
407
><P
 
408
>   To move an index to a different tablespace:
 
409
</P><PRE
 
410
CLASS="PROGRAMLISTING"
 
411
>ALTER INDEX distributors SET TABLESPACE fasttablespace;</PRE
 
412
><P>
 
413
  </P
 
414
><P
 
415
>   To change an index's fill factor (assuming that the index method
 
416
   supports it):
 
417
</P><PRE
 
418
CLASS="PROGRAMLISTING"
 
419
>ALTER INDEX distributors SET (fillfactor = 75);
 
420
REINDEX INDEX distributors;</PRE
 
421
><P>
 
422
  </P
 
423
></DIV
 
424
><DIV
 
425
CLASS="REFSECT1"
 
426
><A
 
427
NAME="AEN60709"
 
428
></A
 
429
><H2
 
430
>Compatibility</H2
 
431
><P
 
432
>   <TT
 
433
CLASS="COMMAND"
 
434
>ALTER INDEX</TT
 
435
> is a <SPAN
 
436
CLASS="PRODUCTNAME"
 
437
>PostgreSQL</SPAN
 
438
>
 
439
   extension.
 
440
  </P
 
441
></DIV
 
442
><DIV
 
443
CLASS="REFSECT1"
 
444
><A
 
445
NAME="AEN60714"
 
446
></A
 
447
><H2
 
448
>See Also</H2
 
449
><A
 
450
HREF="sql-createindex.html"
 
451
>CREATE INDEX</A
 
452
>, <A
 
453
HREF="sql-reindex.html"
 
454
>REINDEX</A
 
455
></DIV
 
456
><DIV
 
457
CLASS="NAVFOOTER"
 
458
><HR
 
459
ALIGN="LEFT"
 
460
WIDTH="100%"><TABLE
 
461
SUMMARY="Footer navigation table"
 
462
WIDTH="100%"
 
463
BORDER="0"
 
464
CELLPADDING="0"
 
465
CELLSPACING="0"
 
466
><TR
 
467
><TD
 
468
WIDTH="33%"
 
469
ALIGN="left"
 
470
VALIGN="top"
 
471
><A
 
472
HREF="sql-altergroup.html"
 
473
ACCESSKEY="P"
 
474
>Prev</A
 
475
></TD
 
476
><TD
 
477
WIDTH="34%"
 
478
ALIGN="center"
 
479
VALIGN="top"
 
480
><A
 
481
HREF="index.html"
 
482
ACCESSKEY="H"
 
483
>Home</A
 
484
></TD
 
485
><TD
 
486
WIDTH="33%"
 
487
ALIGN="right"
 
488
VALIGN="top"
 
489
><A
 
490
HREF="sql-alterlanguage.html"
 
491
ACCESSKEY="N"
 
492
>Next</A
 
493
></TD
 
494
></TR
 
495
><TR
 
496
><TD
 
497
WIDTH="33%"
 
498
ALIGN="left"
 
499
VALIGN="top"
 
500
>ALTER GROUP</TD
 
501
><TD
 
502
WIDTH="34%"
 
503
ALIGN="center"
 
504
VALIGN="top"
 
505
><A
 
506
HREF="sql-commands.html"
 
507
ACCESSKEY="U"
 
508
>Up</A
 
509
></TD
 
510
><TD
 
511
WIDTH="33%"
 
512
ALIGN="right"
 
513
VALIGN="top"
 
514
>ALTER LANGUAGE</TD
 
515
></TR
 
516
></TABLE
 
517
></DIV
 
518
></BODY
 
519
></HTML
 
520
>
 
 
b'\\ No newline at end of file'