Files
pgadmin4/web/pgadmin/tools/sqleditor/utils/query_tool_preferences.py
T

813 lines
26 KiB
Python

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2025, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################
"""Register preferences for query tool"""
from flask_babel import gettext
from pgadmin.utils.constants import PREF_LABEL_DISPLAY,\
PREF_LABEL_KEYBOARD_SHORTCUTS, PREF_LABEL_EXPLAIN, PREF_LABEL_OPTIONS,\
PREF_LABEL_CSV_TXT, PREF_LABEL_RESULTS_GRID,\
PREF_LABEL_GRAPH_VISUALISER
from pgadmin.utils import SHORTCUT_FIELDS as shortcut_fields
from config import DATA_RESULT_ROWS_PER_PAGE
def register_query_tool_preferences(self):
self.explain_verbose = self.preference.register(
'Explain', 'explain_verbose',
gettext("Verbose output?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.explain_costs = self.preference.register(
'Explain', 'explain_costs',
gettext("Show costs?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.explain_buffers = self.preference.register(
'Explain', 'explain_buffers',
gettext("Show buffers?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.explain_timing = self.preference.register(
'Explain', 'explain_timing',
gettext("Show timing?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.explain_summary = self.preference.register(
'Explain', 'explain_summary',
gettext("Show summary?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.explain_settings = self.preference.register(
'Explain', 'explain_settings',
gettext("Show settings?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.explain_wal = self.preference.register(
'Explain', 'explain_wal',
gettext("Show wal?"), 'boolean', False,
category_label=PREF_LABEL_EXPLAIN
)
self.auto_commit = self.preference.register(
'Options', 'auto_commit',
gettext("Auto commit?"), 'boolean', True,
category_label=PREF_LABEL_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 on error?"), 'boolean', False,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext('Set auto rollback on or off by default in new Query '
'Tool tabs.')
)
self.server_cursor = self.preference.register(
'Options', 'server_cursor',
gettext("Use server cursor?"), 'boolean', False,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext('If set to True, the dataset will be fetched using a'
' server-side cursor after the query is executed.'
' This allows controlled data transfer to the client,'
' enabling examination of large datasets without'
' loading them entirely into memory.')
)
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=PREF_LABEL_OPTIONS,
help_str=gettext(
'Specifies whether or not to prompt user to save unsaved '
'query on query tool exit.'
)
)
self.table_view_data_by_pk = self.preference.register(
'Options', 'table_view_data_by_pk',
gettext("Sort View Data results by primary key columns?"),
'boolean', True,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext("If set to True, data returned when using the "
"View/Edit Data - All Rows option will be sorted by "
"the Primary Key columns by default. When using the "
"First/Last 100 Rows options, data is always sorted.")
)
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=PREF_LABEL_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=PREF_LABEL_OPTIONS,
help_str=gettext(
'Specifies whether or not to prompt user to commit or rollback '
'an active transaction on Query Tool exit.'
)
)
self.copy_sql_to_query_tool = self.preference.register(
'Options', 'copy_sql_to_query_tool',
gettext("Copy SQL from main window to query tool?"), 'boolean',
False,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext(
'Specifies whether or not to copy SQL to query tool from '
'main window.'
)
)
self.open_file_in_new_tab = self.preference.register(
'Options', 'open_in_new_tab',
gettext("Open the file in a new tab?"), 'boolean',
False,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext(
'Specifies whether or not to open the file in a new tab.'
)
)
self.view_edit_promotion_warning = self.preference.register(
'Options', 'view_edit_promotion_warning',
gettext("Show View/Edit Data Promotion Warning?"),
'boolean', True,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext(
'If set to True, View/Edit Data tool will show promote to '
'Query tool confirm dialog on query edit.'
)
)
self.underline_query_cursor = self.preference.register(
'Options', 'underline_query_cursor',
gettext("Underline query at cursor?"),
'boolean', False,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext(
'If set to True, query tool will parse and underline '
'the query at the cursor position.'
)
)
self.underlined_query_execute_warning = self.preference.register(
'Options', 'underlined_query_execute_warning',
gettext("Underlined query execute warning?"),
'boolean', True,
category_label=PREF_LABEL_OPTIONS,
help_str=gettext(
'If set to True, query tool will warn upon clicking the '
'Execute Query button in the query tool. The warning will '
'appear only if Underline query at cursor? is set to False.'
)
)
self.csv_quoting = self.preference.register(
'CSV_output', 'csv_quoting',
gettext("CSV quoting"), 'options', 'strings',
category_label=PREF_LABEL_CSV_TXT,
options=[{'label': gettext('None'), 'value': 'none'},
{'label': gettext('All'), 'value': 'all'},
{'label': gettext('Strings'), 'value': 'strings'}],
control_props={
'allowClear': False,
'tags': False
}
)
self.csv_quote_char = self.preference.register(
'CSV_output', 'csv_quote_char',
gettext("CSV quote character"), 'options', '"',
category_label=PREF_LABEL_CSV_TXT,
options=[{'label': '"', 'value': '"'},
{'label': '\'', 'value': '\''}],
control_props={
'allowClear': False,
'tags': False,
'creatable': True,
'maxLength': 1
}
)
self.csv_field_separator = self.preference.register(
'CSV_output', 'csv_field_separator',
gettext("CSV field separator"), 'options', ',',
category_label=PREF_LABEL_CSV_TXT,
options=[{'label': ';', 'value': ';'},
{'label': ',', 'value': ','},
{'label': '|', 'value': '|'},
{'label': gettext('Tab'), 'value': '\t'}],
control_props={
'allowClear': False,
'tags': False,
'creatable': True,
'maxLength': 1
}
)
self.replace_nulls_with = self.preference.register(
'CSV_output', 'csv_replace_nulls_with',
gettext("Replace null values with"), 'text', 'NULL',
category_label=PREF_LABEL_CSV_TXT,
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=PREF_LABEL_RESULTS_GRID,
options=[{'label': gettext('None'), 'value': 'none'},
{'label': gettext('All'), 'value': 'all'},
{'label': gettext('Strings'), 'value': 'strings'}],
control_props={
'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=PREF_LABEL_RESULTS_GRID,
options=[{'label': '"', 'value': '"'},
{'label': '\'', 'value': '\''}],
control_props={
'allowClear': False,
'tags': False
}
)
self.results_grid_field_separator = self.preference.register(
'Results_grid', 'results_grid_field_separator',
gettext("Result copy field separator"), 'options', '\t',
category_label=PREF_LABEL_RESULTS_GRID,
options=[{'label': ';', 'value': ';'},
{'label': ',', 'value': ','},
{'label': '|', 'value': '|'},
{'label': gettext('Tab'), 'value': '\t'}],
control_props={
'allowClear': False,
'tags': False
}
)
self.column_data_auto_resize = self.preference.register(
'Results_grid', 'column_data_auto_resize',
gettext("Columns sized by"), 'radioModern', 'by_data',
options=[{'label': gettext('Column data'), 'value': 'by_data'},
{'label': gettext('Column name'), 'value': 'by_name'}],
category_label=PREF_LABEL_RESULTS_GRID,
help_str=gettext(
'If set to \'Column data\' columns will auto-size to the maximum '
'width of the data in the column as loaded in the first batch. If '
'set to \'Column name\', the column will be sized to the widest '
'of the data type or column name.'
),
dependents=['column_data_max_width']
)
self.column_data_max_width = self.preference.register(
'Results_grid', 'column_data_max_width',
gettext("Maximum column width"), 'integer', 0,
category_label=PREF_LABEL_RESULTS_GRID,
help_str=gettext(
'Specify the maximum width of the column in pixels when '
'\'Columns sized by \' is set to \'Column data\'.'
),
)
self.data_result_rows_per_page = self.preference.register(
'Results_grid', 'data_result_rows_per_page',
gettext("Data result rows per page"), 'integer',
DATA_RESULT_ROWS_PER_PAGE, min_val=10,
category_label=PREF_LABEL_RESULTS_GRID,
help_str=gettext('Specify the number of records to fetch in one batch.'
' Changing this value will override'
' DATA_RESULT_ROWS_PER_PAGE setting from config '
' file.')
)
self.stripped_rows = self.preference.register(
'Results_grid', 'striped_rows',
gettext("Striped rows?"), 'boolean',
True, category_label=PREF_LABEL_RESULTS_GRID,
help_str=gettext('If set to true, the result grid will display'
' rows with alternating background colors.')
)
self.max_column_data_display_length = self.preference.register(
'Results_grid', 'max_column_data_display_length',
gettext("Max column data display length"), 'integer',
200, category_label=PREF_LABEL_RESULTS_GRID,
help_str=gettext('Maximum number of characters to be visible in the'
' data output cell.')
)
self.display_connection_status = self.preference.register(
'display', 'connection_status',
gettext("Connection status"), 'boolean', True,
category_label=PREF_LABEL_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=PREF_LABEL_DISPLAY,
help_str=gettext(
'The number of seconds between connection/transaction '
'status polls.'
)
)
self.query_success_notification = self.preference.register(
'display', 'query_success_notification',
gettext("Show query success notification?"), 'boolean', True,
category_label=PREF_LABEL_DISPLAY,
help_str=gettext('If set to True, the Query Tool '
'will show notifications on successful query '
'execution.')
)
self.preference.register(
'keyboard_shortcuts',
'execute_script',
gettext('Execute script'),
'keyboardshortcut',
{
'alt': False,
'shift': False,
'control': False,
'key': {
'key_code': 116,
'char': 'F5'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts',
'execute_cursor',
gettext('Execute query'),
'keyboardshortcut',
{
'alt': True,
'shift': False,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 116,
'char': 'F5'
}
},
category_label=PREF_LABEL_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=PREF_LABEL_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=PREF_LABEL_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=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts',
'clear_query',
gettext('Clear query'),
'keyboardshortcut',
{
'alt': True,
'shift': False,
'control': True,
'key': {
'key_code': 76,
'char': 'l'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts',
'download_results',
gettext('Download results'),
'keyboardshortcut',
{
'alt': False,
'shift': False,
'control': False,
'key': {
'key_code': 119,
'char': 'F8'
}
},
category_label=PREF_LABEL_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=PREF_LABEL_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=PREF_LABEL_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=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
# All about access keys
self.preference.register(
'keyboard_shortcuts', 'btn_open_file',
gettext('Open file'), 'keyboardshortcut',
{
'alt': False,
'shift': False,
'control': True,
'ctrl_is_meta': True,
'key': {
'key_code': 79,
'char': 'o'
},
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_save_file',
gettext('Save file'), 'keyboardshortcut',
{
'alt': False,
'shift': False,
'control': True,
'ctrl_is_meta': True,
'key': {
'key_code': 83,
'char': 's'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_add_row',
gettext('Add row'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 65,
'char': 'a'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_paste_row',
gettext('Paste rows'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 80,
'char': 'p'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_delete_row',
gettext('Delete rows'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 68,
'char': 'd'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_filter_dialog',
gettext('Filter dialog'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 70,
'char': 'f'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_filter_options',
gettext('Filter options'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 73,
'char': 'i'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_execute_options',
gettext('Execute options'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 88,
'char': 'x'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_cancel_query',
gettext('Cancel query'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 67,
'char': 'c'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts', 'btn_edit_options',
gettext('Edit options'), 'keyboardshortcut',
{
'alt': True,
'shift': True,
'control': False,
'ctrl_is_meta': False,
'key': {
'key_code': 78,
'char': 'n'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_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=PREF_LABEL_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(
'auto_completion', 'autocomplete_on_key_press',
gettext("Autocomplete on key press"), 'boolean', False,
category_label=gettext('Auto completion'),
help_str=gettext('If set to True, autocomplete will be available on '
'key press along with CTRL/CMD + Space. If set to '
'False, autocomplete is only activated when CTRL/CMD '
'+ Space is pressed.')
)
self.preference.register(
'keyboard_shortcuts',
'commit_transaction',
gettext('Commit'),
'keyboardshortcut',
{
'alt': False,
'shift': True,
'control': True,
'key': {
'key_code': 77,
'char': 'm'
}
},
category_label=PREF_LABEL_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=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.preference.register(
'keyboard_shortcuts',
'auto_complete',
gettext('Auto complete'),
'keyboardshortcut',
{
'alt': False,
'shift': False,
'control': True,
'ctrl_is_meta': False,
'key': {
'key_code': 32,
'char': 'Space'
}
},
category_label=PREF_LABEL_KEYBOARD_SHORTCUTS,
fields=shortcut_fields
)
self.row_limit = self.preference.register(
'graph_visualiser', 'row_limit',
gettext("Row Limit"), 'integer',
10000, min_val=1, category_label=PREF_LABEL_GRAPH_VISUALISER,
help_str=gettext('This setting specifies the maximum number of rows '
'that will be plotted on a chart. Increasing this '
'limit may impact performance if charts are plotted '
'with very high numbers of rows.')
)