← 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/view-pg-settings.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/view-pg-settings.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_settings</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_seclabels"
 
19
HREF="view-pg-seclabels.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="pg_shadow"
 
22
HREF="view-pg-shadow.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_seclabels"
 
57
HREF="view-pg-seclabels.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_shadow"
 
90
HREF="view-pg-shadow.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="VIEW-PG-SETTINGS"
 
105
>45.62. <TT
 
106
CLASS="STRUCTNAME"
 
107
>pg_settings</TT
 
108
></A
 
109
></H1
 
110
><P
 
111
>   The view <TT
 
112
CLASS="STRUCTNAME"
 
113
>pg_settings</TT
 
114
> provides access to
 
115
   run-time parameters of the server.  It is essentially an alternative
 
116
   interface to the <A
 
117
HREF="sql-show.html"
 
118
>SHOW</A
 
119
>
 
120
   and <A
 
121
HREF="sql-set.html"
 
122
>SET</A
 
123
> commands.
 
124
   It also provides access to some facts about each parameter that are
 
125
   not directly available from <TT
 
126
CLASS="COMMAND"
 
127
>SHOW</TT
 
128
>, such as minimum and
 
129
   maximum values.
 
130
  </P
 
131
><DIV
 
132
CLASS="TABLE"
 
133
><A
 
134
NAME="AEN90355"
 
135
></A
 
136
><P
 
137
><B
 
138
>Table 45-63. <TT
 
139
CLASS="STRUCTNAME"
 
140
>pg_settings</TT
 
141
> Columns</B
 
142
></P
 
143
><TABLE
 
144
BORDER="1"
 
145
CLASS="CALSTABLE"
 
146
><COL><COL><COL><THEAD
 
147
><TR
 
148
><TH
 
149
>Name</TH
 
150
><TH
 
151
>Type</TH
 
152
><TH
 
153
>Description</TH
 
154
></TR
 
155
></THEAD
 
156
><TBODY
 
157
><TR
 
158
><TD
 
159
><TT
 
160
CLASS="STRUCTFIELD"
 
161
>name</TT
 
162
></TD
 
163
><TD
 
164
><TT
 
165
CLASS="TYPE"
 
166
>text</TT
 
167
></TD
 
168
><TD
 
169
>Run-time configuration parameter name</TD
 
170
></TR
 
171
><TR
 
172
><TD
 
173
><TT
 
174
CLASS="STRUCTFIELD"
 
175
>setting</TT
 
176
></TD
 
177
><TD
 
178
><TT
 
179
CLASS="TYPE"
 
180
>text</TT
 
181
></TD
 
182
><TD
 
183
>Current value of the parameter</TD
 
184
></TR
 
185
><TR
 
186
><TD
 
187
><TT
 
188
CLASS="STRUCTFIELD"
 
189
>unit</TT
 
190
></TD
 
191
><TD
 
192
><TT
 
193
CLASS="TYPE"
 
194
>text</TT
 
195
></TD
 
196
><TD
 
197
>Implicit unit of the parameter</TD
 
198
></TR
 
199
><TR
 
200
><TD
 
201
><TT
 
202
CLASS="STRUCTFIELD"
 
203
>category</TT
 
204
></TD
 
205
><TD
 
206
><TT
 
207
CLASS="TYPE"
 
208
>text</TT
 
209
></TD
 
210
><TD
 
211
>Logical group of the parameter</TD
 
212
></TR
 
213
><TR
 
214
><TD
 
215
><TT
 
216
CLASS="STRUCTFIELD"
 
217
>short_desc</TT
 
218
></TD
 
219
><TD
 
220
><TT
 
221
CLASS="TYPE"
 
222
>text</TT
 
223
></TD
 
224
><TD
 
225
>A brief description of the parameter</TD
 
226
></TR
 
227
><TR
 
228
><TD
 
229
><TT
 
230
CLASS="STRUCTFIELD"
 
231
>extra_desc</TT
 
232
></TD
 
233
><TD
 
234
><TT
 
235
CLASS="TYPE"
 
236
>text</TT
 
237
></TD
 
238
><TD
 
239
>Additional, more detailed, description of the parameter</TD
 
240
></TR
 
241
><TR
 
242
><TD
 
243
><TT
 
244
CLASS="STRUCTFIELD"
 
245
>context</TT
 
246
></TD
 
247
><TD
 
248
><TT
 
249
CLASS="TYPE"
 
250
>text</TT
 
251
></TD
 
252
><TD
 
253
>Context required to set the parameter's value (see below)</TD
 
254
></TR
 
255
><TR
 
256
><TD
 
