-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathamcheck.html
638 lines (637 loc) · 52.7 KB
/
amcheck.html
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>F.1. amcheck — テーブルとインデックスの一貫性を検査するツール</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="contrib.html" title="付録F 追加で提供されるモジュールと拡張" /><link rel="next" href="auth-delay.html" title="F.2. auth_delay — 認証エラー時に一時停止" /><meta name="viewport" content="width=device-width,initial-scale=1.0" /></head><body id="docContent" class="container-fluid col-10"><div class="other_version"><a href="https://www.postgresql.jp/document/">バージョンごとのドキュメント一覧</a></div><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="4" align="center"><a accesskey="h" href="index.html">PostgreSQL 17.0文書</a></th></tr><tr><td width="10%" align="left"></td><td width="10%" align="left"></td><td width="60%" align="center"><a href="contrib.html" title="付録F 追加で提供されるモジュールと拡張">付録F 追加で提供されるモジュールと拡張</a></td><td width="20%" align="right"><div class="actions"><a class="issue" title="github" href="https://github.com/pgsql-jp/jpug-doc/issues/new?template=bug_report.yml&what-happened=version 17.0 : amcheck.html">誤訳等の報告
</a></div></td></tr><tr><td width="10%" align="left"><a accesskey="p" href="contrib.html" title="付録F 追加で提供されるモジュールと拡張">前へ</a> </td><td width="10%" align="left"><a accesskey="u" href="contrib.html" title="付録F 追加で提供されるモジュールと拡張">上へ</a></td><td width="60%" align="center">F.1. amcheck — テーブルとインデックスの一貫性を検査するツール</td><td width="20%" align="right"> <a accesskey="n" href="auth-delay.html" title="F.2. auth_delay — 認証エラー時に一時停止">次へ</a></td></tr></table><hr /></div><div class="sect1" id="AMCHECK"><div class="titlepage"><div><div><h2 class="title" style="clear: both">F.1. amcheck — テーブルとインデックスの一貫性を検査するツール <a href="#AMCHECK" class="id_link">#</a></h2></div></div></div><span class="original">
<title>amcheck &mdash; tools to verify table and index consistency</title>
</span><a id="id-1.11.7.11.2" class="indexterm"></a><p>
<span class="original">
The <filename>amcheck</filename> module provides functions that allow you to
verify the logical consistency of the structure of relations.
</span>
<code class="filename">amcheck</code>モジュールは、リレーションの構造の論理的な一貫性を検査する機能を提供します。
</p><p>
<span class="original">
The B-Tree checking functions verify various <emphasis>invariants</emphasis> in the
structure of the representation of particular relations. The
correctness of the access method functions behind index scans and
other important operations relies on these invariants always
holding. For example, certain functions verify, among other things,
that all B-Tree pages have items in <quote>logical</quote> order (e.g.,
for B-Tree indexes on <type>text</type>, index tuples should be in
collated lexical order). If that particular invariant somehow fails
to hold, we can expect binary searches on the affected page to
incorrectly guide index scans, resulting in wrong answers to SQL
queries. If the structure appears to be valid, no error is raised.
While these checking functions are run, the <xref
linkend="guc-search-path"/> is temporarily changed to <literal>pg_catalog,
pg_temp</literal>.
</span>
B-Tree検査関数は、特定のリレーションの構造表現における様々な<span class="emphasis"><em>不変量</em></span>を検査します。
インデックスの走査や、その他の重要な操作を担うアクセスメソッド関数の正しさは、これらの不変量を常に保つことに依存しています。
たとえば、ある関数は、とりわけすべてのB-Treeページの中の項目が<span class="quote">「<span class="quote">論理的な</span>」</span>順序になっていることを検査します。（たとえば<code class="type">text</code>のB-Treeインデックスでは、インデックスタプルは語句の照合順になっていなければなりません。）
その特定の不変量が何らかの理由で保たれなければ、該当するページで二分探索が不正なインデックス走査をもたらし、SQL問い合わせに誤った答えを返すことになるでしょう。
構造が適正であると見なされれば、エラーは報告されません。
これらのチェック関数の実行中、<a class="xref" href="runtime-config-client.html#GUC-SEARCH-PATH">search_path</a>は一時的に<code class="literal">pg_catalog, pg_temp</code>に変更されます。
</p><p>
<span class="original">
Verification is performed using the same procedures as those used by
index scans themselves, which may be user-defined operator class
code. For example, B-Tree index verification relies on comparisons
made with one or more B-Tree support function 1 routines. See <xref
linkend="xindex-support"/> for details of operator class support
functions.
</span>
検証は、インデックススキャン自身で使われるのと同じ手続きを用いて行われます。
その手続きは、ユーザ定義演算子クラスのコードかもしれません。
たとえば、B-Treeインデックスの検査は、一つ以上のB-Treeサポート関数1ルーチンを用いる比較に依存しています。
演算子クラスサポート関数の詳細については<a class="xref" href="xindex.html#XINDEX-SUPPORT" title="36.16.3. インデックスメソッドのサポートルーチン">36.16.3</a>をご覧ください。
</p><p>
<span class="original">
Unlike the B-Tree checking functions which report corruption by raising
errors, the heap checking function <function>verify_heapam</function> checks
a table and attempts to return a set of rows, one row per corruption
detected. Despite this, if facilities that
<function>verify_heapam</function> relies upon are themselves corrupted, the
function may be unable to continue and may instead raise an error.
</span>
エラーを起こすことによって破損を報告するB-Tree検査関数とは違って、ヒープ検査関数<code class="function">verify_heapam</code>はテーブルを検査し、破損の検出ごとに1行が対応する行の集合を返そうとします。
にも関わらず、<code class="function">verify_heapam</code>が依存する機能自体が破損していれば、この関数は続行することができず、代わりにエラーを引き起こすかもしれません。
</p><p>
<span class="original">
Permission to execute <filename>amcheck</filename> functions may be granted
to non-superusers, but before granting such permissions careful consideration
should be given to data security and privacy concerns. Although the
corruption reports generated by these functions do not focus on the contents
of the corrupted data so much as on the structure of that data and the nature
of the corruptions found, an attacker who gains permission to execute these
functions, particularly if the attacker can also induce corruption, might be
able to infer something of the data itself from such messages.
</span>
非スーパーユーザに<code class="filename">amcheck</code>関数の実行許可を与えることができますが、そのような権限を許可する前に、データのセキュリティとプライバシー上の懸念を注意深く考慮すべきです。
これらの関数が生成する破損報告は、データの構造と見つかった破損の性質ほどには、破損データの内容に焦点を当てるわけではありませんが、とりわけ攻撃者が破損を引き起こすこともできるのであれば、これらの関数の実行権限を与えられた攻撃者はそうしたメッセージからデータ自身を推測できるかもしれません。
</p><div class="sect2" id="AMCHECK-FUNCTIONS"><div class="titlepage"><div><div><h3 class="title">F.1.1. 関数 <a href="#AMCHECK-FUNCTIONS" class="id_link">#</a></h3></div></div></div><span class="original">
<title>Functions</title>
</span><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<code class="function">bt_index_check(index regclass, heapallindexed boolean, checkunique boolean) returns void</code>
<a id="id-1.11.7.11.8.2.1.1.2" class="indexterm"></a>
</span></dt><dd><p>
<span class="original">
<function>bt_index_check</function> tests that its target, a
B-Tree index, respects a variety of invariants. Example usage:
</span>
<code class="function">bt_index_check</code>は対象となるB-Treeインデックスが、様々な不変量を維持していることをテストします。
例を示します。
</p><pre class="screen">
test=# SELECT bt_index_check(index => c.oid, heapallindexed => i.indisunique),
c.relname,
c.relpages
FROM pg_index i
JOIN pg_opclass op ON i.indclass[0] = op.oid
JOIN pg_am am ON op.opcmethod = am.oid
JOIN pg_class c ON i.indexrelid = c.oid
JOIN pg_namespace n ON c.relnamespace = n.oid
WHERE am.amname = 'btree' AND n.nspname = 'pg_catalog'
-- Don't check temp tables, which may be from another session:
AND c.relpersistence != 't'
-- Function may throw an error when this is omitted:
AND c.relkind = 'i' AND i.indisready AND i.indisvalid
ORDER BY c.relpages DESC LIMIT 10;
bt_index_check | relname | relpages
----------------+---------------------------------+----------
| pg_depend_reference_index | 43
| pg_depend_depender_index | 40
| pg_proc_proname_args_nsp_index | 31
| pg_description_o_c_o_index | 21
| pg_attribute_relid_attnam_index | 14
| pg_proc_oid_index | 10
| pg_attribute_relid_attnum_index | 9
| pg_amproc_fam_proc_index | 5
| pg_amop_opr_fam_index | 5
| pg_amop_fam_strat_index | 5
(10 rows)
</pre><p>
<span class="original">
This example shows a session that performs verification of the
10 largest catalog indexes in the database <quote>test</quote>.
Verification of the presence of heap tuples as index tuples is
requested for the subset that are unique indexes. Since no
error is raised, all indexes tested appear to be logically
consistent. Naturally, this query could easily be changed to
call <function>bt_index_check</function> for every index in the
database where verification is supported.
</span>
この例では、データベース<span class="quote">「<span class="quote">test</span>」</span>中のもっとも大きな10個のカタログインデックスの検証を行うセッションを示しています。
インデックスタプルに対応するヒープタプルの存在の検証が、ユニークインデックスであるインデックスの一部に対して要求されています。
エラーは出ていないので、テストしたすべてのインデックスは論理的に一貫していることがわかります。
当然のことながら、この問い合わせは、検証可能なデータベース中のすべてのインデックスに対して<code class="function">bt_index_check</code>を呼び出すように変更できます。
</p><p>
<span class="original">
<function>bt_index_check</function> acquires an <literal>AccessShareLock</literal>
on the target index and the heap relation it belongs to. This lock mode
is the same lock mode acquired on relations by simple
<literal>SELECT</literal> statements.
<function>bt_index_check</function> does not verify invariants
that span child/parent relationships, but will verify the
presence of all heap tuples as index tuples within the index
when <parameter>heapallindexed</parameter> is
<literal>true</literal>. When <parameter>checkunique</parameter>
is <literal>true</literal> <function>bt_index_check</function> will
check that no more than one among duplicate entries in unique
index is visible. When a routine, lightweight test for
corruption is required in a live production environment, using
<function>bt_index_check</function> often provides the best
trade-off between thoroughness of verification and limiting the
impact on application performance and availability.
</span>
<code class="function">bt_index_check</code>は、ターゲットとなるインデックスと、それが所属するヒープリレーションに対して<code class="literal">AccessShareLock</code>を獲得します。
このロックモードは、単純な<code class="literal">SELECT</code>文がリレーションに対して獲得するのと同じものです。
<code class="function">bt_index_check</code>は、子／親関係にわたる不変量を検査しませんが、<em class="parameter"><code>heapallindexed</code></em>が<code class="literal">true</code>の場合には、インデックス中のインデックスタプルに対応するすべてのヒープタプルの存在が検証されます。
<em class="parameter"><code>checkunique</code></em>が<code class="literal">true</code>の場合、<code class="function">bt_index_check</code>は一意インデックス内の重複エントリの中で可視のものが1つだけであることを検証します。
実行中の運用環境で定期的、軽量なデータ破損検査が必要な場合、<code class="function">bt_index_check</code>を使うのが、検査の完全性と、アプリケーションの性能と稼働への影響を限定することとの間の最良のトレードオフになることがしばしばあります。
</p></dd><dt><span class="term">
<code class="function">bt_index_parent_check(index regclass, heapallindexed boolean, rootdescend boolean, checkunique boolean) returns void</code>
<a id="id-1.11.7.11.8.2.2.1.2" class="indexterm"></a>
</span></dt><dd><p>
<span class="original">
<function>bt_index_parent_check</function> tests that its
target, a B-Tree index, respects a variety of invariants.
Optionally, when the <parameter>heapallindexed</parameter>
argument is <literal>true</literal>, the function verifies the
presence of all heap tuples that should be found within the
index. When <parameter>checkunique</parameter>
is <literal>true</literal> <function>bt_index_parent_check</function> will
check that no more than one among duplicate entries in unique
index is visible. When the optional <parameter>rootdescend</parameter>
argument is <literal>true</literal>, verification re-finds
tuples on the leaf level by performing a new search from the
root page for each tuple. The checks that can be performed by
<function>bt_index_parent_check</function> are a superset of the
checks that can be performed by <function>bt_index_check</function>.
<function>bt_index_parent_check</function> can be thought of as
a more thorough variant of <function>bt_index_check</function>:
unlike <function>bt_index_check</function>,
<function>bt_index_parent_check</function> also checks
invariants that span parent/child relationships, including checking
that there are no missing downlinks in the index structure.
<function>bt_index_parent_check</function> follows the general
convention of raising an error if it finds a logical
inconsistency or other problem.
</span>
<code class="function">bt_index_parent_check</code>は、ターゲットとなるB-Treeインデックスが様々な不変量を保っていることを検査します。
オプションとして、<em class="parameter"><code>heapallindexed</code></em>引数が<code class="literal">true</code>の場合、インデックスに対応して存在すべきすべてのヒープタプルの存在を検証します。
<em class="parameter"><code>checkunique</code></em>が<code class="literal">true</code>の場合、一意インデックスの重複エントリの中で可視のものが1つだけであることを検査します。
省略可能な引数<em class="parameter"><code>rootdescend</code></em>が<code class="literal">true</code>であれば、各タプルに対するルートページから新しく探索することで、検証はリーフレベルのタプルを再び見つけます。
<code class="function">bt_index_parent_check</code>により実施される検査は、<code class="function">bt_index_check</code>により実施される検査のスーパーセットになっています。
<code class="function">bt_index_parent_check</code>は、<code class="function">bt_index_check</code>の更なる完璧版であると考えることができます。
つまり、<code class="function">bt_index_check</code>と違って<code class="function">bt_index_parent_check</code>は、インデックス構造中のダウンリンクに漏れがないことを含め、親／子関係に渡る不変量も検査します。
<code class="function">bt_index_parent_check</code>は、論理的な非一貫性やその他の問題を発見した場合、一般的な習慣に従ってエラーを報告します。
</p><p>
<span class="original">
A <literal>ShareLock</literal> is required on the target index by
<function>bt_index_parent_check</function> (a
<literal>ShareLock</literal> is also acquired on the heap relation).
These locks prevent concurrent data modification from
<command>INSERT</command>, <command>UPDATE</command>, and <command>DELETE</command>
commands. The locks also prevent the underlying relation from
being concurrently processed by <command>VACUUM</command>, as well as
all other utility commands. Note that the function holds locks
only while running, not for the entire transaction.
</span>
<code class="function">bt_index_parent_check</code>は、ターゲットインデックスに<code class="literal">ShareLock</code>を獲得することを必要とします。
（<code class="literal">ShareLock</code>はヒープリレーションにも獲得されます。）
このロックは、<code class="command">INSERT</code>、<code class="command">UPDATE</code>、<code class="command">DELETE</code>が並行してデータ更新することを防ぎます。
また、このロックは<code class="command">VACUUM</code>その他のユーティリティコマンドによって、背後にあるリレーションが同時に処理されることを防ぎます。
この関数は実行中のみロックを保持し、トランザクション全体に保持するのではないことに注意してください。
</p><p>
<span class="original">
<function>bt_index_parent_check</function>'s additional
verification is more likely to detect various pathological
cases. These cases may involve an incorrectly implemented
B-Tree operator class used by the index that is checked, or,
hypothetically, undiscovered bugs in the underlying B-Tree index
access method code. Note that
<function>bt_index_parent_check</function> cannot be used when
hot standby mode is enabled (i.e., on read-only physical
replicas), unlike <function>bt_index_check</function>.
</span>
<code class="function">bt_index_parent_check</code>による追加の検査では、様々な病的な事象を検出する可能性があります。
これらの現象は、チェック対象のインデックスが使用している間違った実装がされたB-Tree演算子クラスによるものや、もしかしたら関連するB-Treeインデックスアクセスメソッドのコード中のまだ見つかっていないバグによるものなのかもしれません。
<code class="function">bt_index_check</code>と違って、<code class="function">bt_index_parent_check</code>は、ホットスタンバイモードが有効な場合（すなわち、読み出し専用物理レプリカ）では使用できません。
</p></dd></dl></div><div class="tip"><h3 class="title">ヒント</h3><p>
<span class="original">
<function>bt_index_check</function> and
<function>bt_index_parent_check</function> both output log
messages about the verification process at
<literal>DEBUG1</literal> and <literal>DEBUG2</literal> severity
levels. These messages provide detailed information about the
verification process that may be of interest to
<productname>PostgreSQL</productname> developers. Advanced users
may also find this information helpful, since it provides
additional context should verification actually detect an
inconsistency. Running:
</span>
<code class="function">bt_index_check</code>と<code class="function">bt_index_parent_check</code>は両方とも、<code class="literal">DEBUG1</code>と<code class="literal">DEBUG2</code>の深刻度レベルで検証プロセスに関するログメッセージを出力します。
このメッセージは、<span class="productname">PostgreSQL</span>開発者にとって興味のあるかもしれない検証プロセスに関する詳細な情報を提供します。
検証が実際に非一貫性を検出する追加の状況を提供しますので、上級ユーザにもこの情報は役立つかもしれません。
以下を実行すると、
</p><pre class="programlisting">
SET client_min_messages = DEBUG1;
</pre><p>
<span class="original">
in an interactive <application>psql</application> session before
running a verification query will display messages about the
progress of verification with a manageable level of detail.
</span>
検証問い合わせを実行する前に対話式の<span class="application">psql</span>セッションで扱いやすい程度の詳細で検証の進行状況に関するメッセージを表示します。
</p></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<code class="function">
verify_heapam(relation regclass,
on_error_stop boolean,
check_toast boolean,
skip text,
startblock bigint,
endblock bigint,
blkno OUT bigint,
offnum OUT integer,
attnum OUT integer,
msg OUT text)
returns setof record
</code>
</span></dt><dd><p>
<span class="original">
Checks a table, sequence, or materialized view for structural corruption,
where pages in the relation contain data that is invalidly formatted, and
for logical corruption, where pages are structurally valid but
inconsistent with the rest of the database cluster.
</span>
リレーションのページが不正なフォーマットのデータを含む構造上の破損と、ページは構造的に正しいものの、データベースクラスタの他の部分と一貫していない論理上の破損に関してテーブル、シーケンス、またはマテリアライズドビューを検査します。
</p><p>
<span class="original">
The following optional arguments are recognized:
</span>
次のようなオプションの引数を認識します。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">on_error_stop</code></span></dt><dd><p>
<span class="original">
If true, corruption checking stops at the end of the first block in
which any corruptions are found.
</span>
真なら、破損が見つかった最初のブロックの終端で破損検査は終了します。
</p><p>
<span class="original">
Defaults to false.
</span>
デフォルトは偽です。
</p></dd><dt><span class="term"><code class="literal">check_toast</code></span></dt><dd><p>
<span class="original">
If true, toasted values are checked against the target relation's
TOAST table.
</span>
真なら、TOASTされた値が対象リレーションのTOASTテーブルに対して検査されます。
</p><p>
<span class="original">
This option is known to be slow. Also, if the toast table or its
index is corrupt, checking it against toast values could conceivably
crash the server, although in many cases this would just produce an
error.
</span>
このオプションは遅いことが知られています。
また、TOASTテーブルあるいはそのインデックスが破損していると、それをTOAST値に対して検査することで、おそらくサーバがクラッシュすることもあり得ます。
もっとも、多くの場合には単にエラーが生じるだけでしょう。
</p><p>
<span class="original">
Defaults to false.
</span>
デフォルトは偽です。
</p></dd><dt><span class="term"><code class="literal">skip</code></span></dt><dd><p>
<span class="original">
If not <literal>none</literal>, corruption checking skips blocks that
are marked as all-visible or all-frozen, as specified.
Valid options are <literal>all-visible</literal>,
<literal>all-frozen</literal> and <literal>none</literal>.
</span>
<code class="literal">none</code>でなければ、指定されたとおりに破損検査はすべて可視あるいは凍結されていると印が付けられたブロックをスキップします。
可能なオプションは<code class="literal">all-visible</code>、<code class="literal">all-frozen</code>、<code class="literal">none</code>です。
</p><p>
<span class="original">
Defaults to <literal>none</literal>.
</span>
デフォルトは<code class="literal">none</code>です。
</p></dd><dt><span class="term"><code class="literal">startblock</code></span></dt><dd><p>
<span class="original">
If specified, corruption checking begins at the specified block,
skipping all previous blocks. It is an error to specify a
<parameter>startblock</parameter> outside the range of blocks in the
target table.
</span>
指定すると、破損検査は前のブロックをすべてスキップして指定ブロックから開始されます。
<em class="parameter"><code>startblock</code></em>をターゲットテーブルに含まれるブロックの範囲外で指定するとエラーになります。
</p><p>
<span class="original">
By default, checking begins at the first block.
</span>
デフォルトでは最初のブロックから検索が始まります。
</p></dd><dt><span class="term"><code class="literal">endblock</code></span></dt><dd><p>
<span class="original">
If specified, corruption checking ends at the specified block,
skipping all remaining blocks. It is an error to specify an
<parameter>endblock</parameter> outside the range of blocks in the target
table.
</span>
指定すると、残りのすべてのブロックをスキップして指定ブロックで破損検査が終了します。
<em class="parameter"><code>endblock</code></em>をターゲットテーブルに含まれるブロックの範囲外で指定するとエラーになります。
</p><p>
<span class="original">
By default, all blocks are checked.
</span>
デフォルトではすべてのブロックが検査されます。
</p></dd></dl></div><p>
<span class="original">
For each corruption detected, <function>verify_heapam</function> returns
a row with the following columns:
</span>
個々の破損の検出に対して<code class="function">verify_heapam</code>は以下の列を含む行を返します。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">blkno</code></span></dt><dd><p>
<span class="original">
The number of the block containing the corrupt page.
</span>
破損ページを含むブロック番号。
</p></dd><dt><span class="term"><code class="literal">offnum</code></span></dt><dd><p>
<span class="original">
The OffsetNumber of the corrupt tuple.
</span>
破損タプルのオフセット番号。
</p></dd><dt><span class="term"><code class="literal">attnum</code></span></dt><dd><p>
<span class="original">
The attribute number of the corrupt column in the tuple, if the
corruption is specific to a column and not the tuple as a whole.
</span>
タプル全体ではなく、破損が特定の列にのみ起こっているなら、タプル内の破損列の属性番号。
</p></dd><dt><span class="term"><code class="literal">msg</code></span></dt><dd><p>
<span class="original">
A message describing the problem detected.
</span>
検出された問題を記述するメッセージ。
</p></dd></dl></div></dd></dl></div></div><div class="sect2" id="AMCHECK-OPTIONAL-HEAPALLINDEXED-VERIFICATION"><div class="titlepage"><div><div><h3 class="title">F.1.2. オプション<em class="parameter"><code>heapallindexed</code></em>検証 <a href="#AMCHECK-OPTIONAL-HEAPALLINDEXED-VERIFICATION" class="id_link">#</a></h3></div></div></div><span class="original">
<title>Optional <parameter>heapallindexed</parameter> Verification</title>
</span><p>
<span class="original">
When the <parameter>heapallindexed</parameter> argument to B-Tree
verification functions is <literal>true</literal>, an additional
phase of verification is performed against the table associated with
the target index relation. This consists of a <quote>dummy</quote>
<command>CREATE INDEX</command> operation, which checks for the
presence of all hypothetical new index tuples against a temporary,
in-memory summarizing structure (this is built when needed during
the basic first phase of verification). The summarizing structure
<quote>fingerprints</quote> every tuple found within the target
index. The high level principle behind
<parameter>heapallindexed</parameter> verification is that a new
index that is equivalent to the existing, target index must only
have entries that can be found in the existing structure.
</span>
B-Tree検証関数の<em class="parameter"><code>heapallindexed</code></em>引数が<code class="literal">true</code>ならば、ターゲットのインデックスリレーションと関連付けられたテーブルに対して追加の検証フェーズが実施されます。
これは<span class="quote">「<span class="quote">ダミー</span>」</span>の<code class="command">CREATE INDEX</code>操作から構成され、インメモリ上の一時的なサマリ構造（これは必要に応じて基礎的な最初の検証フェーズで構築されます）に対する仮想的な新しいインデックスタプルがすべて存在することをチェックします。
サマリ構造はターゲットのインデックスで見つかったすべてのタプルに対して<span class="quote">「<span class="quote">指紋採取(fingerprint)</span>」</span>を行います。
<em class="parameter"><code>heapallindexed</code></em>検証の背後にある高レベルの原理は、新しいインデックスが既存のインデックスと等しいこと、ターゲットインデックスが既存の構造中に見つかったエントリのみを含むことです。
</p><p>
<span class="original">
The additional <parameter>heapallindexed</parameter> phase adds
significant overhead: verification will typically take several times
longer. However, there is no change to the relation-level locks
acquired when <parameter>heapallindexed</parameter> verification is
performed.
</span>
追加の<em class="parameter"><code>heapallindexed</code></em>フェーズは大きなオーバーヘッドをもたらします。
典型的には、検証に数倍時間かかるようになります。
しかし、取得されたリレーションレベルのロックに対して、<em class="parameter"><code>heapallindexed</code></em>検証が実施されるときに変更はありません。
</p><p>
<span class="original">
The summarizing structure is bound in size by
<varname>maintenance_work_mem</varname>. In order to ensure that
there is no more than a 2% probability of failure to detect an
inconsistency for each heap tuple that should be represented in the
index, approximately 2 bytes of memory are needed per tuple. As
less memory is made available per tuple, the probability of missing
an inconsistency slowly increases. This approach limits the
overhead of verification significantly, while only slightly reducing
the probability of detecting a problem, especially for installations
where verification is treated as a routine maintenance task. Any
single absent or malformed tuple has a new opportunity to be
detected with each new verification attempt.
</span>
サマライズ構造は、<code class="varname">maintenance_work_mem</code>によってその大きさが制限されます。
インデックス中に存在すべきヒープタプルの非一貫性の検出失敗の確率が2%を超えないことを保証するために、タプルごとに約2バイトのメモリが必要です。
タプルごとに利用可能なメモリが少ないほど、非一貫性を見逃す可能性が徐々に増えていきます。
この手法によって検証のオーバーヘッドを大幅に減らせる一方、とりわけ検証を日常的な保守作業として行うシステムでは、問題を検出できる確率が少し減少するだけです。
失われた、あるいは不正なタプルは次の検証の機会に検出されます。
</p></div><div class="sect2" id="AMCHECK-USING-AMCHECK-EFFECTIVELY"><div class="titlepage"><div><div><h3 class="title">F.1.3. <code class="filename">amcheck</code>を効果的に使う <a href="#AMCHECK-USING-AMCHECK-EFFECTIVELY" class="id_link">#</a></h3></div></div></div><span class="original">
<title>Using <filename>amcheck</filename> Effectively</title>
</span><p>
<span class="original">
<filename>amcheck</filename> can be effective at detecting various types of
failure modes that <link
linkend="app-initdb-data-checksums"><application>data
checksums</application></link> will fail to catch. These include:
</span>
<code class="filename">amcheck</code>は、<a class="link" href="app-initdb.html#APP-INITDB-DATA-CHECKSUMS"><span class="application">データチェックサム</span></a>が検知できないような、様々なタイプの障害モードを効果的に検知できます。
以下のようなものがあります。
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<span class="original">
Structural inconsistencies caused by incorrect operator class
implementations.
</span>
演算子クラスの正しくない実装によって引き起こされる構造の非一貫性。
</p><p>
<span class="original">
This includes issues caused by the comparison rules of operating
system collations changing. Comparisons of datums of a collatable
type like <type>text</type> must be immutable (just as all
comparisons used for B-Tree index scans must be immutable), which
implies that operating system collation rules must never change.
Though rare, updates to operating system collation rules can
cause these issues. More commonly, an inconsistency in the
collation order between a primary server and a standby server is
implicated, possibly because the <emphasis>major</emphasis> operating
system version in use is inconsistent. Such inconsistencies will
generally only arise on standby servers, and so can generally
only be detected on standby servers.
</span>
オペレーティングシステムの照合順序の比較ルールの変更による問題も含まれます。
<code class="type">text</code>のような照合可能な型のデータの比較は、不変でなければならず（B-Treeインデックスのスキャンのための、すべての比較が不変でなければならないのと同じことです）、それはオペレーティングシステムの照合順序が決して変化してはいけないことを意味します。
まれであるとは言え、オペレーティングシステムの照合順序ルールの更新は、これらの問題を引き起こします。
もっと普通に起こることとしては、プライマリサーバとスタンバイサーバの照合順序の違いが関与することです。
これは、使用されているオペレーティングシステムの<span class="emphasis"><em>メジャー</em></span>バージョンに一貫性がないことによります。
そうした一貫性の欠如は一般的にスタンバイサーバでのみ起こるので、通常スタンバイサーバでのみ検出されます。
</p><p>
<span class="original">
If a problem like this arises, it may not affect each individual
index that is ordered using an affected collation, simply because
<emphasis>indexed</emphasis> values might happen to have the same
absolute ordering regardless of the behavioral inconsistency. See
<xref linkend="locale"/> and <xref linkend="collation"/> for
further details about how <productname>PostgreSQL</productname> uses
operating system locales and collations.
</span>
そうした問題が起きても、影響を受けた照合順序を使って順序付けられた個々のインデックスには影響ないかもしれません。
これは単純に、振る舞いにおける一貫性のなさにかかわらず<span class="emphasis"><em>インデックスされた</em></span>値は同じ絶対的な順になるからです。
<span class="productname">PostgreSQL</span>がオペレーティングシステムのロケールと照合順序をどう使用するかについての更なる詳細については、<a class="xref" href="locale.html" title="23.1. ロケールのサポート">23.1</a>と<a class="xref" href="collation.html" title="23.2. 照合順序サポート">23.2</a>をご覧ください。
</p></li><li class="listitem"><p>
<span class="original">
Structural inconsistencies between indexes and the heap relations
that are indexed (when <parameter>heapallindexed</parameter>
verification is performed).
</span>
インデックスとインデックス付されたヒープリレーションの間の構造的な非一貫性（<em class="parameter"><code>heapallindexed</code></em>検証が実施される場合）
</p><p>
<span class="original">
There is no cross-checking of indexes against their heap relation
during normal operation. Symptoms of heap corruption can be subtle.
</span>
通常の操作においてはインデックスとそのヒープリレーションの間にはクロスチェックはありません。
ヒープの破壊による症状は些細なものかもしれません。
</p></li><li class="listitem"><p>
<span class="original">
Corruption caused by hypothetical undiscovered bugs in the
underlying <productname>PostgreSQL</productname> access method
code, sort code, or transaction management code.
</span>
依拠する<span class="productname">PostgreSQL</span>のアクセスメソッド、あるいはソート、トランザクション管理コードにおける、潜在的なまだ見つかっていないバグによる破損。
</p><p>
<span class="original">
Automatic verification of the structural integrity of indexes
plays a role in the general testing of new or proposed
<productname>PostgreSQL</productname> features that could plausibly allow a
logical inconsistency to be introduced. Verification of table
structure and associated visibility and transaction status
information plays a similar role. One obvious testing strategy
is to call <filename>amcheck</filename> functions continuously
when running the standard regression tests. See <xref
linkend="regress-run"/> for details on running the tests.
</span>
新規、あるいは提案中の <span class="productname">PostgreSQL</span>の機能が、論理的な非一貫性をもたらしかねないかどうか全般的にテストする際に、インデックスの構造的な一貫性の自動検証が役立ちます。
テーブル構造と、関連する可視性およびトランザクション状態情報の検証も同じような役割を果たします。
わかりやすいテスト戦略の一つは、標準のリグレッションテストを実行中に、<code class="filename">amcheck</code>関数を継続的に呼び出すことです。
テストの実行に関する詳細は、<a class="xref" href="regress-run.html" title="31.1. テストの実行">31.1</a>をご覧ください。
</p></li><li class="listitem"><p>
<span class="original">
File system or storage subsystem faults where checksums happen to
simply not be enabled.
</span>
単にチェックサムが有効になっていないファイルシステムあるいはストレージサブシステムの障害。
</p><p>
<span class="original">
Note that <filename>amcheck</filename> examines a page as represented in some
shared memory buffer at the time of verification if there is only a
shared buffer hit when accessing the block. Consequently,
<filename>amcheck</filename> does not necessarily examine data read from the
file system at the time of verification. Note that when checksums are
enabled, <filename>amcheck</filename> may raise an error due to a checksum
failure when a corrupt block is read into a buffer.
</span>
<code class="filename">amcheck</code>は、ブロックをアクセスする際に共有バッファがヒットした場合、検査時に共有メモリバッファ上に表現されたページを調査します。
そのため、<code class="filename">amcheck</code>は、検査時にファイルシステムから読み込んだデータを調査するとは限りません。
チェックサムが有効な場合、<code class="filename">amcheck</code>は壊れたブロックをバッファに読み込んだ際にチェックサム障害によるエラーを報告するかもしれません。
</p></li><li class="listitem"><p>
<span class="original">
Corruption caused by faulty RAM, or the broader memory subsystem.
</span>
欠陥のあるRAMあるいは、広範囲に渡るメモリサブシステムによる破損。
</p><p>
<span class="original">
<productname>PostgreSQL</productname> does not protect against correctable
memory errors and it is assumed you will operate using RAM that
uses industry standard Error Correcting Codes (ECC) or better
protection. However, ECC memory is typically only immune to
single-bit errors, and should not be assumed to provide
<emphasis>absolute</emphasis> protection against failures that
result in memory corruption.
</span>
<span class="productname">PostgreSQL</span>は、訂正可能なメモリエラーからは身を守らないので、業界標準のエラー訂正コード(ECC)、あるいはもっと優れた保護機構を使ったRAMを使って運用する前提となっています。
しかし、ECCメモリは典型的には単一ビットエラーに対してのみ耐性があり、メモリ破損に起因する障害に対して<span class="emphasis"><em>完全な</em></span>保護を提供すると考えるべきではありません。
</p><p>
<span class="original">
When <parameter>heapallindexed</parameter> verification is
performed, there is generally a greatly increased chance of
detecting single-bit errors, since strict binary equality is
tested, and the indexed attributes within the heap are tested.
</span>
<em class="parameter"><code>heapallindexed</code></em>検証が実施されると、一般に1ビットエラーを検出する可能性が非常に高くなります。
これは、バイナリ一致を厳密にテストすることと、またヒープ内のインデックス付けされたアトリビュートをテストすることによります。
</p></li></ul></div><p>
</p><p>
<span class="original">
Structural corruption can happen due to faulty storage hardware, or
relation files being overwritten or modified by unrelated software.
This kind of corruption can also be detected with
<link linkend="checksums"><application>data page
checksums</application></link>.
</span>
構造上の破損は故障したストレージハードウェア、あるいはリレーションファイルが無関係のソフトウェアによって上書きされたり変更されることによって起こることがあります。
この種の破損は<a class="link" href="checksums.html" title="28.2. データチェックサム"><span class="application">データページチェックサム</span></a>によっても検出することができます。
</p><p>
<span class="original">
Relation pages which are correctly formatted, internally consistent, and
correct relative to their own internal checksums may still contain
logical corruption. As such, this kind of corruption cannot be detected
with <application>checksums</application>. Examples include toasted
values in the main table which lack a corresponding entry in the toast
table, and tuples in the main table with a Transaction ID that is older
than the oldest valid Transaction ID in the database or cluster.
</span>
正しくフォーマットされ、内部的に一貫していて、かつ自身の内部チェックサムが正しいリレーションページでも論理的に破損していることがあります。
ですから、この種の破損は<span class="application">チェックサム</span>では検出できません。
例としては、主テーブルのTOASTされた値に対応するTOASTテーブルのエントリが存在しない、主テーブルのタプルのトランザクションIDがデータベースクラスタ内の有効な最古のトランザクションIDよりも古い、などがあります。
</p><p>
<span class="original">
Multiple causes of logical corruption have been observed in production
systems, including bugs in the <productname>PostgreSQL</productname>
server software, faulty and ill-conceived backup and restore tools, and
user error.
</span>
<span class="productname">PostgreSQL</span>サーバソフトウェアのバグ、欠陥があったり、よく考慮されていないバックアップ、リストアツール、ユーザのエラーなど、論理的破損の複数の原因が実運用システム上で観測されています。
</p><p>
<span class="original">
Corrupt relations are most concerning in live production environments,
precisely the same environments where high risk activities are least
welcome. For this reason, <function>verify_heapam</function> has been
designed to diagnose corruption without undue risk. It cannot guard
against all causes of backend crashes, as even executing the calling
query could be unsafe on a badly corrupted system. Access to <link
linkend="catalogs-overview">catalog tables</link> is performed and could
be problematic if the catalogs themselves are corrupted.
</span>
破損したリレーションは、リスクの高い活動がもっとも忌避される環境である、運用中の実システム環境では最大の懸念事項です。
このため、<code class="function">verify_heapam</code>は過度のリスクを伴わずに破損を診断するように設計されています。
ひどく破損したシステムでは問い合わせの呼び出しを実行するだけでも安全ではないため、バックエンドのクラッシュのすべての原因から守ることはできません。
カタログ自身が破損していれば<a class="link" href="catalogs-overview.html" title="51.1. 概要">カタログテーブル</a>へのアクセスの実行も問題になるでしょう。
</p><p>
<span class="original">
In general, <filename>amcheck</filename> can only prove the presence of
corruption; it cannot prove its absence.
</span>
一般的に、<code class="filename">amcheck</code>は破損の存在を証明することはできますが、破損がないことを証明することはできません。
</p></div><div class="sect2" id="AMCHECK-REPAIRING-CORRUPTION"><div class="titlepage"><div><div><h3 class="title">F.1.4. 破損の修復 <a href="#AMCHECK-REPAIRING-CORRUPTION" class="id_link">#</a></h3></div></div></div><span class="original">
<title>Repairing Corruption</title>
</span><p>
<span class="original">
No error concerning corruption raised by <filename>amcheck</filename> should
ever be a false positive. <filename>amcheck</filename> raises
errors in the event of conditions that, by definition, should never
happen, and so careful analysis of <filename>amcheck</filename>
errors is often required.
</span>
<code class="filename">amcheck</code>が報告するエラーが関与する破損で、偽陽性のものはありません。
<code class="filename">amcheck</code>は、定義により発生してはならないはずの条件下で発生したエラーを報告するので、<code class="filename">amcheck</code>の報告するエラーを注意深く解析することがしばしば求められます。
</p><p>
<span class="original">
There is no general method of repairing problems that
<filename>amcheck</filename> detects. An explanation for the root cause of
an invariant violation should be sought. <xref
linkend="pageinspect"/> may play a useful role in diagnosing
corruption that <filename>amcheck</filename> detects. A <command>REINDEX</command>
may not be effective in repairing corruption.
</span>
<code class="filename">amcheck</code>が検出した問題を修復する一般的な方法はありません。
不変条件違反の根本的な原因の説明が求められます。
<code class="filename">amcheck</code>が検出した破損の診断には、<a class="xref" href="pageinspect.html" title="F.23. pageinspect — データベースページの低レベルな調査">pageinspect</a>が有用な役割を担うかもしれません。
<code class="command">REINDEX</code>は破損の修復には効果的ではないかもしれません。
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="contrib.html" title="付録F 追加で提供されるモジュールと拡張">前へ</a> </td><td width="20%" align="center"><a accesskey="u" href="contrib.html" title="付録F 追加で提供されるモジュールと拡張">上へ</a></td><td width="40%" align="right"> <a accesskey="n" href="auth-delay.html" title="F.2. auth_delay — 認証エラー時に一時停止">次へ</a></td></tr><tr><td width="40%" align="left" valign="top">付録F 追加で提供されるモジュールと拡張 </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 17.0文書">ホーム</a></td><td width="40%" align="right" valign="top"> F.2. auth_delay — 認証エラー時に一時停止</td></tr></table></div></body></html>