Merge pull request #14 from tkopets/master

list functions (ctrl+e ctrl+f) and get their definitions

Author: mtxr

Default (Linux).sublime-keymap

@@ -4,6 +4,7 @@
     { "keys": ["ctrl+e", "ctrl+h"], "command": "st_history" },
     { "keys": ["ctrl+e", "ctrl+s"], "command": "st_show_records" },
     { "keys": ["ctrl+e", "ctrl+d"], "command": "st_desc_table" },
+    { "keys": ["ctrl+e", "ctrl+f"], "command": "st_desc_function" },
     { "keys": ["ctrl+e", "ctrl+b"], "command": "st_format" },
     { "keys": ["ctrl+e", "ctrl+q"], "command": "st_save_query" },
     { "keys": ["ctrl+e", "ctrl+r"], "command": "st_remove_saved_query" },

Default (OSX).sublime-keymap

@@ -4,6 +4,7 @@
     { "keys": ["ctrl+e", "ctrl+h"], "command": "st_history" },
     { "keys": ["ctrl+e", "ctrl+s"], "command": "st_show_records" },
     { "keys": ["ctrl+e", "ctrl+d"], "command": "st_desc_table" },
+    { "keys": ["ctrl+e", "ctrl+f"], "command": "st_desc_function" },
     { "keys": ["ctrl+e", "ctrl+b"], "command": "st_format" },
     { "keys": ["ctrl+e", "ctrl+q"], "command": "st_save_query" },
     { "keys": ["ctrl+e", "ctrl+r"], "command": "st_remove_saved_query" },

Default (Windows).sublime-keymap

@@ -4,6 +4,7 @@
     { "keys": ["ctrl+e", "ctrl+h"], "command": "st_history" },
     { "keys": ["ctrl+e", "ctrl+s"], "command": "st_show_records" },
     { "keys": ["ctrl+e", "ctrl+d"], "command": "st_desc_table" },
+    { "keys": ["ctrl+e", "ctrl+f"], "command": "st_desc_function" },
     { "keys": ["ctrl+e", "ctrl+b"], "command": "st_format" },
     { "keys": ["ctrl+e", "ctrl+q"], "command": "st_save_query" },
     { "keys": ["ctrl+e", "ctrl+r"], "command": "st_remove_saved_query" },

Default.sublime-commands

@@ -23,6 +23,10 @@
     "caption": "ST: Table Description",
     "command": "st_desc_table"
   },
+  {
+    "caption": "ST: Function Description",
+    "command": "st_desc_function"
+  },
   {
     "caption": "ST: Save Query",
     "command": "st_save_query"

SQLTools.py

@@ -45,6 +45,7 @@ def loadConnectionData():
 
         ST.conn.getTables(lambda tables: ST.setTablesIfNotEmpty(tables))
         ST.conn.getColumns(lambda columns: setattr(ST, 'columns', columns))
+        ST.conn.getFunctions(lambda functions: setattr(ST, 'functions', functions))
 
     @staticmethod
     def setConnection(index):
@@ -98,6 +99,13 @@ def getAutoCompleteList(self, word):
             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)
 
@@ -159,6 +167,15 @@ def run(self):
 
         STM.Window().show_quick_panel(ST.tables, lambda index: ST.conn.getTableDescription(ST.tables[index], ST.display) if index != -1 else None)
 
+class StDescFunction(sublime_plugin.WindowCommand):
+    def run(self):
+        if not ST.conn:
+            ST.showConnectionMenu()
+            return
+
+        # get everything until first occurence of "(", e.g. get "function_name" from "function_name(int)"
+        STM.Window().show_quick_panel(ST.functions, lambda index: ST.conn.getFunctionDescription(ST.functions[index].split('(', 1)[0], ST.display) if index != -1 else None)
+
 class StHistory(sublime_plugin.WindowCommand):
     def run(self):
         if not ST.conn:

SQLTools.sublime-settings

@@ -58,7 +58,17 @@
                     "query": "SELECT DISTINCT '|' || table_name || '.' || column_name || '|' FROM information_schema.columns WHERE table_schema = CURRENT_SCHEMA() GROUP BY table_name, column_name;",
                     "options": ["-t", "--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"],
+                    "format" : "|%s|"
+                },
+                "desc function": {
+                    "query": "\\sf %s",
+                    "options": [],
+                    "format" : "|%s|"
+                },
             }
         },
         "oracle": {

SQLToolsModels.py

@@ -148,6 +148,11 @@ def getColumns(self, callback):
         except Exception:
             pass
 
+    def getFunctions(self, callback):
+        query   = self.getOptionsForSgdbCli()['queries']['functions']['query']
+        self.runCommand(self.builArgs('functions'), query, lambda result: Utils.getResultAsList(result, callback))
+
+
     def getTableRecords(self, tableName, callback):
         query   = self.getOptionsForSgdbCli()['queries']['show records']['query'].format(tableName, self.rowsLimit)
         self.runCommand(self.builArgs('show records'), query, lambda result: callback(result))
@@ -156,6 +161,11 @@ def getTableDescription(self, tableName, callback):
         query   = self.getOptionsForSgdbCli()['queries']['desc table']['query'] % tableName
         self.runCommand(self.builArgs('desc table'), query, lambda result: callback(result))
 
+    def getFunctionDescription(self, functionName, callback):
+        query   = self.getOptionsForSgdbCli()['queries']['desc function']['query'] % functionName
+        self.runCommand(self.builArgs('desc function'), query, lambda result: callback(result))
+
+
     def execute(self, queries, callback):
         queryToRun = ''