257
><TT
 
258
CLASS="STRUCTFIELD"
 
259
>vartype</TT
 
260
></TD
 
261
><TD
 
262
><TT
 
263
CLASS="TYPE"
 
264
>text</TT
 
265
></TD
 
266
><TD
 
267
>Parameter type (<TT
 
268
CLASS="LITERAL"
 
269
>bool</TT
 
270
>, <TT
 
271
CLASS="LITERAL"
 
272
>enum</TT
 
273
>,
 
274
       <TT
 
275
CLASS="LITERAL"
 
276
>integer</TT
 
277
>, <TT
 
278
CLASS="LITERAL"
 
279
>real</TT
 
280
>, or <TT
 
281
CLASS="LITERAL"
 
282
>string</TT
 
283
>)
 
284
      </TD
 
285
></TR
 
286
><TR
 
287
><TD
 
288
><TT
 
289
CLASS="STRUCTFIELD"
 
290
>source</TT
 
291
></TD
 
292
><TD
 
293
><TT
 
294
CLASS="TYPE"
 
295
>text</TT
 
296
></TD
 
297
><TD
 
298
>Source of the current parameter value</TD
 
299
></TR
 
300
><TR
 
301
><TD
 
302
><TT
 
303
CLASS="STRUCTFIELD"
 
304
>min_val</TT
 
305
></TD
 
306
><TD
 
307
><TT
 
308
CLASS="TYPE"
 
309
>text</TT
 
310
></TD
 
311
><TD
 
312
>Minimum allowed value of the parameter (null for non-numeric
 
313
      values)</TD
 
314
></TR
 
315
><TR
 
316
><TD
 
317
><TT
 
318
CLASS="STRUCTFIELD"
 
319
>max_val</TT
 
320
></TD
 
321
><TD
 
322
><TT
 
323
CLASS="TYPE"
 
324
>text</TT
 
325
></TD
 
326
><TD
 
327
>Maximum allowed value of the parameter (null for non-numeric
 
328
      values)</TD
 
329
></TR
 
330
><TR
 
331
><TD
 
332
><TT
 
333
CLASS="STRUCTFIELD"
 
334
>enumvals</TT
 
335
></TD
 
336
><TD
 
337
><TT
 
338
CLASS="TYPE"
 
339
>text[]</TT
 
340
></TD
 
341
><TD
 
342
>Allowed values of an enum parameter (null for non-enum
 
343
      values)</TD
 
344
></TR
 
345
><TR
 
346
><TD
 
347
><TT
 
348
CLASS="STRUCTFIELD"
 
349
>boot_val</TT
 
350
></TD
 
351
><TD
 
352
><TT
 
353
CLASS="TYPE"
 
354
>text</TT
 
355
></TD
 
356
><TD
 
357
>Parameter value assumed at server startup if the parameter is
 
358
      not otherwise set</TD
 
359
></TR
 
360
><TR
 
361
><TD
 
362
><TT
 
363
CLASS="STRUCTFIELD"
 
364
>reset_val</TT
 
365
></TD
 
366
><TD
 
367
><TT
 
368
CLASS="TYPE"
 
369
>text</TT
 
370
></TD
 
371
><TD
 
372
>Value that <TT
 
373
CLASS="COMMAND"
 
374
>RESET</TT
 
375
> would reset the parameter to
 
376
      in the current session</TD
 
377
></TR
 
378
><TR
 
379
><TD
 
380
><TT
 
381
CLASS="STRUCTFIELD"
 
382
>sourcefile</TT
 
383
></TD
 
384
><TD
 
385
><TT
 
386
CLASS="TYPE"
 
387
>text</TT
 
388
></TD
 
389
><TD
 
390
>Configuration file the current value was set in (null for
 
391
      values set from sources other than configuration files, or when
 
392
      examined by a non-superuser);
 
393
      helpful when using <TT
 
394
CLASS="LITERAL"
 
395
>include</TT
 
396
> directives in configuration files</TD
 
397
></TR
 
398
><TR
 
399
><TD
 
400
><TT
 
401
CLASS="STRUCTFIELD"
 
402
>sourceline</TT
 
403
></TD
 
404
><TD
 
405
><TT
 
406
CLASS="TYPE"
 
407
>integer</TT
 
408
></TD
 
409
><TD
 
410
>Line number within the configuration file the current value was
 
411
      set at (null for values set from sources other than configuration files,
 
412
      or when examined by a non-superuser)
 
413
      </TD
 
414
></TR
 
415
></TBODY
 
416
></TABLE
 
417
></DIV
 
418
><P
 
419
>   There are several possible values of <TT
 
