Merge pull request #85 from mtxr/smart_completions

Smart completions

Author: mtxr

SQLTools.py

@@ -2,6 +2,7 @@
 
 import sys
 import os
+import re
 from functools import partial
 
 import sublime
@@ -13,6 +14,7 @@
 from .SQLToolsAPI.Storage import Storage, Settings
 from .SQLToolsAPI.Connection import Connection
 from .SQLToolsAPI.History import History
+from .SQLToolsAPI.Completion import Completion
 
 SYNTAX_PLAIN_TEXT = 'Packages/Text/Plain text.tmLanguage'
 SYNTAX_SQL = 'Packages/SQL/SQL.tmLanguage'
@@ -265,56 +267,85 @@ def selectFunction(callback):
 
     @staticmethod
     def on_query_completions(view, prefix, locations):
-        completions = view.extract_completions(prefix)
-
-        if prefix == "":
-            currentPoint = locations[0]
-            lineStartPoint = view.line(currentPoint).begin()
-            lineStartToLocation = sublime.Region(lineStartPoint, currentPoint)
-            try:
-                # everything after last space is a prefix
-                prefix = view.substr(lineStartToLocation).split(" ").pop()
-            except Exception:
-                pass
+        # skip completions, if no connection
+        if ST.conn is None:
+            return None
+
+        if not len(locations):
+            return None
 
         selectors = settings.get('selectors', [])
-        if not selectors:
-            return completions + ST.getAutoCompleteList(prefix)
-        for selector in selectors:
-            if view.match_selector(locations[0], selector):
-                return completions + ST.getAutoCompleteList(prefix)
-        return None
+        selectorMatched = False
+        if selectors:
+            for selector in selectors:
+                if view.match_selector(locations[0], selector):
+                    selectorMatched = True
+                    break
+
+        if not selectorMatched:
+            return None
+
+        # completions enabled? if yes, determine which type
+        completionType = settings.get('autocompletion', 'smart')
+        if not completionType:
+            return None         # autocompletion disabled
+        completionType = str(completionType).strip()
+        if completionType not in ['basic', 'smart']:
+            completionType = 'smart'
+
+        # no completions inside strings
+        if view.match_selector(locations[0], 'string'):
+            return None
+
+        # sublimePrefix = prefix
+        # sublimeCompletions = view.extract_completions(sublimePrefix, locations[0])
+
+        # preferably get prefix ourselves instead of using default sublime "prefix".
+        # Sublime will return only last portion of this preceding text. Given:
+        # SELECT table.col|
+        # sublime will return: "col", and we need: "table.col"
+        # to know more precisely which completions are more appropriate
+
+        # get a Region that starts at the beginning of current line
+        # and ends at current cursor position
+        currentPoint = locations[0]
+        lineStartPoint = view.line(currentPoint).begin()
+        lineStartToLocation = sublime.Region(lineStartPoint, currentPoint)
+        try:
+            lineStr = view.substr(lineStartToLocation)
+            prefix = re.split('[^\w.]+', lineStr).pop()
+        except Exception as e:
+            Log(e)
+            pass
+
+        # determine desired keywords case from settings
+        formatSettings = settings.get('format', {})
+        keywordCase = formatSettings.get('keyword_case', 'upper')
+        uppercaseKeywords = (keywordCase.lower() == 'upper')
+
+        inhibit = False
+        completion = Completion(uppercaseKeywords, ST.tables, ST.columns, ST.functions)
+
+        if completionType == 'basic':
+            ST.autoCompleteList = completion.getBasicAutoCompleteList(prefix)
+        else:
+            # use current paragraph as sql text to parse
+            sqlRegion = expand_to_paragraph(view, currentPoint)
+            sql = view.substr(sqlRegion)
+            sqlToCursorRegion = sublime.Region(sqlRegion.begin(), currentPoint)
+            sqlToCursor = view.substr(sqlToCursorRegion)
+            ST.autoCompleteList, inhibit = completion.getAutoCompleteList(prefix, sql, sqlToCursor)
+
+        # safe check here, so even if we return empty completions and inhibit is true
+        # we return empty completions to show default sublime completions
+        if ST.autoCompleteList is None or len(ST.autoCompleteList) == 0:
+            return None
+
+        if inhibit:
+            return (ST.autoCompleteList, sublime.INHIBIT_WORD_COMPLETIONS)
+
+        return ST.autoCompleteList
 
