Imporove error handling when creating Connection

The changes include raising an apropriate Exception if DB cli binary
could not be found, with clear next steps on how to fix the issue.
Upon creating a connection, if such Exception is encountered
a sublime status message is displayed to indicate this problem.

fixes #74, fixes #82
related #39, #41, #48, #51

Author: tkopets

SQLTools.py

@@ -65,18 +65,28 @@ def getConnections():
     options = connections.get('connections', {})
 
     for name, config in options.items():
-        connectionsObj[name] = Connection(name, config, settings=settings.all())
+        connectionsObj[name] = createConnection(name, config, settings=settings.all())
 
     # project settings
     try:
         options = Window().project_data().get('connections', {})
         for name, config in options.items():
-            connectionsObj[name] = Connection(name, config, settings=settings.all())
+            connectionsObj[name] = createConnection(name, config, settings=settings.all())
     except Exception:
         pass
 
     return connectionsObj
 
+def createConnection(name, config, settings):
+    newConnection = None
+    # if DB cli binary could not be found in path a FileNotFoundError is thrown
+    try:
+        newConnection = Connection(name, config, settings=settings)
+    except FileNotFoundError as e:
+        # use only first line of the Exception in status message
+        Window().status_message( __package__ + ": " + str(e).splitlines()[0] )
+        raise e
+    return newConnection
 
 def loadDefaultConnection():
     default = settings.get('default', False)

SQLTools.sublime-settings

@@ -15,6 +15,11 @@
     "unescape_quotes" : [
         "php"
     ],
+    /**
+     * If DB cli binary is not in PATH, set the full path in "cli" section.
+     * Note: forward slashes ("/") should be used in path. Example:
+     *  "mysql"   : "c:/Program Files/MySQL/MySQL Server 5.7/bin/mysql.exe"
+     */
     "cli" : {
         "mysql"   : "mysql",
         "pgsql"   : "psql",

SQLToolsAPI/Connection.py

@@ -6,8 +6,17 @@
 from . import Utils as U
 from . import Command as C
 
-
 class Connection:
+    DB_CLI_NOT_FOUND_MESSAGE = """'{0}' could not be found.
+Please set the path to '{0}' binary in your SQLTools settings before continuing.
+Example of "cli" section in SQLTools.sublime-settings:
+    /* ...  (note the use of forward slashes) */
+    "cli" : {{
+        "mysql"   : "c:/Program Files/MySQL/MySQL Server 5.7/bin/mysql.exe",
+        "pgsql"   : "c:/Program Files/PostgreSQL/9.6/bin/psql.exe"
+    }}
+You might need to restart the editor for settings to be refreshed."""
+
     timeout = None
     history = None
     settings = None
@@ -29,15 +38,6 @@ def __init__(self, name, options, settings={}, commandClass='ThreadCommand'):
         self.Command = getattr(C, commandClass)
 
         self.cli = settings.get('cli')[options['type']]
-        cli_path = shutil.which(self.cli)
-
-        if cli_path is None:
-            Log((
-                "'{0}' could not be found.\n\n" +
-                "Please set the '{0}' path in your SQLTools settings " +
-                "before continue.").format(self.cli))
-            return
-
         self.settings  = settings
         self.rowsLimit = settings.get('show_records', {}).get('limit', 50)
         self.options   = options
@@ -53,6 +53,11 @@ def __init__(self, name, options, settings={}, commandClass='ThreadCommand'):
         self.safe_limit = settings.get('safe_limit', None)
         self.show_query = settings.get('show_query', None)
 
+        cli_path = shutil.which(self.cli)
+        if cli_path is None:
+            Log(self.DB_CLI_NOT_FOUND_MESSAGE.format(self.cli))
+            raise FileNotFoundError(self.DB_CLI_NOT_FOUND_MESSAGE.format(self.cli))
+
     def __str__(self):
         return self.name
 

SQLToolsConnections.sublime-settings

@@ -1,16 +1,48 @@
 {
     "connections": {
-        /**
-         * "Connection name": {         // Connection name, used in menu (Display name)
-         *     "database" : "DATABASE",
-         *     "host"     : "HOSTNAME",
-         *     "port"     : "PORT",
-         *     "type"     : "pgsql",    // SGDB to use: (mysql, pgsql, oracle, vertica)
-         *     "username" : "USERNAME",
-         *     "password" : null        // (if you are using postgresql, you must setup a pgpass file and set it to null)
-         *     "encoding" : null        // Your DB encodings. Default: utf-8
-         * },
-         */
+    /*
+        "Generic Template": {        // Connection name, used in menu (Display name)
+            "type"     : "pgsql",    // DB type: (mysql, pgsql, oracle, vertica, sqlite, firebird, sqsh)
+            "host"     : "HOSTNAME", // DB host to connect to
+            "port"     : "PORT",     // DB port
+            "database" : "DATABASE", // DB name (for SQLite this is the path to DB file)
+            "username" : "USERNAME", // DB username
+            "password" : null,       // (if you are using PostgreSQL, you must setup a "pgpass.conf" file and set it to null)
+            "encoding" : "utf-8"     // Your DB encoding. Default: utf-8
+        },
+        "Connection MySQL": {
+            "type"    : "mysql",
+            "host"    : "127.0.0.1",
+            "port"    : 3306,
+            "username": "user",
+            "password": "password",
+            "database": "dbname",
+            "encoding": "utf-8"
+        },
+        "Connection PostgreSQL": {
+            "type"    : "pgsql",
+            "host"    : "127.0.0.1",
+            "port"    :  5432,
+            "username": "anotheruser",
+            "database": "dbname",
+            "encoding": "utf-8"
+        },
+        "Connection Oracle": {
+            "type"    : "oracle",
+            "host"    : "127.0.0.1",
+            "port"    :  1522,
+            "username": "anotheruser",
+            "password": "password",
+            "database": "dbname",
+            "service" : "servicename",
+            "encoding": "utf-8"
+        },
+        "Connection SQLite": {
+            "type"    : "sqlite",
+            "database": "d:/sqlite/sample_db/chinook.db", // note the forward slashes in path
+            "encoding": "utf-8"
+        }
+    */
     },
     "default": null
 }