420
CLASS="STRUCTFIELD"
 
421
>context</TT
 
422
>.
 
423
   In order of decreasing difficulty of changing the setting, they are:
 
424
  </P
 
425
><P
 
426
></P
 
427
><DIV
 
428
CLASS="VARIABLELIST"
 
429
><DL
 
430
><DT
 
431
><TT
 
432
CLASS="LITERAL"
 
433
>internal</TT
 
434
></DT
 
435
><DD
 
436
><P
 
437
>      These settings cannot be changed directly; they reflect internally
 
438
      determined values.  Some of them may be adjustable by rebuilding the
 
439
      server with different configuration options, or by changing options
 
440
      supplied to <TT
 
441
CLASS="COMMAND"
 
442
>initdb</TT
 
443
>.
 
444
     </P
 
445
></DD
 
446
><DT
 
447
><TT
 
448
CLASS="LITERAL"
 
449
>postmaster</TT
 
450
></DT
 
451
><DD
 
452
><P
 
453
>      These settings can only be applied when the server starts, so any change
 
454
      requires restarting the server.  Values for these settings are typically
 
455
      stored in the <TT
 
456
CLASS="FILENAME"
 
457
>postgresql.conf</TT
 
458
> file, or passed on
 
459
      the command line when starting the server.  Of course, settings with any
 
460
      of the lower <TT
 
461
CLASS="STRUCTFIELD"
 
462
>context</TT
 
463
> types can also be
 
464
      set at server start time.
 
465
     </P
 
466
></DD
 
467
><DT
 
468
><TT
 
469
CLASS="LITERAL"
 
470
>sighup</TT
 
471
></DT
 
472
><DD
 
473
><P
 
474
>      Changes to these settings can be made in
 
475
      <TT
 
476
CLASS="FILENAME"
 
477
>postgresql.conf</TT
 
478
> without restarting the server.
 
479
      Send a <SPAN
 
480
CLASS="SYSTEMITEM"
 
481
>SIGHUP</SPAN
 
482
> signal to the postmaster to
 
483
      cause it to re-read <TT
 
484
CLASS="FILENAME"
 
485
>postgresql.conf</TT
 
486
> and apply
 
487
      the changes.  The postmaster will also forward the
 
488
      <SPAN
 
489
CLASS="SYSTEMITEM"
 
490
>SIGHUP</SPAN
 
491
> signal to its child processes so that
 
492
      they all pick up the new value.
 
493
     </P
 
494
></DD
 
495
><DT
 
496
><TT
 
497
CLASS="LITERAL"
 
498
>backend</TT
 
499
></DT
 
500
><DD
 
501
><P
 
502
>      Changes to these settings can be made in
 
503
      <TT
 
504
CLASS="FILENAME"
 
505
>postgresql.conf</TT
 
506
> without restarting the server;
 
507
      they can also be set for a particular session in the connection request
 
508
      packet (for example, via <SPAN
 
509
CLASS="APPLICATION"
 
510
>libpq</SPAN
 
511
>'s <TT
 
512
CLASS="LITERAL"
 
513
>PGOPTIONS</TT
 
514
>
 
515
      environment variable).  However, these settings never change in a
 
516
      session after it is started.  If you change them in
 
517
      <TT
 
518
CLASS="FILENAME"
 
519
>postgresql.conf</TT
 
520
>, send a
 
521
      <SPAN
 
522
CLASS="SYSTEMITEM"
 
523
>SIGHUP</SPAN
 
524
> signal to the postmaster to cause it to
 
525
      re-read <TT
 
526
CLASS="FILENAME"
 
527
>postgresql.conf</TT
 
528
>.  The new values will only
 
529
      affect subsequently-launched sessions.
 
530
     </P
 
531
></DD
 
532
><DT
 
533
><TT
 
534
CLASS="LITERAL"
 
535
>superuser</TT
 
536
></DT
 
537
><DD
 
538
><P
 
539
>      These settings can be set from <TT
 
540
CLASS="FILENAME"
 
541
>postgresql.conf</TT
 
542
>,
 
543
      or within a session via the <TT
 
544
CLASS="COMMAND"
 
545
>SET</TT
 
546
> command; but only superusers
 
547
      can change them via <TT
 
548
CLASS="COMMAND"
 
549
>SET</TT
 
550
>.  Changes in
 
551
      <TT
 
552
CLASS="FILENAME"
 
553
>postgresql.conf</TT
 
554
> will affect existing sessions
 
555
      only if no session-local value has been established with <TT
 
556
CLASS="COMMAND"
 
557
>SET</TT
 
558
>.
 
559
     </P
 