-    @staticmethod
-    def getAutoCompleteList(word):
-        ST.autoCompleteList = []
-        for w in ST.tables:
-            try:
-                if word.lower() in w.lower():
-                    ST.autoCompleteList.append(
-                        ("{0}\t({1})".format(w, 'Table'), w))
-            except UnicodeDecodeError:
-                continue
-
-        for w in ST.columns:
-            try:
-                if word.lower() in w.lower():
-                    w = w.split(".")
-                    ST.autoCompleteList.append(("{0}\t({1})".format(
-                        w[1], w[0] + ' Col'), w[1]))
-            except Exception:
-                continue
-
-        for w in ST.functions:
-            try:
-                if word.lower() in w.lower():
-                    ST.autoCompleteList.append(
-                        ("{0}\t({1})".format(w, 'Func'), w))
-            except Exception:
-                continue
-
-        ST.autoCompleteList.sort()
-        return (ST.autoCompleteList)
 
 # #
 # # Commands
@@ -533,6 +564,7 @@ def reload():
         import imp
         imp.reload(sys.modules[__package__ + ".SQLToolsAPI"])
         imp.reload(sys.modules[__package__ + ".SQLToolsAPI.Utils"])
+        imp.reload(sys.modules[__package__ + ".SQLToolsAPI.Completion"])
         imp.reload(sys.modules[__package__ + ".SQLToolsAPI.Storage"])
         imp.reload(sys.modules[__package__ + ".SQLToolsAPI.History"])
         imp.reload(sys.modules[__package__ + ".SQLToolsAPI.Log"])

SQLTools.sublime-settings

@@ -12,6 +12,7 @@
      * An empty list means autocompletion always active.
      */
     "selectors": ["source.sql", "source.pgsql", "source.plpgsql.postgres", "source.plsql.oracle", "source.tsql"],
+    "autocompletion": "smart",  /* possible values: "basic", "smart" or false (disable) */
     "unescape_quotes" : [
         "php"
     ],
