Merge pull request #13084 from dbeaver/client-commands-prefix-change-preference#13083

#13083 Allow changing prefix for client commands

plugins/org.jkiss.dbeaver.ui.editors.sql/src/org/jkiss/dbeaver/ui/editors/sql/SQLEditor.java

@@ -2685,6 +2685,7 @@ public class SQLEditor extends SQLEditorBase implements
             case ModelPreferences.SQL_ANONYMOUS_PARAMETERS_ENABLED:
             case ModelPreferences.SQL_VARIABLES_ENABLED:
             case ModelPreferences.SQL_NAMED_PARAMETERS_PREFIX:
+            case ModelPreferences.SQL_CONTROL_COMMAND_PREFIX:
                 reloadSyntaxRules();
                 return;
             case SQLPreferenceConstants.RESULT_SET_ORIENTATION:

plugins/org.jkiss.dbeaver.ui.editors.sql/src/org/jkiss/dbeaver/ui/editors/sql/internal/SQLEditorMessages.java

@@ -234,6 +234,8 @@ public class SQLEditorMessages extends NLS {
     public static String pref_page_sql_editor_checkbox_enable_sql_anonymous_parameters;
     public static String pref_page_sql_editor_text_anonymous_parameter_mark;
     public static String pref_page_sql_editor_text_named_parameter_prefix;
+    public static String pref_page_sql_editor_text_control_command_prefix;
+    public static String pref_page_sql_editor_text_explanation_link;
     public static String pref_page_sql_editor_combo_item_each_line_autocommit;
     public static String pref_page_sql_editor_combo_item_each_spec_line;
     public static String pref_page_sql_editor_combo_item_ignore;

plugins/org.jkiss.dbeaver.ui.editors.sql/src/org/jkiss/dbeaver/ui/editors/sql/internal/SQLEditorMessages.properties

@@ -111,6 +111,8 @@ pref_page_sql_editor_label_sound_on_query_end = Beep after query finish
 pref_page_sql_editor_label_sql_timeout = SQL statement timeout
 pref_page_sql_editor_text_anonymous_parameter_mark = Anonymous parameter mark
 pref_page_sql_editor_text_named_parameter_prefix = Named parameter prefix
+pref_page_sql_editor_text_control_command_prefix = Control command prefix
+pref_page_sql_editor_text_explanation_link = See how to use <a href="params">parameters</a> and <a href="commands">commands</a> in our wiki
 pref_page_sql_editor_text_statement_delimiter = Statements delimiter
 pref_page_sql_editor_title_pattern = Script title pattern
 

plugins/org.jkiss.dbeaver.ui.editors.sql/src/org/jkiss/dbeaver/ui/editors/sql/internal/SQLEditorMessages_ru.properties

@@ -141,10 +141,12 @@ pref_page_sql_editor_checkbox_bind_embedded_write_tip = \u041D\u0430\u043F\u0438
 pref_page_sql_editor_title_pattern = \u0428\u0430\u0431\u043B\u043E\u043D \u0437\u0430\u0433\u043E\u043B\u043E\u0432\u043A\u0430 \u0441\u0446\u0435\u043D\u0430\u0440\u0438\u044F
 pref_page_sql_editor_label_sound_on_query_end = \u0417\u0432\u0443\u043A\u043E\u0432\u043E\u0439 \u0441\u0438\u0433\u043D\u0430\u043B \u043F\u043E\u0441\u043B\u0435 \u0437\u0430\u0432\u0435\u0440\u0448\u0435\u043D\u0438\u044F \u0437\u0430\u043F\u0440\u043E\u0441\u0430
 pref_page_sql_editor_text_anonymous_parameter_mark = \u0410\u043D\u043E\u043D\u0438\u043C\u043D\u0430\u044F \u043C\u0435\u0442\u043A\u0430 \u043F\u0430\u0440\u0430\u043C\u0435\u0442\u0440\u0430
-pref_page_sql_editor_text_named_parameter_prefix = \u0418\u043C\u0435\u043D\u043D\u043E\u0432\u0430\u043D\u044B\u0439 \u043F\u0430\u0440\u0430\u043C\u0435\u0442\u0440 \u043F\u0440\u0435\u0444\u0438\u043A\u0441\u0430
+pref_page_sql_editor_text_named_parameter_prefix = \u0418\u043C\u0435\u043D\u043E\u0432\u0430\u043D\u043D\u044B\u0439 \u043F\u0430\u0440\u0430\u043C\u0435\u0442\u0440 \u043F\u0440\u0435\u0444\u0438\u043A\u0441\u0430
+pref_page_sql_editor_text_control_command_prefix = \u041F\u0440\u0435\u0444\u0438\u043A\u0441 \u043A\u043E\u043D\u0442\u0440\u043E\u043B\u044C\u043D\u044B\u0445 \u043A\u043E\u043C\u0430\u043D\u0434
+pref_page_sql_editor_text_explanation_link = \u041F\u043E\u0441\u043C\u043E\u0442\u0440\u0438\u0442\u0435, \u043A\u0430\u043A \u0438\u0441\u043F\u043E\u043B\u044C\u0437\u043E\u0432\u0430\u0442\u044C <a href="params">\u043F\u0430\u0440\u0430\u043C\u0435\u0442\u0440\u044B</a> \u0438 <a href="commands">\u043A\u043E\u043C\u0430\u043D\u0434\u044B</a>,\n \u0432 \u043D\u0430\u0448\u0435\u0439 \u0434\u043E\u043A\u0443\u043C\u0435\u043D\u0442\u0430\u0446\u0438\u0438
 
 pref_page_sql_editor_checkbox_blank_line_delimiter = \u041F\u0443\u0441\u0442\u044B\u0435 \u0441\u0442\u0440\u043E\u043A\u0438 \u0440\u0430\u0437\u0434\u0435\u043B\u044F\u044E\u0442 \u0437\u0430\u043F\u0440\u043E\u0441\u044B
-pref_page_sql_editor_checkbox_blank_line_delimiter_tip = \u0418\u043F\u043E\u043B\u044C\u0437\u043E\u0432\u0430\u0442\u044C \u043F\u0443\u0441\u0442\u044B\u0435 \u0441\u0442\u0440\u043E\u043A\u0438 \u0432 \u043A\u0430\u0447\u0435\u0441\u0442\u0432\u0435 \u0440\u0430\u0437\u0434\u0435\u043B\u0438\u0442\u0435\u043B\u0435\u0439 \u043F\u0440\u0438 \u043F\u0430\u0440\u0441\u0438\u043D\u0433\u0435 \u0437\u0430\u043F\u0440\u043E\u0441\u043E\u0432
+pref_page_sql_editor_checkbox_blank_line_delimiter_tip = \u0418\u0441\u043F\u043E\u043B\u044C\u0437\u043E\u0432\u0430\u0442\u044C \u043F\u0443\u0441\u0442\u044B\u0435 \u0441\u0442\u0440\u043E\u043A\u0438 \u0432 \u043A\u0430\u0447\u0435\u0441\u0442\u0432\u0435 \u0440\u0430\u0437\u0434\u0435\u043B\u0438\u0442\u0435\u043B\u0435\u0439 \u043F\u0440\u0438 \u043F\u0430\u0440\u0441\u0438\u043D\u0433\u0435 \u0437\u0430\u043F\u0440\u043E\u0441\u043E\u0432
 pref_page_sql_editor_checkbox_enable_sql_anonymous_parameters = \u0410\u043D\u043E\u043D\u0438\u043C\u043D\u044B\u0435 \u043F\u0430\u0440\u0430\u043C\u0435\u0442\u0440\u044B SQL
 pref_page_sql_editor_checkbox_enable_sql_parameters = \u041E\u0431\u0440\u0430\u0431\u0430\u0442\u044B\u0432\u0430\u0442\u044C \u043F\u0430\u0440\u0430\u043C\u0435\u0442\u0440\u044B SQL
 pref_page_sql_editor_checkbox_ignore_native_delimiter = \u0418\u0433\u043D\u043E\u0440\u0438\u0440\u043E\u0432\u0430\u0442\u044C \u0440\u0430\u0437\u0434\u0435\u043B\u0438\u0442\u0435\u043B\u0438 \u0437\u0430\u043F\u0440\u043E\u0441\u0430 \u0434\u0440\u0430\u0439\u0432\u0435\u0440\u0430

plugins/org.jkiss.dbeaver.ui.editors.sql/src/org/jkiss/dbeaver/ui/editors/sql/preferences/PrefPageSQLExecute.java

@@ -18,6 +18,8 @@
 package org.jkiss.dbeaver.ui.editors.sql.preferences;
 
 import org.eclipse.swt.SWT;
+import org.eclipse.swt.events.SelectionAdapter;
+import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.widgets.*;
 import org.jkiss.dbeaver.Log;
@@ -31,6 +33,7 @@ import org.jkiss.dbeaver.ui.editors.sql.SQLPreferenceConstants;
 import org.jkiss.dbeaver.ui.editors.sql.internal.SQLEditorMessages;
 import org.jkiss.dbeaver.ui.internal.UIMessages;
 import org.jkiss.dbeaver.ui.preferences.TargetPrefPage;
+import org.jkiss.dbeaver.utils.HelpUtils;
 import org.jkiss.dbeaver.utils.PrefUtils;
 import org.jkiss.utils.CommonUtils;
 
@@ -65,6 +68,7 @@ public class PrefPageSQLExecute extends TargetPrefPage
     private Button enableSQLAnonymousParameters;
     private Text anonymousParameterMarkText;
     private Text namedParameterPrefixText;
+    private Text controlCommandPrefixText;
     private Button enableParametersInDDL;
     private Button enableVariables;
 
@@ -96,6 +100,7 @@ public class PrefPageSQLExecute extends TargetPrefPage
             store.contains(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_ENABLED) ||
             store.contains(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_MARK) ||
             store.contains(ModelPreferences.SQL_NAMED_PARAMETERS_PREFIX) ||
+            store.contains(ModelPreferences.SQL_CONTROL_COMMAND_PREFIX) ||
             store.contains(ModelPreferences.SQL_VARIABLES_ENABLED) ||
 
             store.contains(SQLPreferenceConstants.RESET_CURSOR_ON_EXECUTE) ||
@@ -182,8 +187,29 @@ public class PrefPageSQLExecute extends TargetPrefPage
             anonymousParameterMarkText.setTextLimit(1);
             namedParameterPrefixText = UIUtils.createLabelText(paramsGroup, SQLEditorMessages.pref_page_sql_editor_text_named_parameter_prefix, "", SWT.BORDER, new GridData(32, SWT.DEFAULT));
             namedParameterPrefixText.setTextLimit(1);
+            controlCommandPrefixText = UIUtils.createLabelText(paramsGroup, SQLEditorMessages.pref_page_sql_editor_text_control_command_prefix, "", SWT.BORDER, new GridData(32, SWT.DEFAULT));
+            controlCommandPrefixText.setTextLimit(1);
             enableParametersInDDL = UIUtils.createCheckbox(paramsGroup, SQLEditorMessages.pref_page_sql_editor_enable_parameters_in_ddl, SQLEditorMessages.pref_page_sql_editor_enable_parameters_in_ddl_tip, false, 2);
             enableVariables = UIUtils.createCheckbox(paramsGroup, SQLEditorMessages.pref_page_sql_editor_enable_variables, SQLEditorMessages.pref_page_sql_editor_enable_variables_tip, false, 2);
+
+            GridData gd = new GridData(GridData.FILL_HORIZONTAL);
+            gd.horizontalSpan = 2;
+
+            UIUtils.createLink(paramsGroup, SQLEditorMessages.pref_page_sql_editor_text_explanation_link, new SelectionAdapter() {
+                @Override
+                public void widgetSelected(SelectionEvent e) {
+                    switch (e.text) {
+                        case "params":
+                            UIUtils.launchProgram(HelpUtils.getHelpExternalReference("SQL-Execution#dynamic-parameter-bindings"));
+                            break;
+                        case "commands":
+                            UIUtils.launchProgram(HelpUtils.getHelpExternalReference("Client-Side-Scripting"));
+                            break;
+                        default:
+                            break;
+                    }
+                }
+            }).setLayoutData(gd);
         }
 
         // Delimiters
