-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapp-pgbasebackup.html
More file actions
493 lines (486 loc) · 52 KB
/
Copy pathapp-pgbasebackup.html
File metadata and controls
493 lines (486 loc) · 52 KB
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
<?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>pg_basebackup</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="prev" href="app-ecpg.html" title="ecpg" /><link rel="next" href="pgbench.html" title="pgbench" /><meta name="viewport" content="width=device-width,initial-scale=1.0" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left" colspan="2"></td><th width="60%" align="center"><a accesskey="h" href="index.html">PostgreSQL 9.6.5文書</a></th><td width="20%" align="right"><div class="actions"><a class="issue" href="https://github.com/pgsql-jp/jpug-doc/issues/new?title=version 9.6.5 app-pgbasebackup.html">誤訳等の報告</a></div></td></tr><tr><td width="10%" align="left" valign="top"><a accesskey="p" href="app-ecpg.html">前へ</a> </td><td width="10%" align="left" valign="top"><a accesskey="u" href="reference-client.html">上へ</a></td><td width="60%" align="center">pg_basebackup</td><td width="20%" align="right" valign="top"> <a accesskey="n" href="pgbench.html">次へ</a></td></tr></table><hr /></div><div class="refentry" id="app-pgbasebackup"><div class="titlepage"></div><a id="idm45823020736912" class="indexterm"></a><div class="refnamediv"><h2>名前</h2><p>pg_basebackup<span class="original">
<refpurpose>take a base backup of a <productname>PostgreSQL</productname> cluster</refpurpose>
</span> — <span class="productname">PostgreSQL</span>クラスタのベースバックアップを取得する</p></div><div class="refsynopsisdiv"><h2>概要</h2><div class="cmdsynopsis"><p id="idm45823020733040"><code class="command">pg_basebackup</code> [<em class="replaceable"><code>option</code></em>...]</p></div></div><div class="refsect1" id="idm45823020731184"><h2><span class="original">
Description
</span>説明
</h2><p><span class="original">
<application>pg_basebackup</application> is used to take base backups of
a running <productname>PostgreSQL</productname> database cluster. These
are taken without affecting other clients to the database, and can be used
both for point-in-time recovery (see <xref linkend="continuous-archiving">)
and as the starting point for a log shipping or streaming replication standby
servers (see <xref linkend="warm-standby">).
</span><span class="application">pg_basebackup</span>は、稼動中の<span class="productname">PostgreSQL</span>のデータベースクラスタのベースバックアップを取るために使用されます。
データベースへの他のクライアントに影響することなく、バックアップが取られます。
またこのバックアップはポイントインタイムリカバリ（<a class="xref" href="continuous-archiving.html" title="25.3. 継続的アーカイブとポイントインタイムリカバリ（PITR）">25.3. 継続的アーカイブとポイントインタイムリカバリ（PITR）</a>参照）とログシッピングやストリーミングレプリケーションスタンバイサーバ用の開始点（<a class="xref" href="warm-standby.html" title="26.2. ログシッピングスタンバイサーバ">26.2. ログシッピングスタンバイサーバ</a>参照）としても使用することができます。
</p><p><span class="original">
<application>pg_basebackup</application> makes a binary copy of the database
cluster files, while making sure the system is put in and
out of backup mode automatically. Backups are always taken of the entire
database cluster; it is not possible to back up individual databases or
database objects. For individual database backups, a tool such as
<xref linkend="APP-PGDUMP"> must be used.
</span><span class="application">pg_basebackup</span>は、システムをバックアップモードに入れ、また戻すことを自動的に行い、データベースクラスタファイルのバイナリコピーを作成します。
バックアップは常にデータベースクラスタ全体のバックアップを取ります。
個々のデータベースや個々のデータベースオブジェクトをバックアップすることはできません。
個々のデータベースバックアップに関しては<a class="xref" href="app-pgdump.html" title="pg_dump"><span class="refentrytitle">pg_dump</span></a>などのツールを使用しなければなりません。
</p><p><span class="original">
The backup is made over a regular <productname>PostgreSQL</productname>
connection, and uses the replication protocol. The connection must be made
with a superuser or a user having <literal>REPLICATION</literal>
permissions (see <xref linkend="role-attributes">),
and <filename>pg_hba.conf</filename> must explicitly permit the replication
connection. The server must also be configured
with <xref linkend="guc-max-wal-senders"> set high enough to leave at least
one session available for the backup.
</span>バックアップは通常の<span class="productname">PostgreSQL</span>接続を経由して、レプリケーションプロトコルを用いて、作成されます。
この接続はスーパーユーザまたは<code class="literal">REPLICATION</code>権限（<a class="xref" href="role-attributes.html" title="21.2. ロールの属性">21.2. ロールの属性</a>参照）を持つユーザが確立しなければなりません。
さらにレプリケーション用の接続には<code class="filename">pg_hba.conf</code>における明示的な権限が許されていなければなりません。
またサーバで<a class="xref" href="runtime-config-replication.html#guc-max-wal-senders">max_wal_senders</a>を、バックアップ用に少なくとも１つのセッションを残すように十分大きく設定する必要があります。
</p><p><span class="original">
There can be multiple <command>pg_basebackup</command>s running at the same time, but it is
better from a performance point of view to take only one backup, and copy
the result.
</span>同時に<code class="command">pg_basebackup</code>を複数実行することができます。
しかし性能の観点からは、１つのバックアップのみを取り結果をコピーする方が優れています。
</p><p><span class="original">
<application>pg_basebackup</application> can make a base backup from
not only the master but also the standby. To take a backup from the standby,
set up the standby so that it can accept replication connections (that is, set
<varname>max_wal_senders</> and <xref linkend="guc-hot-standby">,
and configure <link linkend="auth-pg-hba-conf">host-based authentication</link>).
You will also need to enable <xref linkend="guc-full-page-writes"> on the master.
</span><span class="application">pg_basebackup</span>は、マスタからだけではなくスタンバイからもベースバックアップを作成することができます。
スタンバイからバックアップを取得するためには、レプリケーション接続を受け付けられるようにスタンバイを設定してください（つまり<code class="varname">max_wal_senders</code>と<a class="xref" href="runtime-config-replication.html#guc-hot-standby">hot_standby</a>を設定し、<a class="link" href="auth-pg-hba-conf.html" title="20.1. pg_hba.confファイル">host-based authentication</a>を設定してください）。
またマスタで<a class="xref" href="runtime-config-wal.html#guc-full-page-writes">full_page_writes</a>を有効にする必要があります。
</p><p><span class="original">
Note that there are some limitations in an online backup from the standby:
</span>スタンバイからのオンラインバックアップではいくつかの制限があることに注意してください。
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="original">
The backup history file is not created in the database cluster backed up.
</span>バックアップ履歴ファイルはバックアップされるデータベースクラスタ内に作成されません。
</p></li><li class="listitem"><p><span class="original">
There is no guarantee that all WAL files required for the backup are archived
at the end of backup. If you are planning to use the backup for an archive
recovery and want to ensure that all required files are available at that moment,
you need to include them into the backup by using the <literal>-x</> option.
</span>バックアップの終了時点で、バックアップに必要なすべてのWALファイルがアーカイブされている保証はありません。
アーカイブリカバリ用にこのバックアップを使用する予定で、かつ、その時点で必要なファイルすべてが利用できることを確実にしたい場合、
<code class="literal">-x</code>オプションを使用してバックアップに含めなければなりません。
</p></li><li class="listitem"><p><span class="original">
If the standby is promoted to the master during online backup, the backup fails.
</span>オンラインバックアップ中にスタンバイがマスタに昇格した場合、バックアップは失敗します。
</p></li><li class="listitem"><p><span class="original">
All WAL records required for the backup must contain sufficient full-page writes,
which requires you to enable <varname>full_page_writes</> on the master and
not to use a tool like <application>pg_compresslog</> as
<varname>archive_command</> to remove full-page writes from WAL files.
</span>バックアップに必要なすべてのWALレコードは、必要なだけの完全ページ書き出しを含んでいなければなりません。
つまりこれは、マスタで<code class="varname">full_page_writes</code>を有効にし、<code class="varname">archive_command</code>としてWALファイルから完全ページ書き出しを取り除く<span class="application">pg_compresslog</span>のようなツールを使用しないことが要求されます。
</p></li></ul></div><p>
</p></div><div class="refsect1" id="idm45823020704800"><h2>オプション</h2><span class="original">
<title>Options</title>
</span><p><span class="original">
The following command-line options control the location and format of the
output.
</span>以下のコマンドラインオプションは出力の場所と書式を制御します。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-D <em class="replaceable"><code>directory</code></em></code><br /></span><span class="term"><code class="option">--pgdata=<em class="replaceable"><code>directory</code></em></code></span></dt><dd><p><span class="original">
Directory to write the output to.
<application>pg_basebackup</application> will create the directory and
any parent directories if necessary. The directory may already exist,
but it is an error if the directory already exists and is not empty.
</span>出力を書き出すディレクトリです。
<span class="application">pg_basebackup</span>は必要ならば、このディレクトリとその親ディレクトリすべてを作成します。
ディレクトリはすでに存在してもかまいませんが、存在しかつ空でない場合はエラーになります。
</p><p><span class="original">
When the backup is in tar mode, and the directory is specified as
<literal>-</literal> (dash), the tar file will be written to
<literal>stdout</literal>.
</span>バックアップがtarモードであり、かつ、指定したディレクトリが<code class="literal">-</code>（ダッシュ）の場合、tarファイルは<code class="literal">stdout</code>に書き出されます。
</p><p><span class="original">
This option is required.
</span>このオプションは必須です。
</p></dd><dt><span class="term"><code class="option">-F <em class="replaceable"><code>format</code></em></code><br /></span><span class="term"><code class="option">--format=<em class="replaceable"><code>format</code></em></code></span></dt><dd><p><span class="original">
Selects the format for the output. <replaceable>format</replaceable>
can be one of the following:
</span>出力形式を選択します。
<em class="replaceable"><code>format</code></em>には以下のいずれかを取ることができます。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">p</code><br /></span><span class="term"><code class="literal">plain</code></span></dt><dd><p><span class="original">
Write the output as plain files, with the same layout as the
current data directory and tablespaces. When the cluster has
no additional tablespaces, the whole database will be placed in
the target directory. If the cluster contains additional
tablespaces, the main data directory will be placed in the
target directory, but all other tablespaces will be placed
in the same absolute path as they have on the server.
</span>普通のファイルとして、現在のデータディレクトリとテーブル空間と同じレイアウトで、出力を書き出します。
クラスタがテーブル空間を追加で持たない場合、データベース全体が指定したディレクトリに格納されます。
クラスタが追加のテーブル空間を持つ場合は、主データディレクトリは指定したディレクトリ内に格納されますが、他のテーブル空間はすべて、サーバ上の同じ絶対パスに格納されます。
</p><p><span class="original">
This is the default format.
</span>これがデフォルトの書式です。
</p></dd><dt><span class="term"><code class="literal">t</code><br /></span><span class="term"><code class="literal">tar</code></span></dt><dd><p><span class="original">
Write the output as tar files in the target directory. The main
data directory will be written to a file named
<filename>base.tar</filename>, and all other tablespaces will
be named after the tablespace OID.
</span>指定したディレクトリ内にtarファイルとして出力を書き出します。
主データディレクトリは<code class="filename">base.tar</code>という名前のファイルに書き出され、他のテーブル空間はすべてテーブル空間のOIDに因んだ名前のファイルに書き出されます。
</p><p><span class="original">
If the value <literal>-</literal> (dash) is specified as
target directory, the tar contents will be written to
standard output, suitable for piping to for example
<productname>gzip</productname>. This is only possible if
the cluster has no additional tablespaces.
</span>対象ディレクトリとして<code class="literal">-</code>（ダッシュ）という値が指定された場合、tarの内容は標準出力に書き出されます。
これは例えば<span class="productname">gzip</span>へのパイプ処理に適しています。
これはクラスタが追加テーブル空間を持たない場合のみ行うことができます。
</p></dd></dl></div></dd><dt><span class="term"><code class="option">-r <em class="replaceable"><code>rate</code></em></code><br /></span><span class="term"><code class="option">--max-rate=<em class="replaceable"><code>rate</code></em></code></span></dt><dd><p><span class="original">
The maximum transfer rate of data transferred from the server. Values are
in kilobytes per second. Use a suffix of <literal>M</> to indicate megabytes
per second. A suffix of <literal>k</> is also accepted, and has no effect.
Valid values are between 32 kilobytes per second and 1024 megabytes per second.
</span>サーバから転送されるデータの最大転送速度です。
値は秒あたりのキロバイト数です。
添字<code class="literal">M</code>を使うと秒あたりのメガバイト数を指定できます。
添字<code class="literal">k</code>を使うこともできますが、効果はありません。
有効な値は秒あたり32キロバイトから秒あたり1024メガバイトまでです。
</p><p><span class="original">
The purpose is to limit the impact of <application>pg_basebackup</application>
on the running server.
</span>この目的は、実行中のサーバに対する<span class="application">pg_basebackup</span>の影響を制限することです。
</p><p><span class="original">
This option always affects transfer of the data directory. Transfer of
WAL files is only affected if the collection method is <literal>fetch</literal>.
</span>このオプションはデータディレクトリの転送に対しては、常に影響があります。
WALファイルの転送については、収集方法が<code class="literal">fetch</code>の場合にのみ影響があります。
</p></dd><dt><span class="term"><code class="option">-R</code><br /></span><span class="term"><code class="option">--write-recovery-conf</code></span></dt><dd><p><span class="original">
Write a minimal <filename>recovery.conf</filename> in the output
directory (or into the base archive file when using tar format) to
ease setting up a standby server.
The <filename>recovery.conf</filename> file will record the connection
settings and, if specified, the replication slot
that <application>pg_basebackup</application> is using, so that the
streaming replication will use the same settings later on.
</span>スタンバイサーバの設定を容易にするために、出力ディレクトリ（tar形式の場合はベースアーカイブファイルの中）に最低限の<code class="filename">recovery.conf</code>を書き出します。
<code class="filename">recovery.conf</code>ファイルは接続設定の情報、また、指定があれば<span class="application">pg_basebackup</span>が使用しているレプリケーションスロットの情報を記録するので、ストリーミングレプリケーションは後で同じ設定を使用します。
</p></dd><dt><span class="term"><code class="option">-S <em class="replaceable"><code>slotname</code></em></code><br /></span><span class="term"><code class="option">--slot=<em class="replaceable"><code>slotname</code></em></code></span></dt><dd><p><span class="original">
This option can only be used together with <literal>-X
stream</literal>. It causes the WAL streaming to use the specified
replication slot. If the base backup is intended to be used as a
streaming replication standby using replication slots, it should then
use the same replication slot name
in <filename>recovery.conf</filename>. That way, it is ensured that
the server does not remove any necessary WAL data in the time between
the end of the base backup and the start of streaming replication.
</span>このオプションは<code class="literal">-X stream</code>と一緒にのみ使用できます。
これによりWALストリーミングが指定したレプリケーションスロットを使用することになります。
ベースバックアップがレプリケーションスロットを利用したストリーミングレプリケーションのスタンバイとしての使用を意図したものであるなら、<code class="filename">recovery.conf</code>内で同じレプリケーションスロット名を使用すべきです。
そうすることで、ベースバックアップの終了とストリーミングレプリケーションの開始の間の時間に、サーバが必要なWALデータを一切削除しないことが保証されます。
</p></dd><dt><span class="term"><code class="option">-T <em class="replaceable"><code>olddir</code></em>=<em class="replaceable"><code>newdir</code></em></code><br /></span><span class="term"><code class="option">--tablespace-mapping=<em class="replaceable"><code>olddir</code></em>=<em class="replaceable"><code>newdir</code></em></code></span></dt><dd><p><span class="original">
Relocate the tablespace in directory <replaceable>olddir</replaceable>
to <replaceable>newdir</replaceable> during the backup. To be
effective, <replaceable>olddir</replaceable> must exactly match the
path specification of the tablespace as it is currently defined. (But
it is not an error if there is no tablespace
in <replaceable>olddir</replaceable> contained in the backup.)
Both <replaceable>olddir</replaceable>
and <replaceable>newdir</replaceable> must be absolute paths. If a
path happens to contain a <literal>=</literal> sign, escape it with a
backslash. This option can be specified multiple times for multiple
tablespaces. See examples below.
</span>
ディレクトリ<em class="replaceable"><code>olddir</code></em>にあるテーブル空間を、バックアップ中に<em class="replaceable"><code>newdir</code></em>に再配置します。
これが有効であるためには、<em class="replaceable"><code>olddir</code></em>が、現在のテーブル空間のパス定義と完全に一致している必要があります(ただし、バックアップに含まれる<em class="replaceable"><code>olddir</code></em>内にテーブル空間がなくてもエラーにはなりません)。
<em class="replaceable"><code>olddir</code></em>と<em class="replaceable"><code>newdir</code></em>はいずれも絶対パスでなければなりません。
パス名に<code class="literal">=</code>記号が含まれるときは、バックスラッシュでエスケープしてください。
このオプションは、複数のテーブル空間に対して複数回指定することができます。
以下の例を参照してください。
</p><p><span class="original">
If a tablespace is relocated in this way, the symbolic links inside
the main data directory are updated to point to the new location. So
the new data directory is ready to be used for a new server instance
with all tablespaces in the updated locations.
</span>
この方法でテーブル空間を再配置すると、メインのデータディレクトリ内のシンボリックリンクは、新しい場所を指すように更新されます。
このため、新しいデータディレクトリは、すべてのテーブル空間が更新された場所にあり、新しいサーバインスタンスがすぐに使える状態になっています。
</p></dd><dt><span class="term"><code class="option">--xlogdir=<em class="replaceable"><code>xlogdir</code></em></code></span></dt><dd><p><span class="original">
Specifies the location for the transaction log directory.
<replaceable>xlogdir</replaceable> must be an absolute path.
The transaction log directory can only be specified when
the backup is in plain mode.
</span>
トランザクションログのディレクトリの場所を指定します。
<em class="replaceable"><code>xlogdir</code></em>は絶対パスでなければなりません。
トランザクションログのディレクトリは、バックアップがplainモードの場合にのみ指定できます。
</p></dd><dt><span class="term"><code class="option">-x</code><br /></span><span class="term"><code class="option">--xlog</code></span></dt><dd><p><span class="original">
Using this option is equivalent of using <literal>-X</literal> with
method <literal>fetch</literal>.
</span>このオプションの使用は、<code class="literal">fetch</code>方式の<code class="literal">-X</code>の使用と同一です。
</p></dd><dt><span class="term"><code class="option">-X <em class="replaceable"><code>method</code></em></code><br /></span><span class="term"><code class="option">--xlog-method=<em class="replaceable"><code>method</code></em></code></span></dt><dd><p><span class="original">
Includes the required transaction log files (WAL files) in the
backup. This will include all transaction logs generated during
the backup. If this option is specified, it is possible to start
a postmaster directly in the extracted directory without the need
to consult the log archive, thus making this a completely standalone
backup.
</span>必要なトランザクションログファイル（WALファイル）をバックアップに含めます。
これはバックアップ中に生成されたトランザクションログをすべて含みます。
このオプションが指定された場合、ログアーカイブを考慮することなく展開したディレクトリ内でそのままpostmasterを起動することができます。
つまりこれは完全なスタンドアローンバックアップを作成します。
</p><p><span class="original">
The following methods for collecting the transaction logs are
supported:
</span>以下のトランザクションログを収集するための方法がサポートされます。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">f</code><br /></span><span class="term"><code class="literal">fetch</code></span></dt><dd><p><span class="original">
The transaction log files are collected at the end of the backup.
Therefore, it is necessary for the
<xref linkend="guc-wal-keep-segments"> parameter to be set high
enough that the log is not removed before the end of the backup.
If the log has been rotated when it's time to transfer it, the
backup will fail and be unusable.
</span>トランザクションログファイルはバックアップの最後に収集されます。
したがって、<a class="xref" href="runtime-config-replication.html#guc-wal-keep-segments">wal_keep_segments</a>パラメータを、バックアップの最後までログが削除されない程度に十分大きくする必要があります。
ログの転送時点でそのログがローテートされていた場合、バックアップは失敗し、使用することができません。
</p></dd><dt><span class="term"><code class="literal">s</code><br /></span><span class="term"><code class="literal">stream</code></span></dt><dd><p><span class="original">
Stream the transaction log while the backup is created. This will
open a second connection to the server and start streaming the
transaction log in parallel while running the backup. Therefore,
it will use up two connections configured by the
<xref linkend="guc-max-wal-senders"> parameter. As long as the
client can keep up with transaction log received, using this mode
requires no extra transaction logs to be saved on the master.
</span>バックアップを作成する時にトランザクションログをストリームします。
これは第二のサーバ接続を開き、バックアップを実行している間、並行してトランザクションログのストリーミングを始めます。
したがって、これは<a class="xref" href="runtime-config-replication.html#guc-max-wal-senders">max_wal_senders</a>で設定される接続を２つ使用します。
クライアントが受け取ったトランザクションログに追従している限り、このモードを使用すれば、マスタ上に余分に保管されるトランザクションログは必要ありません。
</p></dd></dl></div><p>
</p></dd><dt><span class="term"><code class="option">-z</code><br /></span><span class="term"><code class="option">--gzip</code></span></dt><dd><p><span class="original">
Enables gzip compression of tar file output, with the default
compression level. Compression is only available when using
the tar format.
</span>tarファイル出力のデフォルトの圧縮レベルによるgzip圧縮を有効にします。
tarファイルを生成する場合のみ圧縮を利用することができます。
</p></dd><dt><span class="term"><code class="option">-Z <em class="replaceable"><code>level</code></em></code><br /></span><span class="term"><code class="option">--compress=<em class="replaceable"><code>level</code></em></code></span></dt><dd><p><span class="original">
Enables gzip compression of tar file output, and specifies the
compression level (0 through 9, 0 being no compression and 9 being best
compression). Compression is only available when using the tar
format.
</span>tarファイル出力のgzip圧縮を有効にします。
また圧縮レベル（0から9まで、0は圧縮なし、9が最高の圧縮レベル）を指定します。
tarファイルを生成する場合のみ圧縮を利用することができます。
</p></dd></dl></div><p>
</p><p><span class="original">
The following command-line options control the generation of the
backup and the running of the program.
</span>以下のコマンドラインオプションはバックアップの生成とこのプログラムの実行を制御します。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-c <em class="replaceable"><code>fast|spread</code></em></code><br /></span><span class="term"><code class="option">--checkpoint=<em class="replaceable"><code>fast|spread</code></em></code></span></dt><dd><p><span class="original">
Sets checkpoint mode to fast (immediate) or spread (default) (see <xref linkend="backup-lowlevel-base-backup">).
</span>チェックポイントモードをfast（即座に実行）またはspread（デフォルト）に設定します(<a class="xref" href="continuous-archiving.html#backup-lowlevel-base-backup" title="25.3.3. 低レベルAPIを使用したベースバックアップの作成">25.3.3. 低レベルAPIを使用したベースバックアップの作成</a>を参照してください)。
</p></dd><dt><span class="term"><code class="option">-l <em class="replaceable"><code>label</code></em></code><br /></span><span class="term"><code class="option">--label=<em class="replaceable"><code>label</code></em></code></span></dt><dd><p><span class="original">
Sets the label for the backup. If none is specified, a default value of
<quote><literal>pg_basebackup base backup</literal></quote> will be used.
</span>バックアップのラベルを設定します。
何も指定がない場合、<span class="quote">「<span class="quote"><code class="literal">pg_basebackup base backup</code></span>」</span>というデフォルト値が使用されます。
</p></dd><dt><span class="term"><code class="option">-P</code><br /></span><span class="term"><code class="option">--progress</code></span></dt><dd><p><span class="original">
Enables progress reporting. Turning this on will deliver an approximate
progress report during the backup. Since the database may change during
the backup, this is only an approximation and may not end at exactly
<literal>100%</literal>. In particular, when WAL log is included in the
backup, the total amount of data cannot be estimated in advance, and
in this case the estimated target size will increase once it passes the
total estimate without WAL.
</span>進行状況報告を有効にします。
これを有効にすると、バックアップ中におおよその進行状況が報告されます。
データベースはバックアップ中に変更があるかもしれませんので、これはおおよそでしかなくちょうど<code class="literal">100%</code>では終わらないかもしれません。
特に、WALログがバックアップに含まれる場合、データ総量は前もって予測することはできません。
このためこの場合、推定対象容量はWALなしの総推定量を過ぎた後増加します。
</p><p><span class="original">
When this is enabled, the backup will start by enumerating the size of
the entire database, and then go back and send the actual contents.
This may make the backup take slightly longer, and in particular it
will take longer before the first data is sent.
</span>これが有効な場合、バックアップはまずデータベース全体容量を計算し、その後バックアップに戻り、実際の内容を送信します。
バックアップに要する時間は少し長くなるかもしれません。特に最初のデータが送られるようになるまでの時間がより長くなります。
</p></dd><dt><span class="term"><code class="option">-v</code><br /></span><span class="term"><code class="option">--verbose</code></span></dt><dd><p><span class="original">
Enables verbose mode. Will output some extra steps during startup and
shutdown, as well as show the exact file name that is currently being
processed if progress reporting is also enabled.
</span>冗長モードを有効にします。
開始時および終了段階でいくつか追加の段階が出力されます。
また進行状況報告も有効な場合、現在処理中のファイル名も正しく出力されます。
</p></dd></dl></div><p>
</p><p><span class="original">
The following command-line options control the database connection parameters.
</span>以下のオプションはデータベース接続パラメータを制御します。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-d <em class="replaceable"><code>connstr</code></em></code><br /></span><span class="term"><code class="option">--dbname=<em class="replaceable"><code>connstr</code></em></code></span></dt><dd><p><span class="original">
Specifies parameters used to connect to the server, as a connection
string. See <xref linkend="libpq-connstring"> for more information.
</span>サーバとの接続のために使用するパラメータを、接続文字列として指定します。
詳細については<a class="xref" href="libpq-connect.html#libpq-connstring" title="32.1.1. 接続文字列">32.1.1. 接続文字列</a>を参照してください。
</p><p><span class="original">
The option is called <literal>&#045;-dbname</> for consistency with other
client applications, but because <application>pg_basebackup</application>
doesn't connect to any particular database in the cluster, database
name in the connection string will be ignored.
</span>このオプションは他のクライアントアプリケーションとの整合性のために<code class="literal">--dbname</code>と呼ばれます。
しかし、<span class="application">pg_basebackup</span>はクラスタ内の何らかの特定のデータベースに接続しませんので、接続文字列内のデータベース名は無視されます。
</p></dd><dt><span class="term"><code class="option">-h <em class="replaceable"><code>host</code></em></code><br /></span><span class="term"><code class="option">--host=<em class="replaceable"><code>host</code></em></code></span></dt><dd><p><span class="original">
Specifies the host name of the machine on which the server is
running. If the value begins with a slash, it is used as the
directory for the Unix domain socket. The default is taken
from the <envar>PGHOST</envar> environment variable, if set,
else a Unix domain socket connection is attempted.
</span>サーバが稼働しているマシンのホスト名を指定します。
この値がスラッシュから始まる場合、Unixドメインソケット用のディレクトリとして使用されます。
デフォルトは、設定されていれば環境変数<code class="envar">PGHOST</code>から取得されます。
設定されていなければ、Unixドメインソケット接続とみなされます。
</p></dd><dt><span class="term"><code class="option">-p <em class="replaceable"><code>port</code></em></code><br /></span><span class="term"><code class="option">--port=<em class="replaceable"><code>port</code></em></code></span></dt><dd><p><span class="original">
Specifies the TCP port or local Unix domain socket file
extension on which the server is listening for connections.
Defaults to the <envar>PGPORT</envar> environment variable, if
set, or a compiled-in default.
</span>サーバが接続を監視するTCPポートもしくはローカルUnixドメインソケットファイルの拡張子を指定します。
デフォルトは、設定されている場合、環境変数<code class="envar">PGPORT</code>の値となります。設定されていなければ、コンパイル時のデフォルト値となります。
</p></dd><dt><span class="term"><code class="option">-s <em class="replaceable"><code>interval</code></em></code><br /></span><span class="term"><code class="option">--status-interval=<em class="replaceable"><code>interval</code></em></code></span></dt><dd><p><span class="original">
Specifies the number of seconds between status packets sent back to the
server. This allows for easier monitoring of the progress from server.
A value of zero disables the periodic status updates completely,
although an update will still be sent when requested by the server, to
avoid timeout disconnect. The default value is 10 seconds.
</span>状態パケットがサーバに返送される間隔を秒単位で指定します。
これにより簡単にサーバから進行状況を監視することができます。
ゼロという値は定期的な状態更新を完全に無効にします。
しかし、タイムアウトによる切断を防止するために、サーバにより要求された場合に更新は送信されます。
デフォルト値は１０秒です。
</p></dd><dt><span class="term"><code class="option">-U <em class="replaceable"><code>username</code></em></code><br /></span><span class="term"><code class="option">--username=<em class="replaceable"><code>username</code></em></code></span></dt><dd><p><span class="original">
User name to connect as.
</span>接続ユーザ名です。
</p></dd><dt><span class="term"><code class="option">-w</code><br /></span><span class="term"><code class="option">--no-password</code></span></dt><dd><p><span class="original">
Never issue a password prompt. If the server requires
password authentication and a password is not available by
other means such as a <filename>.pgpass</filename> file, the
connection attempt will fail. This option can be useful in
batch jobs and scripts where no user is present to enter a
password.
</span>パスワードの入力を促しません。
サーバがパスワード認証を必要とし、かつ、<code class="filename">.pgpass</code>ファイルなどの他の方法が利用できない場合、接続試行は失敗します。
バッチジョブやスクリプトなどパスワードを入力するユーザが存在しない場合にこのオプションは有用かもしれません。
</p></dd><dt><span class="term"><code class="option">-W</code><br /></span><span class="term"><code class="option">--password</code></span></dt><dd><p><span class="original">
Force <application>pg_basebackup</application> to prompt for a
password before connecting to a database.
</span>データベースに接続する前に、<span class="application">pg_basebackup</span>は強制的にパスワード入力を促します。
</p><p><span class="original">
This option is never essential, since
<application>pg_basebackup</application> will automatically prompt
for a password if the server demands password authentication.
However, <application>pg_basebackup</application> will waste a
connection attempt finding out that the server wants a password.
In some cases it is worth typing <option>-W</> to avoid the extra
connection attempt.
</span>サーバがパスワード認証を要求する場合<span class="application">pg_basebackup</span>は自動的にパスワード入力を促しますので、これが重要になることはありません。
しかし、<span class="application">pg_basebackup</span>は、サーバにパスワードが必要かどうかを判断するための接続試行を無駄に行います。
こうした余計な接続試行を防ぐために<code class="option">-W</code>の入力が有意となる場合もあります。
</p></dd></dl></div><p>
</p><p><span class="original">
Other options are also available:
</span>以下のその他のオプションも使用することができます。
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-V</code><br /></span><span class="term"><code class="option">--version</code></span></dt><dd><p><span class="original">
Print the <application>pg_basebackup</application> version and exit.
</span><span class="application">pg_basebackup</span>のバージョンを表示し終了します。
</p></dd><dt><span class="term"><code class="option">-?</code><br /></span><span class="term"><code class="option">--help</code></span></dt><dd><p><span class="original">
Show help about <application>pg_basebackup</application> command line
arguments, and exit.
</span><span class="application">pg_basebackup</span>コマンドライン引数の使用方法を表示し、終了します。
</p></dd></dl></div><p>
</p></div><div class="refsect1" id="idm45823020583376"><h2>環境</h2><span class="original">
<title>Environment</title>
</span><p><span class="original">
This utility, like most other <productname>PostgreSQL</> utilities,
uses the environment variables supported by <application>libpq</>
(see <xref linkend="libpq-envars">).
</span>他のほとんどの<span class="productname">PostgreSQL</span>ユーティリティと同様このユーティリティは<span class="application">libpq</span>でサポートされる環境変数（<a class="xref" href="libpq-envars.html" title="32.14. 環境変数">32.14. 環境変数</a>参照）を使用します。
</p></div><div class="refsect1" id="idm45823020580000"><h2>注意</h2><span class="original">
<title>Notes</title>
</span><p><span class="original">
At the beginning of the backup, a checkpoint needs to be written on the
server the backup is taken from. Especially if the option
<literal>&#045;-checkpoint=fast</literal> is not used, this can take some time
during which <application>pg_basebackup</application> will be appear
to be idle.
</span>バックアップの開始時に、バックアップを取得するサーバ上でチェックポイントを書き込む必要があります。
特にオプション <code class="literal">--checkpoint=fast</code> を使用していない場合、これには少し時間を要する場合があり、その間 <span class="application">pg_basebackup</span> はアイドル状態であるように見えます。
</p><p><span class="original">
The backup will include all files in the data directory and tablespaces,
including the configuration files and any additional files placed in the
directory by third parties. But only regular files and directories are
copied. Symbolic links (other than those used for tablespaces) and special
device files are skipped. (See <xref linkend="protocol-replication"> for
the precise details.)
</span>このバックアップには、設定ファイルやサードパーティによりディレクトリに格納された追加ファイルを含め、データディレクトリとテーブル空間内のすべてのファイルが含まれます。
しかし、通常ファイルとディレクトリのみがコピーされます。
シンボリックリンク(テーブル空間で利用されているものを除く)および特殊デバイスファイルはスキップされます。
(正確な詳細については<a class="xref" href="protocol-replication.html" title="51.3. ストリーミングレプリケーションプロトコル">51.3. ストリーミングレプリケーションプロトコル</a>を参照してください。)
</p><p><span class="original">
Tablespaces will in plain format by default be backed up to the same path
they have on the server, unless the
option <literal>&#045;&#045;tablespace-mapping</literal> is used. Without
this option, running a plain format base backup on the same host as the
server will not work if tablespaces are in use, because the backup would
have to be written to the same directory locations as the original
tablespaces.
</span>オプション<code class="literal">--tablespace-mapping</code>が使われなければ、テーブル空間はデフォルトでサーバ上のと同じパスでplain形式でバックアップされます。
このオプションがないと、サーバと同じホスト上でのplain形式のベースバックアップの実行は動作しません、というのは、バックアップを元のテーブル空間と同じディレクトリに書き込まなければならないからです。
</p><p><span class="original">
When tar format mode is used, it is the user's responsibility to unpack each
tar file before starting the PostgreSQL server. If there are additional tablespaces, the
tar files for them need to be unpacked in the correct locations. In this
case the symbolic links for those tablespaces will be created by the server
according to the contents of the <filename>tablespace_map</> file that is
included in the <filename>base.tar</> file.
</span>tar形式モードを使う場合、PostgreSQLサーバを起動する前に各tarファイルを解凍するのはユーザの責任です。
追加のテーブル空間がある場合、それについてのtarファイルは、正しい場所に解凍される必要があります。
この場合、テーブル空間へのシンボリックリンクは、<code class="filename">base.tar</code>ファイルに含まれる<code class="filename">tablespace_map</code>ファイルの内容に基づいて、サーバが作成します。
</p><p><span class="original">
<application>pg_basebackup</application> works with servers of the same
or an older major version, down to 9.1. However, WAL streaming mode (<literal>-X
stream</literal>) only works with server version 9.3 and later, and tar format mode
(<literal>&#045;-format=tar</literal>) of the current version only works with server version 9.5
or later.
</span><span class="application">pg_basebackup</span>は同じまたは9.1以降のより古いメジャーバージョンのサーバで動作します。
しかしWALストリーミングモード（<code class="literal">-X stream</code>）はバージョン9.3およびそれ以降のサーバでのみ動作します。
また、現在のバージョンのtar形式モード（<code class="literal">--format=tar</code>はバージョン9.5およびそれ以降のサーバでのみ動作します。
</p></div><div class="refsect1" id="idm45823020565680"><h2>例</h2><span class="original">
<title>Examples</title>
</span><p><span class="original">
To create a base backup of the server at <literal>mydbserver</literal>
and store it in the local directory
<filename>/usr/local/pgsql/data</filename>:
</span><code class="literal">mydbserver</code>で稼動するサーバのベースバックアップを作成し、ローカルディレクトリ<code class="filename">/usr/local/pgsql/data</code>に保管します。
</p><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pg_basebackup -h mydbserver -D /usr/local/pgsql/data</code></strong></pre><p>
</p><p><span class="original">
To create a backup of the local server with one compressed
tar file for each tablespace, and store it in the directory
<filename>backup</filename>, showing a progress report while running:
</span>各テーブル空間につき圧縮したtarファイルを1つ作成するようにローカルサーバをバックアップし、<code class="filename">backup</code>ディレクトリに保管します。
同時に実行時に進行状況を表示します。
</p><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pg_basebackup -D backup -Ft -z -P</code></strong></pre><p>
</p><p><span class="original">
To create a backup of a single-tablespace local database and compress
this with <productname>bzip2</productname>:
</span>単一のテーブル空間を持つローカルデータベースのバックアップを作成し、それを<span class="productname">bzip2</span>で圧縮します。
</p><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pg_basebackup -D - -Ft | bzip2 > backup.tar.bz2</code></strong></pre><p><span class="original">
(This command will fail if there are multiple tablespaces in the
database.)
</span>
（データベース内に複数のテーブル空間が存在する場合このコマンドは失敗します。）
</p><p><span class="original">
To create a backup of a local database where the tablespace in
<filename>/opt/ts</filename> is relocated
to <filename>./backup/ts</filename>:
</span><code class="filename">/opt/ts</code>にあるテーブル空間を<code class="filename">./backup/ts</code>に再配置してローカルデータベースのバックアップを作成します。
</p><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pg_basebackup -D backup/data -T /opt/ts=$(pwd)/backup/ts</code></strong></pre><p>
</p></div><div class="refsect1" id="idm45823020550496"><h2>関連項目</h2><span class="original">
<title>See Also</title>
</span><span class="simplelist"><a class="xref" href="app-pgdump.html" title="pg_dump"><span class="refentrytitle">pg_dump</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="app-ecpg.html">前へ</a> </td><td width="20%" align="center"><a accesskey="u" href="reference-client.html">上へ</a></td><td width="40%" align="right"> <a accesskey="n" href="pgbench.html">次へ</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="application">ecpg</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">ホーム</a></td><td width="40%" align="right" valign="top"> <span class="application">pgbench</span></td></tr></table></div></body></html>