← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/src/sgml/html/catalog-pg-index.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/catalog-pg-index.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
>pg_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="System Catalogs"
 
16
HREF="catalogs.html"><LINK
 
17
REL="PREVIOUS"
 
18
TITLE="pg_foreign_table"
 
19
HREF="catalog-pg-foreign-table.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="pg_inherits"
 
22
HREF="catalog-pg-inherits.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="SECT1"
 
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="pg_foreign_table"
 
57
HREF="catalog-pg-foreign-table.html"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="10%"
 
63
ALIGN="left"
 
64
VALIGN="top"
 
65
><A
 
66
TITLE="System Catalogs"
 
67
HREF="catalogs.html"
 
68
>Fast Backward</A
 
69
></TD
 
70
><TD
 
71
WIDTH="60%"
 
72
ALIGN="center"
 
73
VALIGN="bottom"
 
74
>Chapter 45. System Catalogs</TD
 
75
><TD
 
76
WIDTH="10%"
 
77
ALIGN="right"
 
78
VALIGN="top"
 
79
><A
 
80
TITLE="System Catalogs"
 
81
HREF="catalogs.html"
 
82
>Fast Forward</A
 
83
></TD
 
84
><TD
 
85
WIDTH="10%"
 
86
ALIGN="right"
 
87
VALIGN="top"
 
88
><A
 
89
TITLE="pg_inherits"
 
90
HREF="catalog-pg-inherits.html"
 
91
ACCESSKEY="N"
 
92
>Next</A
 
93
></TD
 
94
></TR
 
95
></TABLE
 
96
><HR
 
97
ALIGN="LEFT"
 
98
WIDTH="100%"></DIV
 
99
><DIV
 
100
CLASS="SECT1"
 
101
><H1
 
102
CLASS="SECT1"
 
103
><A
 
104
NAME="CATALOG-PG-INDEX"
 
105
>45.25. <TT
 
106
CLASS="STRUCTNAME"
 
107
>pg_index</TT
 
108
></A
 
109
></H1
 
110
><P
 
111
>   The catalog <TT
 
112
CLASS="STRUCTNAME"
 
113
>pg_index</TT
 
114
> contains part of the information
 
115
   about indexes.  The rest is mostly in
 
116
   <TT
 
117
CLASS="STRUCTNAME"
 
118
>pg_class</TT
 
119
>.
 
120
  </P
 
121
><DIV
 
122
CLASS="TABLE"
 
123
><A
 
124
NAME="AEN86741"
 
125
></A
 
126
><P
 
127
><B
 
128
>Table 45-25. <TT
 
129
CLASS="STRUCTNAME"
 
130
>pg_index</TT
 
131
> Columns</B
 
132
></P
 
133
><TABLE
 
134
BORDER="1"
 
135
CLASS="CALSTABLE"
 
136
><COL><COL><COL><COL><THEAD
 
137
><TR
 
138
><TH
 
139
>Name</TH
 
140
><TH
 
141
>Type</TH
 
142
><TH
 
143
>References</TH
 
144
><TH
 
145
>Description</TH
 
146
></TR
 
147
></THEAD
 
148
><TBODY
 
149
><TR
 
150
><TD
 
151
><TT
 
152
CLASS="STRUCTFIELD"
 
153
>indexrelid</TT
 
154
></TD
 
155
><TD
 
156
><TT
 
157
CLASS="TYPE"
 
158
>oid</TT
 
159
></TD
 
160
><TD
 
161
><TT
 
162
CLASS="LITERAL"
 
163
><A
 
164
HREF="catalog-pg-class.html"
 
165
><TT
 
166
CLASS="STRUCTNAME"
 
167
>pg_class</TT
 
168
></A
 
169
>.oid</TT
 
170
></TD
 
171
><TD
 
172
>The OID of the <TT
 
173
CLASS="STRUCTNAME"
 
174
>pg_class</TT
 
175
> entry for this index</TD
 
176
></TR
 
177
><TR
 
178
><TD
 
179
><TT
 
180
CLASS="STRUCTFIELD"
 
181
>indrelid</TT
 
182
></TD
 
183
><TD
 
184
><TT
 
185
CLASS="TYPE"
 
186
>oid</TT
 
187
></TD
 
188
><TD
 
189
><TT
 
190
CLASS="LITERAL"
 
191
><A
 
192
HREF="catalog-pg-class.html"
 
193
><TT
 
194
CLASS="STRUCTNAME"
 
