mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2025-02-10 23:45:58 -06:00
695 lines
21 KiB
Python
695 lines
21 KiB
Python
##########################################################################
|
|
#
|
|
# pgAdmin 4 - PostgreSQL Tools
|
|
#
|
|
# Copyright (C) 2013 - 2019, The pgAdmin Development Team
|
|
# This software is released under the PostgreSQL Licence
|
|
#
|
|
##########################################################################
|
|
|
|
"""Register preferences for query tool"""
|
|
from flask_babelex import gettext
|
|
from pgadmin.utils import SHORTCUT_FIELDS as shortcut_fields, \
|
|
ACCESSKEY_FIELDS as accesskey_fields
|
|
from pgadmin.utils.preferences import Preferences
|
|
|
|
|
|
def RegisterQueryToolPreferences(self):
|
|
self.info_notifier_timeout = self.preference.register(
|
|
'display', 'info_notifier_timeout',
|
|
gettext("Query info notifier timeout"), 'integer', 5,
|
|
category_label=gettext('Display'),
|
|
min_val=-1,
|
|
max_val=999999,
|
|
help_str=gettext(
|
|
'The length of time to display the query info notifier after '
|
|
'execution has completed. A value of -1 disables the notifier'
|
|
' and a value of 0 displays it until clicked. Values greater'
|
|
' than 0 display the notifier for the number of seconds'
|
|
' specified.'
|
|
)
|
|
)
|
|
|
|
self.open_in_new_tab = self.preference.register(
|
|
'display', 'new_browser_tab',
|
|
gettext("Open in new browser tab"), 'boolean', False,
|
|
category_label=gettext('Display'),
|
|
help_str=gettext('If set to True, the Query Tool '
|
|
'will be opened in a new browser tab.')
|
|
)
|
|
|
|
self.explain_verbose = self.preference.register(
|
|
'Explain', 'explain_verbose',
|
|
gettext("Verbose output?"), 'boolean', False,
|
|
category_label=gettext('Explain')
|
|
)
|
|
|
|
self.explain_costs = self.preference.register(
|
|
'Explain', 'explain_costs',
|
|
gettext("Show costs?"), 'boolean', False,
|
|
category_label=gettext('Explain')
|
|
)
|
|
|
|
self.explain_buffers = self.preference.register(
|
|
'Explain', 'explain_buffers',
|
|
gettext("Show buffers?"), 'boolean', False,
|
|
category_label=gettext('Explain')
|
|
)
|
|
|
|
self.explain_timing = self.preference.register(
|
|
'Explain', 'explain_timing',
|
|
gettext("Show timing?"), 'boolean', False,
|
|
category_label=gettext('Explain')
|
|
)
|
|
|
|
self.explain_summary = self.preference.register(
|
|
'Explain', 'explain_summary',
|
|
gettext("Show summary?"), 'boolean', False,
|
|
category_label=gettext('Explain')
|
|
)
|
|
|
|
self.explain_settings = self.preference.register(
|
|
'Explain', 'explain_settings',
|
|
gettext("Show settings?"), 'boolean', False,
|
|
category_label=gettext('Explain')
|
|
)
|
|
|
|
self.auto_commit = self.preference.register(
|
|
'Options', 'auto_commit',
|
|
gettext("Auto commit?"), 'boolean', True,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext('Set auto commit on or off by default in new Query '
|
|
'Tool tabs.')
|
|
)
|
|
|
|
self.auto_rollback = self.preference.register(
|
|
'Options', 'auto_rollback',
|
|
gettext("Auto rollback?"), 'boolean', False,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext('Set auto rollback on or off by default in new Query '
|
|
'Tool tabs.')
|
|
)
|
|
|
|
self.show_prompt_save_query_changes = self.preference.register(
|
|
'Options', 'prompt_save_query_changes',
|
|
gettext("Prompt to save unsaved query changes?"), 'boolean', True,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to prompt user to save unsaved '
|
|
'query on query tool exit.'
|
|
)
|
|
)
|
|
|
|
self.show_prompt_save_data_changes = self.preference.register(
|
|
'Options', 'prompt_save_data_changes',
|
|
gettext("Prompt to save unsaved data changes?"), 'boolean', True,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to prompt user to save unsaved '
|
|
'data on data grid exit.'
|
|
)
|
|
)
|
|
|
|
self.show_prompt_commit_transaction = self.preference.register(
|
|
'Options', 'prompt_commit_transaction',
|
|
gettext("Prompt to commit/rollback active transactions?"), 'boolean',
|
|
True,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to prompt user to commit or rollback '
|
|
'an active transaction on Query Tool exit.'
|
|
)
|
|
)
|
|
|
|
self.sql_font_size = self.preference.register(
|
|
'Editor', 'plain_editor_mode',
|
|
gettext("Plain text mode?"), 'boolean', False,
|
|
category_label=gettext('Editor'),
|
|
help_str=gettext(
|
|
'When set to True, keywords won''t be highlighted and code '
|
|
'folding will be disabled. Plain text mode will improve editor '
|
|
'performance with large files.'
|
|
)
|
|
)
|
|
|
|
self.sql_font_size = self.preference.register(
|
|
'Editor', 'code_folding',
|
|
gettext("Code folding?"), 'boolean', True,
|
|
category_label=gettext('Editor'),
|
|
help_str=gettext(
|
|
'Enable or disable code folding. In plain text mode, this will '
|
|
'have no effect as code folding is always disabled in that mode. '
|
|
'Disabling will improve editor performance with large files.'
|
|
)
|
|
)
|
|
|
|
self.sql_font_size = self.preference.register(
|
|
'Editor', 'sql_font_size',
|
|
gettext("Font size"), 'numeric', '1',
|
|
min_val=0.1,
|
|
max_val=10,
|
|
category_label=gettext('Display'),
|
|
help_str=gettext(
|
|
'The font size to use for the SQL text boxes and editors. '
|
|
'The value specified is in "em" units, in which 1 is the '
|
|
'default relative font size. For example, to increase the '
|
|
'font size by 20 percent use a value of 1.2, or to reduce '
|
|
'by 20 percent, use a value of 0.8. Minimum 0.1, maximum 10.'
|
|
)
|
|
)
|
|
|
|
self.tab_size = self.preference.register(
|
|
'Editor', 'tab_size',
|
|
gettext("Tab size"), 'integer', 4,
|
|
min_val=2,
|
|
max_val=8,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'The number of spaces per tab. Minimum 2, maximum 8.'
|
|
)
|
|
)
|
|
|
|
self.use_spaces = self.preference.register(
|
|
'Editor', 'use_spaces',
|
|
gettext("Use spaces?"), 'boolean', False,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to insert spaces instead of tabs '
|
|
'when the tab key or auto-indent are used.'
|
|
)
|
|
)
|
|
|
|
self.wrap_code = self.preference.register(
|
|
'Editor', 'wrap_code',
|
|
gettext("Line wrapping?"), 'boolean', False,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to wrap SQL code in the editor.'
|
|
)
|
|
)
|
|
|
|
self.insert_pair_brackets = self.preference.register(
|
|
'Editor', 'insert_pair_brackets',
|
|
gettext("Insert bracket pairs?"), 'boolean', True,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to insert paired brackets in the '
|
|
'editor.'
|
|
)
|
|
)
|
|
|
|
self.brace_matching = self.preference.register(
|
|
'Editor', 'brace_matching',
|
|
gettext("Brace matching?"), 'boolean', True,
|
|
category_label=gettext('Options'),
|
|
help_str=gettext(
|
|
'Specifies whether or not to highlight matched braces '
|
|
'in the editor.'
|
|
)
|
|
)
|
|
|
|
self.csv_quoting = self.preference.register(
|
|
'CSV_output', 'csv_quoting',
|
|
gettext("CSV quoting"), 'options', 'strings',
|
|
category_label=gettext('CSV Output'),
|
|
options=[{'label': 'None', 'value': 'none'},
|
|
{'label': 'All', 'value': 'all'},
|
|
{'label': 'Strings', 'value': 'strings'}],
|
|
select2={
|
|
'allowClear': False,
|
|
'tags': False
|
|
}
|
|
)
|
|
|
|
self.csv_quote_char = self.preference.register(
|
|
'CSV_output', 'csv_quote_char',
|
|
gettext("CSV quote character"), 'options', '"',
|
|
category_label=gettext('CSV Output'),
|
|
options=[{'label': '"', 'value': '"'},
|
|
{'label': '\'', 'value': '\''}],
|
|
select2={
|
|
'allowClear': False,
|
|
'tags': True
|
|
}
|
|
)
|
|
|
|
self.csv_field_separator = self.preference.register(
|
|
'CSV_output', 'csv_field_separator',
|
|
gettext("CSV field separator"), 'options', ',',
|
|
category_label=gettext('CSV output'),
|
|
options=[{'label': ';', 'value': ';'},
|
|
{'label': ',', 'value': ','},
|
|
{'label': '|', 'value': '|'},
|
|
{'label': 'Tab', 'value': '\t'}],
|
|
select2={
|
|
'allowClear': False,
|
|
'tags': True
|
|
}
|
|
)
|
|
|
|
self.replace_nulls_with = self.preference.register(
|
|
'CSV_output', 'csv_replace_nulls_with',
|
|
gettext("Replace null values with"), 'text', 'NULL',
|
|
category_label=gettext('CSV output'),
|
|
help_str=gettext('Specifies the string that represents a null value '
|
|
'while downloading query results as CSV. You can '
|
|
'specify any arbitrary string to represent a '
|
|
'null value, with quotes if desired.'),
|
|
allow_blanks=True
|
|
)
|
|
|
|
self.results_grid_quoting = self.preference.register(
|
|
'Results_grid', 'results_grid_quoting',
|
|
gettext("Result copy quoting"), 'options', 'strings',
|
|
category_label=gettext('Results grid'),
|
|
options=[{'label': 'None', 'value': 'none'},
|
|
{'label': 'All', 'value': 'all'},
|
|
{'label': 'Strings', 'value': 'strings'}],
|
|
select2={
|
|
'allowClear': False,
|
|
'tags': False
|
|
}
|
|
)
|
|
|
|
self.results_grid_quote_char = self.preference.register(
|
|
'Results_grid', 'results_grid_quote_char',
|
|
gettext("Result copy quote character"), 'options', '"',
|
|
category_label=gettext('Results grid'),
|
|
options=[{'label': '"', 'value': '"'},
|
|
{'label': '\'', 'value': '\''}],
|
|
select2={
|
|
'allowClear': False,
|
|
'tags': True
|
|
}
|
|
)
|
|
|
|
self.results_grid_field_separator = self.preference.register(
|
|
'Results_grid', 'results_grid_field_separator',
|
|
gettext("Result copy field separator"), 'options', '\t',
|
|
category_label=gettext('Results grid'),
|
|
options=[{'label': ';', 'value': ';'},
|
|
{'label': ',', 'value': ','},
|
|
{'label': '|', 'value': '|'},
|
|
{'label': 'Tab', 'value': '\t'}],
|
|
select2={
|
|
'allowClear': False,
|
|
'tags': True
|
|
}
|
|
)
|
|
|
|
self.display_connection_status = self.preference.register(
|
|
'display', 'connection_status',
|
|
gettext("Connection status"), 'boolean', True,
|
|
category_label=gettext('Display'),
|
|
help_str=gettext('If set to True, the Query Tool '
|
|
'will monitor and display the connection and '
|
|
'transaction status.')
|
|
)
|
|
|
|
self.connection_status = self.preference.register(
|
|
'display', 'connection_status_fetch_time',
|
|
gettext("Connection status refresh rate"), 'integer', 2,
|
|
min_val=1, max_val=600,
|
|
category_label=gettext('Display'),
|
|
help_str=gettext(
|
|
'The number of seconds between connection/transaction '
|
|
'status polls.'
|
|
)
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'execute_query',
|
|
gettext('Execute query'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': False,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 116,
|
|
'char': 'F5'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'save_data',
|
|
gettext('Save data changes'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': False,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 117,
|
|
'char': 'F6'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'explain_query',
|
|
gettext('EXPLAIN query'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': False,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 118,
|
|
'char': 'F7'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'explain_analyze_query',
|
|
gettext('EXPLAIN ANALYZE query'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 118,
|
|
'char': 'F7'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'download_csv',
|
|
gettext('Download CSV'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': False,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 119,
|
|
'char': 'F8'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'move_previous',
|
|
gettext('Previous tab'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 219,
|
|
'char': '['
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'move_next',
|
|
gettext('Next tab'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 221,
|
|
'char': ']'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'switch_panel',
|
|
gettext('Switch Panel'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': True,
|
|
'shift': True,
|
|
'control': False,
|
|
'key': {
|
|
'key_code': 9,
|
|
'char': 'Tab'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
# All about access keys
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_open_file',
|
|
gettext('Accesskey (Open file)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 79,
|
|
'char': 'o'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_save_file',
|
|
gettext('Accesskey (Save file)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 83,
|
|
'char': 's'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_copy_row',
|
|
gettext('Accesskey (Copy rows)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 67,
|
|
'char': 'c'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_paste_row',
|
|
gettext('Accesskey (Paste rows)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 80,
|
|
'char': 'p'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_delete_row',
|
|
gettext('Accesskey (Delete rows)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 68,
|
|
'char': 'd'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_filter_dialog',
|
|
gettext('Accesskey (Filter dialog)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 70,
|
|
'char': 'f'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_filter_options',
|
|
gettext('Accesskey (Filter options)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 73,
|
|
'char': 'i'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_rows_limit',
|
|
gettext('Accesskey (Rows limit)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 82,
|
|
'char': 'r'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_execute_options',
|
|
gettext('Accesskey (Execute options)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 88,
|
|
'char': 'x'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_cancel_query',
|
|
gettext('Accesskey (Cancel query)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 81,
|
|
'char': 'q'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_clear_options',
|
|
gettext('Accesskey (Clear editor options)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 76,
|
|
'char': 'l'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_conn_status',
|
|
gettext('Accesskey (Connection status)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 84,
|
|
'char': 't'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts', 'btn_find_options',
|
|
gettext('Accesskey (Find options)'), 'keyboardshortcut',
|
|
{
|
|
'key': {
|
|
'key_code': 78,
|
|
'char': 'n'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=accesskey_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'toggle_case',
|
|
gettext('Toggle case of selected text'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {
|
|
'key_code': 85,
|
|
'char': 'u'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'auto_completion', 'keywords_in_uppercase',
|
|
gettext("Keywords in uppercase"), 'boolean', True,
|
|
category_label=gettext('Auto completion'),
|
|
help_str=gettext('If set to True, Keywords will be displayed '
|
|
'in upper case for auto completion.')
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'commit_transaction',
|
|
gettext('Commit'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {
|
|
'key_code': 77,
|
|
'char': 'm'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|
|
|
|
self.preference.register(
|
|
'keyboard_shortcuts',
|
|
'rollback_transaction',
|
|
gettext('Rollback'),
|
|
'keyboardshortcut',
|
|
{
|
|
'alt': False,
|
|
'shift': True,
|
|
'control': True,
|
|
'key': {
|
|
'key_code': 82,
|
|
'char': 'r'
|
|
}
|
|
},
|
|
category_label=gettext('Keyboard shortcuts'),
|
|
fields=shortcut_fields
|
|
)
|