add support for optional args (for MySQL auth)

Author: tkopets

SQLTools.sublime-settings

@@ -153,7 +153,8 @@
         "mysql": {
             "options": ["-f", "--table"],
             "before": [],
-            "args": "-h{host} -P{port} -u\"{username}\" -p\"{password}\" -D\"{database}\"",
+            "args": "-h{host} -P{port} -u\"{username}\" -D\"{database}\"",
+            "args_optional": ["--defaults-extra-file=\"{defaults_extra_file}\"", "--defaults-file=\"{defaults-file}\"", "-p\"{password}\""],
             "queries": {
                 "desc" : {
                     "query": "select concat(table_schema, '.', table_name) from information_schema.tables where table_schema = database() order by table_name;",

SQLToolsAPI/Connection.py

@@ -169,24 +169,57 @@ def builArgs(self, queryName=None):
         cliOptions = self.getOptionsForSgdbCli()
         args = [self.cli]
 
-        if len(cliOptions['options']) > 0:
-            args = args + cliOptions['options']
-
-        if queryName and len(cliOptions['queries'][queryName]['options']) > 0:
-            args = args + cliOptions['queries'][queryName]['options']
-
-        if isinstance(cliOptions['args'], list):
-            cliOptions['args'] = ' '.join(cliOptions['args'])
-
-        cliOptions = cliOptions['args'].format(**self.options)
-        args = args + shlex.split(cliOptions)
+        # append otional args (if any) - could be a single value or a list
+        optionalArgs = cliOptions.get('args_optional')
+        if optionalArgs:  # only if we have optional args
+            formattedOptArgList = []
+            if isinstance(optionalArgs, list):
+                for item in optionalArgs:
+                    formattedItem = self.formatOptionalArgument(item, self.options)
+                    if formattedItem:
+                        args = args + shlex.split(formattedItem)
+            else:
+                formattedItem = self.formatOptionalArgument(optionalArgs, self.options)
+                if formattedItem:
+                        args = args + shlex.split(formattedItem)
+
+        # append options (args without values)
+        options = cliOptions.get('options', None)
+        if options:
+            args = args + options
+
+        # append query specific options
+        if queryName:
+            queryOptions = cliOptions['queries'][queryName]['options']
+            if len(queryOptions) > 0:
+                args = args + queryOptions
+
+        # append main args - could be a single value or a list
+        mainArgs = cliOptions['args']
+        if isinstance(mainArgs, list):
+            mainArgs = ' '.join(mainArgs)
+
+        mainArgs = mainArgs.format(**self.options)
+        args = args + shlex.split(mainArgs)
 
         Log('Using cli args ' + ' '.join(args))
         return args
 
     def getOptionsForSgdbCli(self):
         return self.settings.get('cli_options', {}).get(self.type)
 
+    @staticmethod
+    def formatOptionalArgument(argument, formatOptions):
+        try:
+            formattedArg = argument.format(**formatOptions)
+        except (KeyError, IndexError):
+            print("caught exception")
+            return None
+
+        if argument == formattedArg:  # string not changed after format
+            return None
+        return formattedArg
+
     @staticmethod
     def setTimeout(timeout):
         Connection.timeout = timeout