195
>pg_class</TT
 
196
></A
 
197
>.oid</TT
 
198
></TD
 
199
><TD
 
200
>The OID of the <TT
 
201
CLASS="STRUCTNAME"
 
202
>pg_class</TT
 
203
> entry for the table this index is for</TD
 
204
></TR
 
205
><TR
 
206
><TD
 
207
><TT
 
208
CLASS="STRUCTFIELD"
 
209
>indnatts</TT
 
210
></TD
 
211
><TD
 
212
><TT
 
213
CLASS="TYPE"
 
214
>int2</TT
 
215
></TD
 
216
><TD
 
217
>&nbsp;</TD
 
218
><TD
 
219
>The number of columns in the index (duplicates
 
220
      <TT
 
221
CLASS="LITERAL"
 
222
>pg_class.relnatts</TT
 
223
>)</TD
 
224
></TR
 
225
><TR
 
226
><TD
 
227
><TT
 
228
CLASS="STRUCTFIELD"
 
229
>indisunique</TT
 
230
></TD
 
231
><TD
 
232
><TT
 
233
CLASS="TYPE"
 
234
>bool</TT
 
235
></TD
 
236
><TD
 
237
>&nbsp;</TD
 
238
><TD
 
239
>If true, this is a unique index</TD
 
240
></TR
 
241
><TR
 
242
><TD
 
243
><TT
 
244
CLASS="STRUCTFIELD"
 
245
>indisprimary</TT
 
246
></TD
 
247
><TD
 
248
><TT
 
249
CLASS="TYPE"
 
250
>bool</TT
 
251
></TD
 
252
><TD
 
253
>&nbsp;</TD
 
254
><TD
 
255
>If true, this index represents the primary key of the table
 
256
      (<TT
 
257
CLASS="STRUCTFIELD"
 
258
>indisunique</TT
 
259
> should always be true when this is true)</TD
 
260
></TR
 
261
><TR
 
262
><TD
 
263
><TT
 
264
CLASS="STRUCTFIELD"
 
265
>indisexclusion</TT
 
266
></TD
 
267
><TD
 
268
><TT
 
269
CLASS="TYPE"
 
270
>bool</TT
 
271
></TD
 
272
><TD
 
273
>&nbsp;</TD
 
274
><TD
 
275
>If true, this index supports an exclusion constraint</TD
 
276
></TR
 
277
><TR
 
278
><TD
 
279
><TT
 
280
CLASS="STRUCTFIELD"
 
281
>indimmediate</TT
 
282
></TD
 
283
><TD
 
284
><TT
 
285
CLASS="TYPE"
 
286
>bool</TT
 
287
></TD
 
288
><TD
 
289
>&nbsp;</TD
 
290
><TD
 
291
>If true, the uniqueness check is enforced immediately on
 
292
       insertion
 
293
       (irrelevant if <TT
 
294
CLASS="STRUCTFIELD"
 
295
>indisunique</TT
 
296
> is not true)</TD
 
297
></TR
 
298
><TR
 
299
><TD
 
300
><TT
 
301
CLASS="STRUCTFIELD"
 
302
>indisclustered</TT
 
303
></TD
 
304
><TD
 
305
><TT
 
306
CLASS="TYPE"
 
307
>bool</TT
 
308
></TD
 
309
><TD
 
310
>&nbsp;</TD
 
311
><TD
 
312
>If true, the table was last clustered on this index</TD
 
313
></TR
 
314
><TR
 
315
><TD
 
316
><TT
 
317
CLASS="STRUCTFIELD"
 
318
>indisvalid</TT
 
319
></TD
 
320
><TD
 
321
><TT
 
322
CLASS="TYPE"
 
323
>bool</TT
 
324
></TD
 
325
><TD
 
326
>&nbsp;</TD
 
327
><TD
 
328
>       If true, the index is currently valid for queries.  False means the
 
329
       index is possibly incomplete: it must still be modified by
 
330
       <TT
 
331
CLASS="COMMAND"
 
332
>INSERT</TT
 
333
>/<TT
 
334
CLASS="COMMAND"
 
335
>UPDATE</TT
 
336
> operations, but it cannot safely
 
337
       be used for queries. If it is unique, the uniqueness property is not
 
338
       true either.
 
339
      </TD
 
340
></TR
 
341
><TR
 
342
><TD
 
343
><TT
 
344
CLASS="STRUCTFIELD"
 
345
>indcheckxmin</TT
 
