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>Preferences 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="Keyboard Shortcuts:" href="keyboard_shortcuts.html" />
23 <link rel="prev" title="Tree Control" href="tree_control.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="keyboard_shortcuts.html" title="Keyboard Shortcuts:"
33 accesskey="N">next</a> |</li>
34 <li class="right" >
35 <a href="tree_control.html" title="Tree Control"
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="getting_started.html" accesskey="U">Getting Started</a> »</li>
39 <li class="nav-item nav-item-this"><a href="">Preferences 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="preferences-dialog">
49<span id="preferences"></span><h1><span class="target" id="index-0"></span>Preferences Dialog<a class="headerlink" href="#preferences-dialog" title="Link to this heading">¶</a></h1>
50<p>Use options on the <em>Preferences</em> dialog to customize the behavior of the client.
51To open the <em>Preferences</em> dialog, select <em>Preferences</em> from the <em>File</em> menu.
52The left pane of the <em>Preferences</em> dialog displays a tree control; each node of
53the tree control provides access to options that are related to the node under
54which they are displayed.</p>
55<ul class="simple">
56<li><p>Use the plus sign (+) to the left of a node name to expand a segment of the
57tree control.</p></li>
58<li><p>Use the minus sign (-) to the left of a node name to close that node.</p></li>
59</ul>
60<section id="the-browser-node">
61<h2>The Browser Node<a class="headerlink" href="#the-browser-node" title="Link to this heading">¶</a></h2>
62<p>Use preferences found in the <em>Browser</em> node of the tree control to personalize
63your workspace.</p>
64<img alt="Preferences dialog browser display options" class="align-center" src="_images/preferences_browser_display.png" />
65<p>Use the fields on the <em>Display</em> panel to specify general display preferences:</p>
66<ul class="simple">
67<li><p>When the <em>Auto-expand sole children</em> switch is set to <em>True</em>, child nodes will
68be automatically expanded if a treeview node is expanded and has only a single
69child.</p></li>
70<li><p>Use the <em>Object explorer state saving interval</em> field to set the treeview state
71saving interval. A value of <em>-1</em> will disable the treeview state saving
72functionality.</p></li>
73<li><p>When the <em>Confirm before closing properties with unsaved changes</em> switch is set to <em>True</em>,
74pgAdmin will warn you before closing the properties dialog of an object if there
75are any unsaved changes. On user confirmation, the properties dialog will close.</p></li>
76<li><p>When the <em>Confirm on close or refresh</em> switch is set to <em>True</em>, pgAdmin will
77attempt to catch browser close or refresh events and prompt before allowing
78them to continue.</p></li>
79<li><p>When the <em>Hide shared servers?</em> switch is set to <em>True</em>, the client will hide
80all the shared servers from the object explorer.</p></li>
81<li><p>When the <em>Show empty object collections?</em> switch is turned off, then all object
82collections which are empty will be hidden from browser tree.</p></li>
83<li><p>When the <em>Show system objects?</em> switch is set to <em>True</em>, the client will
84display system objects such as system schemas (for example, <em>pg_temp</em>) or
85system columns (for example, <em>xmin</em> or <em>ctid</em>) in the tree control.</p></li>
86<li><p>When the <em>Show template databases?</em> switch is set to <em>True</em>, the client will
87display template databases.</p></li>
88</ul>
89<p>Use the fields on the <em>Keyboard shortcuts</em> panel to configure shortcuts for the
90main window navigation:</p>
91<img alt="Preferences dialog browser keyboard shortcuts section" class="align-center" src="_images/preferences_browser_keyboard_shortcuts.png" />
92<ul class="simple">
93<li><p>The panel displays a list of keyboard shortcuts available for the main window;
94select the combination of the modifier keys along with the key to configure
95each shortcut.</p></li>
96</ul>
97<p>Use the fields on the <em>Nodes</em> panel to select the object types that will be
98displayed in the <em>Browser</em> tree control:</p>
99<img alt="Preferences dialog browser nodes section" class="align-center" src="_images/preferences_browser_nodes.png" />
100<ul class="simple">
101<li><p>The panel displays a list of database objects; slide the switch located next
102to each object to <em>Show</em> or <em>Hide</em> the database object. When querying system
103catalogs, you can reduce the number of object types displayed to increase
104speed.</p></li>
105</ul>
106<p>Use the fields on the <em>Object Breadcrumbs</em> panel to change object breadcrumbs
107related settings:</p>
108<img alt="Preferences dialog object breadcrumbs section" class="align-center" src="_images/preferences_browser_breadcrumbs.png" />
109<ul class="simple">
110<li><p>Use <em>Enable object breadcrumbs?</em> to enable or disable object breadcrumbs
111displayed on on object mouse hover.</p></li>
112<li><p>Use <em>Show comment with object breadcrumbs?</em> to enable or disable the
113comment visibility which comes displayed with object breadcrumbs.</p></li>
114</ul>
115<p>Use the fields on the <em>Processes</em> panel to change processes tab
116related settings:</p>
117<img alt="Preferences dialog processes section" class="align-center" src="_images/preferences_browser_processes.png" />
118<ul class="simple">
119<li><p>Change <em>Process details/logs retention days</em> to the number of days,
120the process info and logs will be automatically cleared.</p></li>
121</ul>
122<p>Use fields on the <em>Properties</em> panel to specify browser properties:</p>
123<img alt="Preferences dialog browser properties section" class="align-center" src="_images/preferences_browser_properties.png" />
124<ul class="simple">
125<li><p>Include a value in the <em>Count rows if estimated less than</em> field to perform a
126SELECT count(*) if the estimated number of rows in a table (as read from the
127table statistics) is below the specified limit. After performing the SELECT
128count(*), pgAdmin will display the row count. The default is 2000.</p></li>
129<li><p>Provide a value in the <em>Maximum job history rows</em> field to limit the number of
130rows to show on the statistics tab for pgAgent jobs. The default is 250.</p></li>
131</ul>
132<p>Use field on <em>Tab settings</em> panel to specify the tab related properties.</p>
133<img alt="Preferences dialog browser properties section" class="align-center" src="_images/preferences_browser_tab_settings.png" />
134<ul class="simple">
135<li><p>Use <em>Debugger tab title placeholder</em> field to customize the Debugger tab title.</p></li>
136<li><p>When the <em>Dynamic tab size</em> If set to True, the tabs will take full size as per the title, it will also applicable for already opened tabs</p></li>
137<li><p>When the <em>Open in new browser tab</em> filed is selected for Query tool, Schema Diff or Debugger, it will
138open in a new browser tab when invoked.</p></li>
139<li><p>Use the <em>Query tool tab title placeholder</em> field to customize the query tool tab title.</p></li>
140<li><p>Use <em>View/Edit tab title placeholder</em> field to customize the View/Edit Data tab title.</p></li>
141</ul>
142</section>
143<section id="the-dashboards-node">
144<h2>The Dashboards Node<a class="headerlink" href="#the-dashboards-node" title="Link to this heading">¶</a></h2>
145<p>Expand the <em>Dashboards</em> node to specify your dashboard display preferences.</p>
146<img alt="Preferences dialog dashboard display options" class="align-center" src="_images/preferences_dashboard_display.png" />
147<ul class="simple">
148<li><p>Set the warning and alert threshold value to highlight the long-running
149queries on the dashboard.</p></li>
150<li><p>When the <em>Show activity?</em> switch is set to <em>True</em>, activity tables will be
151displayed on dashboards.</p></li>
152<li><p>When the <em>Show graphs?</em> switch is set to <em>True</em>, graphs will be displayed on
153dashboards.</p></li>
154</ul>
155<img alt="Preferences dialog dashboard refresh options" class="align-center" src="_images/preferences_dashboard_refresh.png" />
156<p>Use the fields on the <em>Refresh rates</em> panel to specify your refersh rates
157preferences for the graphs on the <em>Dashboard</em> tab:</p>
158<ul class="simple">
159<li><p>Use the <em>Block I/O statistics refresh rate</em> field to specify the number of
160seconds between block I/O statistic samples displayed in graphs.</p></li>
161<li><p>Use the <em>Session statistics refresh rate</em> field to specify the number of
162seconds between session statistic samples displayed in graphs.</p></li>
163<li><p>Use the <em>Transaction throughput refresh rate</em> field to specify the number of
164seconds between transaction throughput samples displayed in graphs.</p></li>
165<li><p>Use the <em>Tuples in refresh rate</em> field to specify the number of seconds
166between tuples-in samples displayed in graphs.</p></li>
167<li><p>Use the <em>Tuples out refresh rate</em> field to specify the number of seconds
168between tuples-out samples displayed in graphs.</p></li>
169</ul>
170</section>
171<section id="the-debugger-node">
172<h2>The Debugger Node<a class="headerlink" href="#the-debugger-node" title="Link to this heading">¶</a></h2>
173<p>Expand the <em>Debugger</em> node to specify your debugger display preferences.</p>
174<p>Use the fields on the <em>Keyboard shortcuts</em> panel to configure shortcuts for the
175debugger window navigation:</p>
176<img alt="Preferences dialog debugger keyboard shortcuts section" class="align-center" src="_images/preferences_debugger_keyboard_shortcuts.png" />
177</section>
178<section id="the-erd-tool-node">
179<h2>The ERD Tool Node<a class="headerlink" href="#the-erd-tool-node" title="Link to this heading">¶</a></h2>
180<p>Expand the <em>ERD Tool</em> node to specify your ERD Tool display preferences.</p>
181<p>Use the fields on the <em>Keyboard shortcuts</em> panel to configure shortcuts for the
182ERD Tool window navigation:</p>
183<img alt="Preferences dialog erd keyboard shortcuts section" class="align-center" src="_images/preferences_erd_keyboard_shortcuts.png" />
184<p>Use the fields on the <em>Options</em> panel to manage ERD preferences.</p>
185<img alt="Preferences dialog erd options section" class="align-center" src="_images/preferences_erd_options.png" />
186<ul class="simple">
187<li><p>When the <em>SQL With DROP Table</em> switch is set to <em>True</em>, the SQL
188generated by the ERD Tool will add DROP table DDL before each CREATE
189table DDL.</p></li>
190<li><p><em>Table Relation Depth</em> is useful when generating an ERD for a table.
191It allows to set the limit on the depth level pgAdmin should traverse
192to find the relations. Use -1 to set no limit.</p></li>
193</ul>
194</section>
195<section id="the-graphs-node">
196<h2>The Graphs Node<a class="headerlink" href="#the-graphs-node" title="Link to this heading">¶</a></h2>
197<p>Expand the <em>Graphs</em> node to specify your Graphs display preferences.</p>
198<img alt="Preferences dialog dashboard graph options" class="align-center" src="_images/preferences_dashboard_graphs.png" />
199<ul class="simple">
200<li><p>Use the <em>Chart line width</em> field to specify the width of the lines on the
201line chart.</p></li>
202<li><p>When the <em>Show graph data points?</em> switch is set to <em>True</em>, data points will
203be visible on graph lines.</p></li>
204<li><p>When the <em>Show mouse hover tooltip?</em> switch is set to <em>True</em>, a tooltip will
205appear on mouse hover on the graph lines giving the data point details.</p></li>
206<li><p>When the <em>Use different data point styles?</em> switch is set to <em>True</em>,
207data points will be visible in a different style on each graph lines.</p></li>
208</ul>
209</section>
210<section id="the-miscellaneous-node">
211<h2>The Miscellaneous Node<a class="headerlink" href="#the-miscellaneous-node" title="Link to this heading">¶</a></h2>
212<p>Expand the <em>Miscellaneous</em> node to specify miscellaneous display preferences.</p>
213<img alt="Preferences dialog user language section" class="align-center" src="_images/preferences_misc_user_language.png" />
214<ul class="simple">
215<li><p>Use the <em>User language</em> drop-down listbox to select the display language for
216the client.</p></li>
217</ul>
218<img alt="Preferences dialog themes section" class="align-center" src="_images/preferences_misc_themes.png" />
219<ul class="simple">
220<li><p>Use the <em>Themes</em> drop-down listbox to select the theme for pgAdmin. You’ll also get a preview just below the
221drop down. Note that, to apply the theme you need to refresh the pgAdmin page. You can also submit your
222own themes, check <a class="reference external" href="https://github.com/pgadmin-org/pgadmin4/blob/master/README.md">here</a> how.
223Currently we support Standard, Dark and High Contrast theme.</p></li>
224</ul>
225</section>
226<section id="the-paths-node">
227<h2>The Paths Node<a class="headerlink" href="#the-paths-node" title="Link to this heading">¶</a></h2>
228<p>Expand the <em>Paths</em> node to specify the locations of supporting utility and help
229files.</p>
230<img alt="Preferences dialog binary path section" class="align-center" src="_images/preferences_paths_binary.png" />
231<p>Use the fields on the <em>Binary paths</em> panel to specify the path to the directory
232that contains the utility programs (pg_dump, pg_dumpall, pg_restore and psql) for
233monitored databases:</p>
234<ul class="simple">
235<li><p>Use the <em>EDB Advanced Server Binary Path</em> grid to specify the location of the
236EDB Postgres Advanced Server utility programs based on the server version.
237If the respective path is not set, then pgAdmin will pick up the path for which
238‘Set as default’ is checked else pgAdmin will attempt to find the utilities in
239standard locations used by EnterpriseDB.</p></li>
240<li><p>Use the <em>PostgreSQL Binary Path</em> grid to specify the location of the
241PostgreSQL utility programs based on the server version. If the respective
242path is not set, then pgAdmin will pick up the path for which ‘Set as default’
243is checked else pgAdmin will attempt to find the utilities in standard
244locations used by PostgreSQL.</p></li>
245</ul>
246<p><strong>Note:</strong> Use the ‘Validate path’ button to check the existence of the utility
247programs (pg_dump, pg_dumpall, pg_restore and psql) and there respective versions.</p>
248<img alt="Preferences dialog binary path help section" class="align-center" src="_images/preferences_paths_help.png" />
249<p>Use the fields on the <em>Help</em> panel to specify the location of help files.</p>
250<ul class="simple">
251<li><p>Use the <em>EDB Advanced Server Help Path</em> to specify the path to EDB Postgres
252Advanced Server documentation.</p></li>
253<li><p>Use the <em>PostgreSQL Help Path</em> to specify the path to PostgreSQL
254documentation.</p></li>
255</ul>
256<p>Please note: the default help paths include the <em>VERSION</em> placeholder; the
257$VERSION$ placeholder will be replaced by the current database version.</p>
258</section>
259<section id="the-query-tool-node">
260<h2>The Query Tool Node<a class="headerlink" href="#the-query-tool-node" title="Link to this heading">¶</a></h2>
261<p>Expand the <em>Query Tool</em> node to access panels that allow you to specify your
262preferences for the Query Editor tool.</p>
263<img alt="Preferences dialog sqleditor auto completion option" class="align-center" src="_images/preferences_sql_auto_completion.png" />
264<p>Use the fields on the <em>Auto Completion</em> panel to set the auto completion options.</p>
265<ul class="simple">
266<li><p>When the <em>Autocomplete on key press</em> switch is set to <em>True</em> then autocomplete
267will be available on key press along with CTRL/CMD + Space. If it is set to
268<em>False</em> then autocomplete is only activated when CTRL/CMD + Space is pressed.</p></li>
269<li><p>When the <em>Keywords in uppercase</em> switch is set to <em>True</em> then keywords are
270shown in upper case.</p></li>
271</ul>
272<img alt="Preferences dialog sqleditor csv output option" class="align-center" src="_images/preferences_sql_csv_output.png" />
273<p>Use the fields on the <em>CSV/TXT Output</em> panel to control the CSV/TXT output.</p>
274<ul class="simple">
275<li><p>Use the <em>CSV field separator</em> drop-down listbox to specify the separator
276character that will be used in CSV/TXT output.</p></li>
277<li><p>Use the <em>CSV quote character</em> drop-down listbox to specify the quote character
278that will be used in CSV/TXT output.</p></li>
279<li><p>Use the <em>CSV quoting</em> drop-down listbox to select the fields that will be
280quoted in the CSV/TXT output; select <em>Strings</em>, <em>All</em>, or <em>None</em>.</p></li>
281<li><p>Use the <em>Replace null values with</em> option to replace null values with
282specified string in the output file. Default is set to ‘NULL’.</p></li>
283</ul>
284<img alt="Preferences dialog sqleditor display options" class="align-center" src="_images/preferences_sql_display.png" />
285<p>Use the fields on the <em>Display</em> panel to specify your preferences for the Query
286Tool display.</p>
287<ul class="simple">
288<li><p>When the <em>Connection status</em> switch is set to <em>True</em>, each new instance of the
289Query Tool will display connection and transaction status.</p></li>
290<li><p>Use the <em>Connection status refresh rate</em> field to specify the number of
291seconds between connection/transaction status updates.</p></li>
292<li><p>Use the <em>Query info notifier timeout</em> field to control the behaviour of the
293notifier that is displayed when query execution completes. A value of <em>-1</em>
294will disable the notifier, and a value of 0 will display it until clicked. If
295a positive value above zero is specified, the notifier will be displayed for
296the specified number of seconds. The default is <em>5</em>.</p></li>
297</ul>
298<img alt="Preferences dialog sqleditor editor settings" class="align-center" src="_images/preferences_sql_editor.png" />
299<p>Use the fields on the <em>Editor</em> panel to change settings of the query editor.</p>
300<ul class="simple">
301<li><p>When the <em>Brace matching?</em> switch is set to <em>True</em>, the editor will highlight
302pairs of matched braces.</p></li>
303<li><p>When the <em>Code folding?</em> switch is set to <em>False</em>, the editor will disable
304code folding. Disabling will improve editor performance with large files.</p></li>
305<li><p>Use the <em>Font size</em> field to specify the font size that will be used in text
306boxes and editors.</p></li>
307<li><p>When the <em>Insert bracket pairs?</em> switch is set to <em>True</em>, the editor will
308automatically insert paired brackets.</p></li>
309<li><p>When the <em>Line wrapping</em> switch is set to <em>True</em>, the editor will implement
310line-wrapping behavior.</p></li>
311<li><p>When the <em>Plain text mode?</em> switch is set to <em>True</em>, the editor mode will be
312changed to text/plain. Keyword highlighting and code folding will be disabled.
313This will improve editor performance with large files.</p></li>
314</ul>
315<img alt="Preferences dialog sqleditor explain options" class="align-center" src="_images/preferences_sql_explain.png" />
316<p>Use the fields on the <em>Explain</em> panel to specify the level of detail included in
317a graphical EXPLAIN.</p>
318<ul class="simple">
319<li><p>When the <em>Show buffers?</em> switch is set to <em>True</em>, graphical explain details
320will include information about buffer usage.</p></li>
321<li><p>When the <em>Show costs?</em> switch is set to <em>True</em>, graphical explain details will
322include information about the estimated startup and total cost of each plan,
323as well as the estimated number of rows and the estimated width of each row.</p></li>
324<li><p>When the <em>Show settings?</em> switch is set to <em>True</em>, graphical explain details
325will include the information on the configuration parameters.</p></li>
326<li><p>When the <em>Show summary?</em> switch is set to <em>True</em>, graphical explain details
327will include the summary information about the query plan.</p></li>
328<li><p>When the <em>Show timing?</em> switch is set to <em>True</em>, graphical explain details
329will include the startup time and time spent in each node in the output.</p></li>
330<li><p>When the <em>Show wal?</em> switch is set to <em>True</em>, graphical explain details
331will include the information on WAL record generation.</p></li>
332<li><p>When the <em>Verbose output?</em> switch is set to <em>True</em>, graphical explain details
333will include extended information about the query execution plan.</p></li>
334</ul>
335<img alt="Preferences dialog sqleditor graph visualiser section" class="align-center" src="_images/preferences_graph_visualiser.png" />
336<p>Use the fields on the <em>Graph Visualiser</em> panel to specify the settings
337related to graphs.</p>
338<ul class="simple">
339<li><p>Use the <em>Row Limit</em> field to specify the maximum number of rows that will
340be plotted on a chart.</p></li>
341</ul>
342<img alt="Preferences dialog sqleditor options section" class="align-center" src="_images/preferences_sql_options.png" />
343<p>Use the fields on the <em>Options</em> panel to manage editor preferences.</p>
344<ul class="simple">
345<li><p>When the <em>Auto commit?</em> switch is set to <em>True</em>, each successful query is
346committed after execution.</p></li>
347<li><p>When the <em>Auto rollback on error?</em> switch is set to <em>True</em>, failed queries are rolled
348back.</p></li>
349<li><p>When the <em>Copy SQL from main window to query tool?</em> switch is set to <em>True</em>,
350the CREATE sql of the selected object will be copied to query tool when query tool
351will open.</p></li>
352<li><p>When the <em>Prompt to save unsaved data changes?</em> switch is set to <em>True</em>, the
353editor will prompt the user to saved unsaved data when exiting the data
354editor.</p></li>
355<li><p>When the <em>Prompt to save unsaved query changes?</em> switch is set to <em>True</em>, the
356editor will prompt the user to saved unsaved query modifications when exiting
357the Query Tool.</p></li>
358<li><p>When the <em>Prompt to commit/rollback active transactions?</em> switch is set to
359<em>True</em>, the editor will prompt the user to commit or rollback changes when
360exiting the Query Tool while the current transaction is not committed.</p></li>
361<li><p>When the <em>Sort View Data results by primary key columns?</em> If set to <em>True</em>,
362data returned when using the View/Edit Data - All Rows option will be sorted
363by the Primary Key columns by default. When using the First/Last 100 Rows options,
364data is always sorted.</p></li>
365</ul>
366<img alt="Preferences dialog sql results grid section" class="align-center" src="_images/preferences_sql_results_grid.png" />
367<p>Use the fields on the <em>Results grid</em> panel to specify your formatting
368preferences for copied data.</p>
369<ul class="simple">
370<li><p>When the <em>Columns sized by</em> is set to <em>Column data</em>, then data columns will
371auto-size to the maximum width of the data in the column as loaded in the
372first batch. If set to <em>Column name</em>, the column will be sized to the widest
373of the data type or column name.</p></li>
374<li><p>Specify the maximum width of the column in pixels when ‘Columns sized by’ is
375set to <em>Column data</em>. If ‘Columns sized by’ is set to <em>Column name</em> then this
376setting won’t have any effect.</p></li>
377<li><p>Specify the number of records to fetch in one batch in query tool when
378query result set is large. Changing this value will override
379ON_DEMAND_ROW_COUNT setting from config file.</p></li>
380<li><p>Use the <em>Result copy field separator</em> drop-down listbox to select the field
381separator for copied data.</p></li>
382<li><p>Use the <em>Result copy quote character</em> drop-down listbox to select the quote
383character for copied data.</p></li>
384<li><p>Use the <em>Result copy quoting</em> drop-down listbox to select which type of fields
385require quoting; select <em>All</em>, <em>None</em>, or <em>Strings</em>.</p></li>
386</ul>
387<img alt="Preferences dialog sql keyboard shortcuts section" class="align-center" src="_images/preferences_sql_keyboard_shortcuts.png" />
388<p>Use the fields on the <em>Keyboard shortcuts</em> panel to configure shortcuts for the
389Query Tool window navigation:</p>
390<img alt="Preferences dialog SQL Formatting section" class="align-center" src="_images/preferences_sql_formatting.png" />
391<p>Use the fields on the <em>SQL formatting</em> panel to specify your preferences for
392reformatting of SQL.</p>
393<ul class="simple">
394<li><p>Use the <em>Data type case</em> option to specify whether to change data types
395into upper, lower, or preserve case.</p></li>
396<li><p>Use the <em>Expression width</em> option to specify maximum number of characters
397in parenthesized expressions to be kept on single line.</p></li>
398<li><p>Use the <em>Function case</em> option to specify whether to change function
399names into upper, lower, or preserve case.</p></li>
400<li><p>Use the <em>Identifier case</em> option to specify whether to change identifiers
401(object names) into upper, lower, or capitalized case.</p></li>
402<li><p>Use the <em>Keyword case</em> option to specify whether to change keywords into
403upper, lower, or preserve case.</p></li>
404<li><p>Use <em>Lines between queries</em> to specify how many empty lines to leave
405between SQL statements. If set to zero it puts no new line.</p></li>
406<li><p>Use <em>Logical operator new line</em> to specify newline placement before or
407after logical operators (AND, OR, XOR).</p></li>
408<li><p>Use <em>New line before semicolon?</em> to specify whether to place query
409separator (;) on a separate line.</p></li>
410<li><p>Use the <em>Spaces around operators?</em> option to specify whether or not to include
411spaces on either side of operators.</p></li>
412<li><p>Use the <em>Tab size</em> option to specify the number of spaces per tab or indent.</p></li>
413<li><p>Use the <em>Use spaces?</em> option to select whether to use spaces or tabs when
414indenting.</p></li>
415</ul>
416</section>
417<section id="the-schema-diff-node">
418<h2>The Schema Diff Node<a class="headerlink" href="#the-schema-diff-node" title="Link to this heading">¶</a></h2>
419<p>Expand the <em>Schema Diff</em> node to specify your display preferences.</p>
420<img alt="Preferences schema diff" class="align-center" src="_images/preferences_schema_diff.png" />
421<p>Use the <em>Ignore Grant/Revoke</em> switch to ignores the grant and revoke command while comparing the objects.</p>
422<p>Use the <em>Ignore Owner</em> switch to ignores the owner while comparing the objects.</p>
423<p>Use the <em>Ignore Tablespace</em> switch to ignores the tablespace while comparing the objects.</p>
424<p>Use the <em>Ignore Whitespace</em> switch to ignores the whitespace while comparing
425the string objects. Whitespace includes space, tabs, and CRLF.</p>
426</section>
427<section id="the-storage-node">
428<h2>The Storage Node<a class="headerlink" href="#the-storage-node" title="Link to this heading">¶</a></h2>
429<p>Expand the <em>Storage</em> node to specify your storage preferences.</p>
430<img alt="Preferences dialog storage section" class="align-center" src="_images/preferences_storage_options.png" />
431<p>Use the fields on the <em>Options</em> panel to specify storage preferences.</p>
432<ul class="simple">
433<li><p>Use the <em>File dialog view</em> drop-down listbox to select the style of icons and
434display format that will be displayed when you open the file manager; select
435<em>List</em> to display a list view, or <em>Grid</em> to display folder icons.</p></li>
436<li><p>Use the <em>Last directory visited</em> field to specify the name of the folder in
437which the file manager will open.</p></li>
438<li><p>Use the <em>Maximum file upload size(MB)</em> field on the <em>Options</em> panel of the
439<strong>Storage</strong> node to specify the maximum file size for an upload.</p></li>
440<li><p>When the <em>Show hidden files and folders?</em> switch is set to <em>True</em>, the file
441manager will display hidden files and folders.</p></li>
442</ul>
443<section id="using-setup-py-command-line-script">
444<h3>Using ‘setup.py’ command line script<a class="headerlink" href="#using-setup-py-command-line-script" title="Link to this heading">¶</a></h3>
445<div class="admonition note">
446<p class="admonition-title">Note</p>
447<p>To manage preferences using <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> script, you must use
448the Python interpreter that is normally used to run pgAdmin to ensure
449that the required Python packages are available. In most packages, this
450can be found in the Python Virtual Environment that can be found in the
451installation directory. When using platform-native packages, the system
452installation of Python may be the one used by pgAdmin.</p>
453</div>
454</section>
455</section>
456<section id="manage-preferences">
457<h2>Manage Preferences<a class="headerlink" href="#manage-preferences" title="Link to this heading">¶</a></h2>
458</section>
459<section id="get-preferences">
460<h2>Get Preferences<a class="headerlink" href="#get-preferences" title="Link to this heading">¶</a></h2>
461<p>To get all the preferences listed, invoke <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with <code class="docutils literal notranslate"><span class="pre">get-prefs</span></code> command line option.
462You can also get this mapping by hovering the individual preference in the Preference UI dialog.</p>
463<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/path/to/python<span class="w"> </span>/path/to/setup.py<span class="w"> </span>get-prefs
464</pre></div>
465</div>
466</section>
467<section id="save-preferences">
468<h2>Save Preferences<a class="headerlink" href="#save-preferences" title="Link to this heading">¶</a></h2>
469<p>To save the preferences, invoke <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with <code class="docutils literal notranslate"><span class="pre">set-prefs</span></code> command line option, followed by username,
470preference_key=value and auth_source. Multiple preference can be given too by a space separated.
471If auth_source is not given, Internal authentication will be consider by default.</p>
472<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/path/to/python<span class="w"> </span>/path/to/setup.py<span class="w"> </span>set-prefs<span class="w"> </span>user1@gmail.com<span class="w"> </span>sqleditor:editor:comma_first<span class="o">=</span><span class="nb">true</span>
473
474<span class="c1"># To specify multiple preferences options</span>
475/path/to/python<span class="w"> </span>/path/to/setup.py<span class="w"> </span>set-prefs<span class="w"> </span>user1@gmail.com<span class="w"> </span>sqleditor:editor:comma_first<span class="o">=</span><span class="nb">true</span><span class="w"> </span>sqleditor:keyboard_shortcuts:toggle_case<span class="o">=</span><span class="nb">true</span>
476
477<span class="c1"># to specify an auth_source</span>
478/path/to/python<span class="w"> </span>/path/to/setup.py<span class="w"> </span>set-prefs<span class="w"> </span>user1@gmail.com<span class="w"> </span>sqleditor:editor:comma_first<span class="o">=</span><span class="nb">true</span><span class="w"> </span>--auth-source<span class="o">=</span>ldap
479</pre></div>
480</div>
481</section>
482<section id="updating-preferences-preferences-json">
483<h2>Updating Preferences preferences.json<a class="headerlink" href="#updating-preferences-preferences-json" title="Link to this heading">¶</a></h2>
484<p>To update preferences defined in json file, simply run <code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">``</span> <span class="pre">with</span> <span class="pre">``set-prefs</span></code> command followed by username
485and JSON file containing the preferences.</p>
486<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/path/to/python<span class="w"> </span>/path/to/setup.py<span class="w"> </span>set-prefs<span class="w"> </span>user1@gmail.com<span class="w"> </span>--input-file<span class="w"> </span>/Users/yogeshmahajan/Desktop/pref.json
487</pre></div>
488</div>
489</section>
490<section id="json-format">
491<h2>JSON format<a class="headerlink" href="#json-format" title="Link to this heading">¶</a></h2>
492<p>The JSON file simply contains preference_key=value. Preference key value mapping can be obtained by hovering the
493individual preference in the Preference UI dialog.</p>
494<p>The following is an typical example for preferences.json :</p>
495<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
496 <span class="s2">"preferences"</span><span class="p">:</span>
497 <span class="p">{</span>
498 <span class="s2">"browser:display:show_system_objects"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
499 <span class="s2">"browser:display:show_user_defined_templates"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
500 <span class="s2">"browser:display:confirm_on_refresh_close"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
501 <span class="s2">"misc:themes:theme"</span><span class="p">:</span> <span class="s2">"dark"</span><span class="p">,</span>
502
503 <span class="p">}</span>
504<span class="p">}</span>
505</pre></div>
506</div>
507</section>
508</section>
509
510
511 <div class="clearer"></div>
512 </div>
513 </div>
514 </div>
515 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
516 <div class="sphinxsidebarwrapper">
517 <div>
518 <h3><a href="index.html">Table of Contents</a></h3>
519 <ul>
520<li><a class="reference internal" href="#">Preferences Dialog</a><ul>
521<li><a class="reference internal" href="#the-browser-node">The Browser Node</a></li>
522<li><a class="reference internal" href="#the-dashboards-node">The Dashboards Node</a></li>
523<li><a class="reference internal" href="#the-debugger-node">The Debugger Node</a></li>
524<li><a class="reference internal" href="#the-erd-tool-node">The ERD Tool Node</a></li>
525<li><a class="reference internal" href="#the-graphs-node">The Graphs Node</a></li>
526<li><a class="reference internal" href="#the-miscellaneous-node">The Miscellaneous Node</a></li>
527<li><a class="reference internal" href="#the-paths-node">The Paths Node</a></li>
528<li><a class="reference internal" href="#the-query-tool-node">The Query Tool Node</a></li>
529<li><a class="reference internal" href="#the-schema-diff-node">The Schema Diff Node</a></li>
530<li><a class="reference internal" href="#the-storage-node">The Storage Node</a><ul>
531<li><a class="reference internal" href="#using-setup-py-command-line-script">Using ‘setup.py’ command line script</a></li>
532</ul>
533</li>
534<li><a class="reference internal" href="#manage-preferences">Manage Preferences</a></li>
535<li><a class="reference internal" href="#get-preferences">Get Preferences</a></li>
536<li><a class="reference internal" href="#save-preferences">Save Preferences</a></li>
537<li><a class="reference internal" href="#updating-preferences-preferences-json">Updating Preferences preferences.json</a></li>
538<li><a class="reference internal" href="#json-format">JSON format</a></li>
539</ul>
540</li>
541</ul>
542
543 </div>
544<h3><a href="index.html">Table of Contents</a></h3>
545<ul class="current">
546<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
547<li class="toctree-l2"><a class="reference internal" href="deployment.html">Deployment</a></li>
548<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
549<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
550<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
551<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
552<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
553<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
554<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
555<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
556<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
557<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
558<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
559<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
560<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
561<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
562<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
563<li class="toctree-l2 current"><a class="current reference internal" href="#">Preferences Dialog</a></li>
564<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
565<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
566</ul>
567</li>
568<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
569<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
570<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
571<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
572<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
573<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
574<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
575<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
576<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
577<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
578<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
579<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
580<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
581</ul>
582
583<search id="searchbox" style="display: none" role="search">
584 <h3 id="searchlabel">Quick search</h3>
585 <div class="searchformwrapper">
586 <form class="search" action="search.html" method="get">
587 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
588 <input type="submit" value="Go" />
589 </form>
590 </div>
591</search>
592<script>document.getElementById('searchbox').style.display = "block"</script>
593 </div>
594<div id="sidebarbutton" title="Collapse sidebar">
595<span>«</span>
596</div>
597
598 </div>
599 <div class="clearer"></div>
600 </div>
601 <div class="related" role="navigation" aria-label="related navigation">
602 <h3>Navigation</h3>
603 <ul>
604 <li class="right" style="margin-right: 10px">
605 <a href="genindex.html" title="General Index"
606 >index</a></li>
607 <li class="right" >
608 <a href="keyboard_shortcuts.html" title="Keyboard Shortcuts:"
609 >next</a> |</li>
610 <li class="right" >
611 <a href="tree_control.html" title="Tree Control"
612 >previous</a> |</li>
613 <li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
614 <li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
615 <li class="nav-item nav-item-this"><a href="">Preferences Dialog</a></li>
616 </ul>
617 </div>
618 <div class="footer" role="contentinfo">
619 <div class="related" role="navigation" aria-label="related navigation">
620 <ul>
621 <li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
622 <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
623 <li class="right" ><a href="keyboard_shortcuts.html" title="Keyboard Shortcuts:" accesskey="N">next</a> |</li>
624 <li class="right" ><a href="tree_control.html" title="Tree Control" accesskey="P">previous</a> |</li>
625 </ul>
626 </div>
627 </div>
628 </body>
629</html>