560
></DD
 
561
><DT
 
562
><TT
 
563
CLASS="LITERAL"
 
564
>user</TT
 
565
></DT
 
566
><DD
 
567
><P
 
568
>      These settings can be set from <TT
 
569
CLASS="FILENAME"
 
570
>postgresql.conf</TT
 
571
>,
 
572
      or within a session via the <TT
 
573
CLASS="COMMAND"
 
574
>SET</TT
 
575
> command.  Any user is
 
576
      allowed to change his session-local value.  Changes in
 
577
      <TT
 
578
CLASS="FILENAME"
 
579
>postgresql.conf</TT
 
580
> will affect existing sessions
 
581
      only if no session-local value has been established with <TT
 
582
CLASS="COMMAND"
 
583
>SET</TT
 
584
>.
 
585
     </P
 
586
></DD
 
587
></DL
 
588
></DIV
 
589
><P
 
590
>   See <A
 
591
HREF="config-setting.html"
 
592
>Section 18.1</A
 
593
> for more information about the various
 
594
   ways to change these parameters.
 
595
  </P
 
596
><P
 
597
>   The <TT
 
598
CLASS="STRUCTNAME"
 
599
>pg_settings</TT
 
600
> view cannot be inserted into or
 
601
   deleted from, but it can be updated.  An <TT
 
602
CLASS="COMMAND"
 
603
>UPDATE</TT
 
604
> applied
 
605
   to a row of <TT
 
606
CLASS="STRUCTNAME"
 
607
>pg_settings</TT
 
608
> is equivalent to executing
 
609
   the <A
 
610
HREF="sql-set.html"
 
611
>SET</A
 
612
> command on that named
 
613
   parameter. The change only affects the value used by the current
 
614
   session. If an <TT
 
615
CLASS="COMMAND"
 
616
>UPDATE</TT
 
617
> is issued within a transaction
 
618
   that is later aborted, the effects of the <TT
 
619
CLASS="COMMAND"
 
620
>UPDATE</TT
 
621
> command
 
622
   disappear when the transaction is rolled back. Once the surrounding
 
623
   transaction is committed, the effects will persist until the end of the
 
624
   session, unless overridden by another <TT
 
625
CLASS="COMMAND"
 
626
>UPDATE</TT
 
627
> or
 
628
   <TT
 
629
CLASS="COMMAND"
 
630
>SET</TT
 
631
>.
 
632
  </P
 
633
></DIV
 
634
><DIV
 
635
CLASS="NAVFOOTER"
 
636
><HR
 
637
ALIGN="LEFT"
 
638
WIDTH="100%"><TABLE
 
639
SUMMARY="Footer navigation table"
 
640
WIDTH="100%"
 
641
BORDER="0"
 
642
CELLPADDING="0"
 
643
CELLSPACING="0"
 
644
><TR
 
645
><TD
 
646
WIDTH="33%"
 
647
ALIGN="left"
 
648
VALIGN="top"
 
649
><A
 
650
HREF="view-pg-seclabels.html"
 
651
ACCESSKEY="P"
 
652
>Prev</A
 
653
></TD
 
654
><TD
 
655
WIDTH="34%"
 
656
ALIGN="center"
 
657
VALIGN="top"
 
658
><A
 
659
HREF="index.html"
 
660
ACCESSKEY="H"
 
661
>Home</A
 
662
></TD
 
663
><TD
 
664
WIDTH="33%"
 
665
ALIGN="right"
 
666
VALIGN="top"
 
667
><A
 
668
HREF="view-pg-shadow.html"
 
669
ACCESSKEY="N"
 
670
>Next</A
 
671
></TD
 
672
></TR
 
673
><TR
 
674
><TD
 
675
WIDTH="33%"
 
676
ALIGN="left"
 
677
VALIGN="top"
 
678
><TT
 
679
CLASS="STRUCTNAME"
 
680
>pg_seclabels</TT
 
681
></TD
 
682
><TD
 
683
WIDTH="34%"
 
684
ALIGN="center"
 
685
VALIGN="top"
 
686
><A
 
687
HREF="catalogs.html"
 
688
ACCESSKEY="U"
 
689
>Up</A
 
690
></TD
 
691
><TD
 
692
WIDTH="33%"
 
693
ALIGN="right"
 
694
VALIGN="top"
 
695
><TT
 
696
CLASS="STRUCTNAME"
 
697
>pg_shadow</TT
 
698
></TD
 
699
></TR
 
700
></TABLE
 
701
></DIV
 
702
></BODY
 
703
></HTML
 
704
>
 
 
b'\\ No newline at end of file'