346
></TD
 
347
><TD
 
348
><TT
 
349
CLASS="TYPE"
 
350
>bool</TT
 
351
></TD
 
352
><TD
 
353
>&nbsp;</TD
 
354
><TD
 
355
>       If true, queries must not use the index until the <TT
 
356
CLASS="STRUCTFIELD"
 
357
>xmin</TT
 
358
>
 
359
       of this <TT
 
360
CLASS="STRUCTNAME"
 
361
>pg_index</TT
 
362
> row is below their <TT
 
363
CLASS="SYMBOL"
 
364
>TransactionXmin</TT
 
365
>
 
366
       event horizon, because the table may contain broken HOT chains with
 
367
       incompatible rows that they can see
 
368
      </TD
 
369
></TR
 
370
><TR
 
371
><TD
 
372
><TT
 
373
CLASS="STRUCTFIELD"
 
374
>indisready</TT
 
375
></TD
 
376
><TD
 
377
><TT
 
378
CLASS="TYPE"
 
379
>bool</TT
 
380
></TD
 
381
><TD
 
382
>&nbsp;</TD
 
383
><TD
 
384
>       If true, the index is currently ready for inserts.  False means the
 
385
       index must be ignored by <TT
 
386
CLASS="COMMAND"
 
387
>INSERT</TT
 
388
>/<TT
 
389
CLASS="COMMAND"
 
390
>UPDATE</TT
 
391
>
 
392
       operations.
 
393
      </TD
 
394
></TR
 
395
><TR
 
396
><TD
 
397
><TT
 
398
CLASS="STRUCTFIELD"
 
399
>indkey</TT
 
400
></TD
 
401
><TD
 
402
><TT
 
403
CLASS="TYPE"
 
404
>int2vector</TT
 
405
></TD
 
406
><TD
 
407
><TT
 
408
CLASS="LITERAL"
 
409
><A
 
410
HREF="catalog-pg-attribute.html"
 
411
><TT
 
412
CLASS="STRUCTNAME"
 
413
>pg_attribute</TT
 
414
></A
 
415
>.attnum</TT
 
416
></TD
 
417
><TD
 
418
>       This is an array of <TT
 
419
CLASS="STRUCTFIELD"
 
420
>indnatts</TT
 
421
> values that
 
422
       indicate which table columns this index indexes.  For example a value
 
423
       of <TT
 
424
CLASS="LITERAL"
 
425
>1 3</TT
 
426
> would mean that the first and the third table
 
427
       columns make up the index key.  A zero in this array indicates that the
 
428
       corresponding index attribute is an expression over the table columns,
 
429
       rather than a simple column reference.
 
430
      </TD
 
431
></TR
 
432
><TR
 
433
><TD
 
434
><TT
 
435
CLASS="STRUCTFIELD"
 
436
>indcollation</TT
 
437
></TD
 
438
><TD
 
439
><TT
 
440
CLASS="TYPE"
 
441
>oidvector</TT
 
442
></TD
 
443
><TD
 
444
><TT
 
445
CLASS="LITERAL"
 
446
><A
 
447
HREF="catalog-pg-collation.html"
 
448
><TT
 
449
CLASS="STRUCTNAME"
 
450
>pg_collation</TT
 
451
></A
 
452
>.oid</TT
 
453
></TD
 
454
><TD
 
455
>       For each column in the index key, this contains the OID of the
 
456
       collation to use for the index.
 
457
      </TD
 
458
></TR
 
459
><TR
 
460
><TD
 
461
><TT
 
462
CLASS="STRUCTFIELD"
 
463
>indclass</TT
 
464
></TD
 
465
><TD
 
466
><TT
 
467
CLASS="TYPE"
 
468
>oidvector</TT
 
469
></TD
 
470
><TD
 
471
><TT
 
472
CLASS="LITERAL"
 
473
><A
 
474
HREF="catalog-pg-opclass.html"
 
475
><TT
 
476
CLASS="STRUCTNAME"
 
477
>pg_opclass</TT
 
478
></A
 
479
>.oid</TT
 
480
></TD
 
481
><TD
 
482
>       For each column in the index key, this contains the OID of
 
483
       the operator class to use.  See
 
484
       <A
 
485
HREF="catalog-pg-opclass.html"
 
486
><TT
 
487
CLASS="STRUCTNAME"
 
488
>pg_opclass</TT
 
489
></A
 
490
> for details.
 
491
      </TD
 
