codekingpro/portable-devtools
114k
1
2
3<!DOCTYPE html>
4
5<html lang="en" data-content_root="./">
6 <head>
7 <meta charset="utf-8" />
8 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
9
10 <title>Backup Server Dialog — pgAdmin 4 8.6 documentation</title>
11 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
12 <link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
13
14 <script src="_static/documentation_options.js?v=d4c83366"></script>
15 <script src="_static/doctools.js?v=9a2dae69"></script>
16 <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
17
18 <script src="_static/sidebar.js"></script>
19
20 <link rel="index" title="Index" href="genindex.html" />
21 <link rel="search" title="Search" href="search.html" />
22 <link rel="next" title="Restore Dialog" href="restore_dialog.html" />
23 <link rel="prev" title="Backup Globals Dialog" href="backup_globals_dialog.html" />
24 </head><body>
25 <div class="related" role="navigation" aria-label="related navigation">
26 <h3>Navigation</h3>
27 <ul>
28 <li class="right" style="margin-right: 10px">
29 <a href="genindex.html" title="General Index"
30 accesskey="I">index</a></li>
31 <li class="right" >
32 <a href="restore_dialog.html" title="Restore Dialog"
33 accesskey="N">next</a> |</li>
34 <li class="right" >
35 <a href="backup_globals_dialog.html" title="Backup Globals Dialog"
36 accesskey="P">previous</a> |</li>
37 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
38 <li class="nav-item nav-item-1"><a href="backup_and_restore.html" accesskey="U">Backup and Restore</a> »</li>
39 <li class="nav-item nav-item-this"><a href="">Backup Server Dialog</a></li>
40 </ul>
41 </div>
42
43 <div class="document">
44 <div class="documentwrapper">
45 <div class="bodywrapper">
46 <div class="body" role="main">
47
48 <section id="backup-server-dialog">
49<span id="id1"></span><h1><span class="target" id="index-0"></span>Backup Server Dialog<a class="headerlink" href="#backup-server-dialog" title="Link to this heading">¶</a></h1>
50<p>Use the <em>Backup Server</em> dialog to create a plain-text script that will recreate
51the selected server. You can use the pgAdmin <em>Query Tool</em> to play back a
52plain-text script, and recreate the server.</p>
53<img alt="Backup server dialog" class="align-center" src="_images/backup_server_general.png" />
54<p>Use the fields in the <em>General</em> tab to specify the following:</p>
55<ul class="simple">
56<li><p>Enter the name of the backup file in the <em>Filename</em> field. Optionally, select
57the <em>Browser</em> icon (ellipsis) to the right to navigate into a directory and
58select a file that will contain the archive.</p></li>
59<li><p>Use the <em>Encoding</em> drop-down listbox to select the character encoding method
60that should be used for the archive. <strong>Note:</strong> This option is visible only for
61database server greater than or equal to 11.</p></li>
62<li><p>Use the drop-down listbox next to <em>Role name</em> to specify a role with
63connection privileges on the selected server. The role will be used for
64authentication during the backup.</p></li>
65</ul>
66<p>Click the <em>Data Options</em> tab to continue. Use the fields in the <em>Data Options</em>
67tab to provide options related to data or pgAdmin objects that correspond to <em>pg_dumpall</em>.</p>
68<img alt="Type of objects option on backup server dialog" class="align-center" src="_images/backup_server_objects.png" />
69<ul>
70<li><p>Move switches in the <strong>Type of objects</strong> field box to specify details about
71the type of objects that will be backed up.</p>
72<blockquote>
73<div><ul class="simple">
74<li><p>Move the switch next to <em>Only data</em> towards right position to limit the back
75up to data.</p></li>
76<li><p>Move the switch next to <em>Only schemas</em> to limit the back up to schema-level
77database objects.</p></li>
78<li><p>Move the switch next to <em>Only tablespaces</em> to limit the back
79up to tablespaces only.</p></li>
80<li><p>Move the switch next to <em>Only roles</em> to limit the back up to roles only.</p></li>
81</ul>
82</div></blockquote>
83</li>
84</ul>
85<img alt="Do not save option on backup server dialog" class="align-center" src="_images/backup_server_do_not_save.png" />
86<ul>
87<li><p>Move switches in the <strong>Do not save</strong> field box to select the objects that will
88not be included in the backup.</p>
89<blockquote>
90<div><ul class="simple">
91<li><p>Move the switch next to <em>Owner</em> towards right position to exclude commands
92that set object ownership.</p></li>
93<li><p>Move the switch next to <em>Role passwords</em> towards right position to exclude
94passwords for roles.</p></li>
95<li><p>Move the switch next to <em>Privileges</em> towards right position to exclude
96commands that create access privileges.</p></li>
97<li><p>Move the switch next to <em>Tablespaces</em> towards right position to exclude
98tablespaces.</p></li>
99<li><p>Move the switch next to <em>Unlogged table data</em> towards right position to
100exclude the contents of unlogged tables.</p></li>
101<li><p>Move the switch next to <em>Comments</em> towards right position to exclude
102commands that set the comments. <strong>Note:</strong> This option is visible only for
103database server greater than or equal to 11.</p></li>
104<li><p>Move the switch next to <em>Publications</em> towards right position to exclude
105publications.</p></li>
106<li><p>Move the switch next to <em>Subscriptions</em> towards right position to exclude
107subscriptions.</p></li>
108<li><p>Move the switch next to <em>Security labels</em> towards right position to exclude
109Security labels.</p></li>
110<li><p>Move the switch next to <em>Toast compressions</em> towards right position to exclude
111Toast compressions. <strong>Note:</strong> This option is visible only for
112database server greater than or equal to 14.</p></li>
113<li><p>Move the switch next to <em>Table access methods</em> towards right position to exclude
114Table access methods. <strong>Note:</strong> This option is visible only for
115database server greater than or equal to 15.</p></li>
116</ul>
117</div></blockquote>
118</li>
119</ul>
120<img alt="Queries option on backup server dialog" class="align-center" src="_images/backup_server_queries.png" />
121<p>Click the <em>Query Options</em> tab to continue. Use these additional fields to specify
122the type of statements that should be included in the backup.</p>
123<blockquote>
124<div><ul class="simple">
125<li><p>Move the switch next to <em>Use INSERT commands</em> towards right position to
126dump the data in the form of INSERT statements rather than using a COPY
127command. Please note: this may make restoration from backup slow.</p></li>
128<li><p>Use the <em>Maximum rows per INSERT command</em> field to controls the maximum
129number of rows per INSERT command. <strong>Note:</strong> This option is visible only for
130database server greater than or equal to 12.</p></li>
131<li><p>Move the switch next to <em>On conflict do nothing to INSERT command</em> towards
132right position to add ON CONFLICT DO NOTHING to INSERT command.
133This option is not valid unless <em>Use INSERT commands</em>, <em>Use Column INSERTS</em>
134or <em>Maximum rows per INSERT command</em> is also specified.
135<strong>Note:</strong> This option is visible only for database server greater than or
136equal to 12.</p></li>
137<li><p>Move the switch next to <em>Include DROP DATABASE statement</em> towards right
138position to include a command in the backup that will drop any existing
139database object with the same name before recreating the object during a
140backup.</p></li>
141<li><p>Move the switch next to <em>Include IF EXISTS clause</em> towards right
142position to add an IF EXISTS clause to drop databases and other objects.
143This option is not valid unless <em>Include DROP DATABASE statement</em> is also set.</p></li>
144</ul>
145</div></blockquote>
146<img alt="Backup dialog tables section" class="align-center" src="_images/backup_server_table.png" />
147<p>Click the <em>Table Options</em> tab to continue. Use the fields in the <em>Table Options</em>
148tab related to tables that should be included in the backup.</p>
149<blockquote>
150<div><ul class="simple">
151<li><p>Move the switch next to <em>Use Column INSERTS</em> towards right position to dump
152the data in the form of INSERT statements and include explicit column
153names. Please note: this may make restoration from backup slow.</p></li>
154<li><p>Move the switch next to <em>Load via partition root</em> towards right position,
155so when dumping a COPY or INSERT statement for a partitioned table, target
156the root of the partitioning hierarchy which contains it rather than the
157partition itself. <strong>Note:</strong> This option is visible only for database server
158greater than or equal to 11.</p></li>
159</ul>
160</div></blockquote>
161<p>Click the <em>Options</em> tab to continue. Use the fields in the <em>Options</em>
162tab to provide other backup options.</p>
163<img alt="Disable option on backup server dialog" class="align-center" src="_images/backup_server_disable.png" />
164<ul>
165<li><p>Move switches in the <strong>Disable</strong> field box to specify the type of statements
166that should be excluded from the backup.</p>
167<blockquote>
168<div><ul class="simple">
169<li><p>Move the switch next to <em>Triggers</em> (active when creating a data-only backup)
170towards right position to include commands that will disable triggers on the
171target table while the data is being loaded.</p></li>
172<li><p>Move the switch next to <em>$ quoting</em> towards right position to enable dollar
173quoting within function bodies; if disabled, the function body will be
174quoted using SQL standard string syntax.</p></li>
175</ul>
176</div></blockquote>
177</li>
178</ul>
179<img alt="Miscellaneous option on backup server dialog" class="align-center" src="_images/backup_server_miscellaneous.png" />
180<ul>
181<li><p>Move switches in the <strong>Miscellaneous</strong> field box to specify miscellaneous
182backup options.</p>
183<blockquote>
184<div><ul class="simple">
185<li><p>Move the switch next to <em>Verbose messages</em> towards left position to instruct
186<em>pg_dumpall</em> to exclude verbose messages.</p></li>
187<li><p>Move the switch next to <em>Force double quotes on identifiers</em> towards right
188position to force the quoting of all identifiers.</p></li>
189<li><p>Move the switch next to <em>Use SET SESSION AUTHORIZATION</em> towards right
190position to include a statement that will use a SET SESSION AUTHORIZATION
191command to determine object ownership (instead of an ALTER OWNER command).</p></li>
192<li><p>Use the <em>Exclude database</em> field to not dump databases whose name matches
193pattern.</p></li>
194<li><p>Use the <em>Extra float digits</em> field to use the specified value when dumping
195floating-point data, instead of the maximum available precision.</p></li>
196<li><p>Use the <em>Lock wait timeout</em> field to do not wait forever to acquire shared
197table locks at the beginning of the dump. Instead, fail if unable to lock a
198table within the specified timeout.</p></li>
199</ul>
200</div></blockquote>
201</li>
202</ul>
203<p>When you’ve specified the details that will be incorporated into the pg_dumpall
204command:</p>
205<ul class="simple">
206<li><p>Click the <em>Backup</em> button to build and execute a command that builds a backup
207based on your selections on the <em>Backup Server</em> dialog.</p></li>
208<li><p>Click the <em>Cancel</em> button to exit without saving work.</p></li>
209</ul>
210<p>pgAdmin will run the backup process in background. You can view all the background
211process with there running status and logs on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a>
212tab</p>
213</section>
214
215
216 <div class="clearer"></div>
217 </div>
218 </div>
219 </div>
220 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
221 <div class="sphinxsidebarwrapper">
222<h3><a href="index.html">Table of Contents</a></h3>
223<ul class="current">
224<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
225<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
226<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
227<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
228<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
229<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
230<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
231<li class="toctree-l1 current"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a><ul class="current">
232<li class="toctree-l2"><a class="reference internal" href="backup_dialog.html">Backup Dialog</a></li>
233<li class="toctree-l2"><a class="reference internal" href="backup_globals_dialog.html">Backup Globals Dialog</a></li>
234<li class="toctree-l2 current"><a class="current reference internal" href="#">Backup Server Dialog</a></li>
235<li class="toctree-l2"><a class="reference internal" href="restore_dialog.html">Restore Dialog</a></li>
236</ul>
237</li>
238<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
239<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
240<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
241<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
242<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
243<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
244</ul>
245
246<search id="searchbox" style="display: none" role="search">
247 <h3 id="searchlabel">Quick search</h3>
248 <div class="searchformwrapper">
249 <form class="search" action="search.html" method="get">
250 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
251 <input type="submit" value="Go" />
252 </form>
253 </div>
254</search>
255<script>document.getElementById('searchbox').style.display = "block"</script>
256 </div>
257<div id="sidebarbutton" title="Collapse sidebar">
258<span>«</span>
259</div>
260
261 </div>
262 <div class="clearer"></div>
263 </div>
264 <div class="related" role="navigation" aria-label="related navigation">
265 <h3>Navigation</h3>
266 <ul>
267 <li class="right" style="margin-right: 10px">
268 <a href="genindex.html" title="General Index"
269 >index</a></li>
270 <li class="right" >
271 <a href="restore_dialog.html" title="Restore Dialog"
272 >next</a> |</li>
273 <li class="right" >
274 <a href="backup_globals_dialog.html" title="Backup Globals Dialog"
275 >previous</a> |</li>
276 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
277 <li class="nav-item nav-item-1"><a href="backup_and_restore.html" >Backup and Restore</a> »</li>
278 <li class="nav-item nav-item-this"><a href="">Backup Server Dialog</a></li>
279 </ul>
280 </div>
281 <div class="footer" role="contentinfo">
282 <div class="related" role="navigation" aria-label="related navigation">
283 <ul>
284 <li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
285 <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
286 <li class="right" ><a href="restore_dialog.html" title="Restore Dialog" accesskey="N">next</a> |</li>
287 <li class="right" ><a href="backup_globals_dialog.html" title="Backup Globals Dialog" accesskey="P">previous</a> |</li>
288 </ul>
289 </div>
290 </div>
291 </body>
292</html>