@@ -225,6 +251,7 @@ public class PrefPageSQLExecute extends TargetPrefPage
             enableSQLAnonymousParameters.setSelection(store.getBoolean(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_ENABLED));
             anonymousParameterMarkText.setText(store.getString(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_MARK));
             namedParameterPrefixText.setText(store.getString(ModelPreferences.SQL_NAMED_PARAMETERS_PREFIX));
+            controlCommandPrefixText.setText(store.getString(ModelPreferences.SQL_CONTROL_COMMAND_PREFIX));
             enableParametersInDDL.setSelection(store.getBoolean(ModelPreferences.SQL_PARAMETERS_IN_DDL_ENABLED));
             enableVariables.setSelection(store.getBoolean(ModelPreferences.SQL_VARIABLES_ENABLED));
         } catch (Exception e) {
@@ -258,6 +285,7 @@ public class PrefPageSQLExecute extends TargetPrefPage
             store.setValue(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_ENABLED, enableSQLAnonymousParameters.getSelection());
             store.setValue(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_MARK, anonymousParameterMarkText.getText());
             store.setValue(ModelPreferences.SQL_NAMED_PARAMETERS_PREFIX, namedParameterPrefixText.getText());
+            store.setValue(ModelPreferences.SQL_CONTROL_COMMAND_PREFIX, controlCommandPrefixText.getText());
             store.setValue(ModelPreferences.SQL_PARAMETERS_IN_DDL_ENABLED, enableParametersInDDL.getSelection());
             store.setValue(ModelPreferences.SQL_VARIABLES_ENABLED, enableVariables.getSelection());
         } catch (Exception e) {
@@ -289,6 +317,7 @@ public class PrefPageSQLExecute extends TargetPrefPage
         store.setToDefault(ModelPreferences.SQL_PARAMETERS_IN_DDL_ENABLED);
         store.setToDefault(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_ENABLED);
         store.setToDefault(ModelPreferences.SQL_ANONYMOUS_PARAMETERS_MARK);
+        store.setToDefault(ModelPreferences.SQL_CONTROL_COMMAND_PREFIX);
         store.setToDefault(ModelPreferences.SQL_VARIABLES_ENABLED);
 
         store.setToDefault(ModelPreferences.SQL_NAMED_PARAMETERS_PREFIX);