@@ -54,8 +55,8 @@
             "args": "-h {host} -p {port} -U {username} -d {database}",
             "queries": {
                 "desc" : {
-                    "query": "SELECT  '|' || CASE WHEN n.nspname = current_schema() THEN quote_ident(c.relname) ELSE quote_ident(n.nspname)||'.'||quote_ident(c.relname) END ||'|' AS tblname FROM pg_catalog.pg_class AS c INNER JOIN pg_catalog.pg_namespace AS n ON n.oid = c.relnamespace WHERE relkind = 'r' AND n.nspname NOT IN ('pg_catalog', 'pg_toast', 'information_schema') ORDER BY n.nspname = current_schema() DESC, pg_catalog.pg_table_is_visible(c.oid) DESC, n.nspname, c.relname",
-                    "options": ["-t", "--no-psqlrc"],
+                    "query": "select '|' || quote_ident(table_schema)||'.'||quote_ident(table_name) ||'|' as tblname from information_schema.tables where table_schema = any(current_schemas(false)) and table_schema not in ('pg_catalog', 'information_schema') order by table_schema = current_schema() desc, table_schema, table_name",
+                    "options": ["--tuples-only", "--no-psqlrc"],
                     "format" : "|%s|"
                 },
                 "desc table": {
@@ -69,13 +70,13 @@
                     "format" : "|%s|"
                 },
                 "columns": {
-                    "query": "SELECT DISTINCT '|' || quote_ident(table_name) || '.' || quote_ident(column_name) || '|' FROM information_schema.columns WHERE table_schema = CURRENT_SCHEMA() GROUP BY table_name, column_name;",
-                    "options": ["-t", "--no-psqlrc"],
+                    "query": "select '|' || quote_ident(table_name) || '.' || quote_ident(column_name) || '|' from information_schema.columns where table_schema = any(current_schemas(false)) and table_schema not in ('pg_catalog', 'information_schema') order by table_name, ordinal_position",
+                    "options": ["--tuples-only", "--no-psqlrc"],
                     "format" : "|%s|"
                 },
                 "functions": {
-                    "query": "SELECT '|' || CASE WHEN n.nspname = current_schema() THEN quote_ident(f.proname) ELSE quote_ident(n.nspname)||'.'||quote_ident(f.proname) END || '(' || pg_get_function_identity_arguments(f.oid) || ')' || '|' AS funname FROM pg_catalog.pg_proc AS f INNER JOIN pg_catalog.pg_namespace AS n ON n.oid = f.pronamespace WHERE proisagg = false AND n.nspname NOT IN ('pg_catalog', 'information_schema')",
-                    "options": ["-t", "--no-psqlrc"],
+                    "query": "select '|' || quote_ident(n.nspname)||'.'||quote_ident(f.proname) || '(' || pg_get_function_identity_arguments(f.oid) || ')' || '|' as funname from pg_catalog.pg_proc as f inner join pg_catalog.pg_namespace as n on n.oid = f.pronamespace where f.proisagg = false and n.nspname = any(current_schemas(false)) and n.nspname not in ('pg_catalog', 'information_schema')",
+                    "options": ["--tuples-only", "--no-psqlrc"],
                     "format" : "|%s|"
                 },
                 "desc function": {
@@ -116,7 +117,12 @@
             "args": "{username}/{password}@\"(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST={host})(PORT={port})))(CONNECT_DATA=(SERVICE_NAME={service})))\"",
             "queries": {
                 "desc" : {
-                    "query": "select CONCAT(CONCAT('| ', table_name), ' |') as tables from user_tables;",
+                    "query": "select concat(concat(concat(concat('|', owner), '.'), table_name), '|') as tbls from all_tables where owner = sys_context('USERENV', 'CURRENT_SCHEMA');",
+                    "options": ["-S"],
+                    "format" : "|%s|"
+                },
+                "columns": {
+                    "query": "select concat(concat(concat(concat('|', c.table_name), '.'), c.column_name), '|') as cols from all_tab_columns c inner join all_tables t ON c.owner = t.owner and c.table_name = t.table_name where c.owner = sys_context('USERENV', 'CURRENT_SCHEMA');",
                     "options": ["-S"],
                     "format" : "|%s|"
                 },
@@ -143,7 +149,7 @@
             "args": "-h{host} -P{port} -u\"{username}\" -p\"{password}\" -D\"{database}\"",
             "queries": {
                 "desc" : {
-                    "query": "show tables",
+                    "query": "select concat(table_schema, '.', table_name) from information_schema.tables where table_schema = database() order by table_name;",
                     "options": ["-f", "--table", "--skip-column-names"],
                     "format" : "|%s|"
                 },
@@ -158,8 +164,13 @@
                     "format" : "|%s|"
                 },
                 "columns": {
-                    "query": "SELECT table_name, column_name FROM information_schema.columns WHERE table_schema = DATABASE();",
-                    "options": ["-f", "--table"],
+                    "query": "select concat(table_name, '.', column_name) from information_schema.columns where table_schema = database() order by table_name, ordinal_position;",
+                    "options": ["-f", "--table", "--skip-column-names"],
+                    "format" : "|%s|"
+                },
+                "functions": {
+                    "query": "select concat(routine_schema, '.', routine_name) from information_schema.routines where routine_schema = database();",
+                    "options": ["-f", "--table", "--skip-column-names"],
                     "format" : "|%s|"
                 },
                 "explain plan": {
@@ -175,8 +186,13 @@
             "args": "-h {host} -p {port} -U \"{username}\" -w \"{password}\" -d \"{database}\"",
             "queries": {
                 "desc" : {
-                    "query": "\\dt",
-                    "options": ["-t"],
+                    "query": "select '|' || table_schema || '.' || table_name || '|' as tblname from v_catalog.tables where is_system_table = false",
+                    "options": ["--tuples-only", "--no-vsqlrc"],
+                    "format" : "|%s|"
+                },
+                "columns": {
+                    "query": "select '|' || table_name || '.' || column_name || '|' as tblname from v_catalog.columns where is_system_table = false order by table_name, ordinal_position",
+                    "options": ["--tuples-only", "--no-vsqlrc"],
                     "format" : "|%s|"
                 },
                 "desc table": {
@@ -202,7 +218,13 @@
             "args": "-S {host}:{port} -U\"{username}\" -P\"{password}\" -D{database}",
             "queries": {
                 "desc": {
-                    "query": "select table_name from information_schema.tables order by 1;",
+                    "query": "select concat(table_schema, '.', table_name) from information_schema.tables order by table_name;",
+                    "before" :["\\set semicolon_cmd=\"\\go -mpretty -l -h -f\""],
+                    "options": [],
+                    "format": "|%s|"
+                },
+                "columns": {
+                    "query": "select concat(table_name, '.', column_name) from information_schema.columns order by table_name, ordinal_position;",
                     "before" :["\\set semicolon_cmd=\"\\go -mpretty -l -h -f\""],
                     "options": [],
                     "format": "|%s|"