492
></TR
 
493
><TR
 
494
><TD
 
495
><TT
 
496
CLASS="STRUCTFIELD"
 
497
>indoption</TT
 
498
></TD
 
499
><TD
 
500
><TT
 
501
CLASS="TYPE"
 
502
>int2vector</TT
 
503
></TD
 
504
><TD
 
505
>&nbsp;</TD
 
506
><TD
 
507
>       This is an array of <TT
 
508
CLASS="STRUCTFIELD"
 
509
>indnatts</TT
 
510
> values that
 
511
       store per-column flag bits.  The meaning of the bits is defined by
 
512
       the index's access method.
 
513
      </TD
 
514
></TR
 
515
><TR
 
516
><TD
 
517
><TT
 
518
CLASS="STRUCTFIELD"
 
519
>indexprs</TT
 
520
></TD
 
521
><TD
 
522
><TT
 
523
CLASS="TYPE"
 
524
>pg_node_tree</TT
 
525
></TD
 
526
><TD
 
527
>&nbsp;</TD
 
528
><TD
 
529
>       Expression trees (in <CODE
 
530
CLASS="FUNCTION"
 
531
>nodeToString()</CODE
 
532
>
 
533
       representation) for index attributes that are not simple column
 
534
       references.  This is a list with one element for each zero
 
535
       entry in <TT
 
536
CLASS="STRUCTFIELD"
 
537
>indkey</TT
 
538
>.  Null if all index attributes
 
539
       are simple references.
 
540
      </TD
 
541
></TR
 
542
><TR
 
543
><TD
 
544
><TT
 
545
CLASS="STRUCTFIELD"
 
546
>indpred</TT
 
547
></TD
 
548
><TD
 
549
><TT
 
550
CLASS="TYPE"
 
551
>pg_node_tree</TT
 
552
></TD
 
553
><TD
 
554
>&nbsp;</TD
 
555
><TD
 
556
>       Expression tree (in <CODE
 
557
CLASS="FUNCTION"
 
558
>nodeToString()</CODE
 
559
>
 
560
       representation) for partial index predicate.  Null if not a
 
561
       partial index.
 
562
      </TD
 
563
></TR
 
564
></TBODY
 
565
></TABLE
 
566
></DIV
 
567
></DIV
 
568
><DIV
 
569
CLASS="NAVFOOTER"
 
570
><HR
 
571
ALIGN="LEFT"
 
572
WIDTH="100%"><TABLE
 
573
SUMMARY="Footer navigation table"
 
574
WIDTH="100%"
 
575
BORDER="0"
 
576
CELLPADDING="0"
 
577
CELLSPACING="0"
 
578
><TR
 
579
><TD
 
580
WIDTH="33%"
 
581
ALIGN="left"
 
582
VALIGN="top"
 
583
><A
 
584
HREF="catalog-pg-foreign-table.html"
 
585
ACCESSKEY="P"
 
586
>Prev</A
 
587
></TD
 
588
><TD
 
589
WIDTH="34%"
 
590
ALIGN="center"
 
591
VALIGN="top"
 
592
><A
 
593
HREF="index.html"
 
594
ACCESSKEY="H"
 
595
>Home</A
 
596
></TD
 
597
><TD
 
598
WIDTH="33%"
 
599
ALIGN="right"
 
600
VALIGN="top"
 
601
><A
 
602
HREF="catalog-pg-inherits.html"
 
603
ACCESSKEY="N"
 
604
>Next</A
 
605
></TD
 
606
></TR
 
607
><TR
 
608
><TD
 
609
WIDTH="33%"
 
610
ALIGN="left"
 
611
VALIGN="top"
 
612
><TT
 
613
CLASS="STRUCTNAME"
 
614
>pg_foreign_table</TT
 
615
></TD
 
616
><TD
 
617
WIDTH="34%"
 
618
ALIGN="center"
 
619
VALIGN="top"
 
620
><A
 
621
HREF="catalogs.html"
 
622
ACCESSKEY="U"
 
623
>Up</A
 
624
></TD
 
625
><TD
 
626
WIDTH="33%"
 
627
ALIGN="right"
 
628
VALIGN="top"
 
629
><TT
 
630
CLASS="STRUCTNAME"
 
631
>pg_inherits</TT
 
632
></TD
 
633
></TR
 
634
></TABLE
 
635
></DIV
 
636
></BODY
 
637
></HTML
 
638
>
 
 
b'\\ No newline at end of file'