Akamath46297/scripting/functions (microsoft#82)

* Initial scripting changes for functions

* Additional changes

* Fixed comments

Author: akamath46297

pgsmo/objects/functions/function_base.py

@@ -7,12 +7,16 @@
 from typing import Optional
 
 import pgsmo.objects.node_object as node
+import pgsmo.utils.querying as querying
+import pgsmo.utils.templating as templating
 from pgsmo.objects.server import server as s    # noqa
 
 
 class FunctionBase(node.NodeObject, metaclass=ABCMeta):
     """Base class for Functions. Provides basic properties for all Function types"""
 
+    MACRO_ROOT = templating.get_template_root(__file__, 'macros')
+
     @classmethod
     def _from_node_query(cls, server: 's.Server', parent: node.NodeObject, **kwargs) -> 'FunctionBase':
         """
@@ -45,6 +49,15 @@ def __init__(self, server: 's.Server', parent: node.NodeObject, name: str):
         self._owner: Optional[str] = None
 
     # PROPERTIES ###########################################################
+    @property
+    def extended_vars(self):
+        template_vars = {
+            'scid': self.parent.oid,
+            'did': self.parent.parent.oid,
+            'datlastsysoid': 0  # temporary until implemented
+        }
+        return template_vars
+
     # -BASIC PROPERTIES ####################################################
     @property
     def description(self) -> Optional[str]:
@@ -57,3 +70,186 @@ def language_name(self) -> Optional[str]:
     @property
     def owner(self) -> Optional[str]:
         return self._owner
+
+    @property
+    def arguments(self) -> Optional[list]:
+        return self._full_properties.get("arguments")
+
+    @property
+    def proretset(self):
+        return self._full_properties.get("proretset")
+
+    @property
+    def prorettypename(self):
+        return self._full_properties.get("prorettypename")
+
+    @property
+    def procost(self):
+        return self._full_properties.get("procost")
+
+    @property
+    def provolatile(self):
+        return self._full_properties.get("provolatile")
+
+    @property
+    def proleakproof(self):
+        return self._full_properties.get("proleakproof")
+
+    @property
+    def proisstrict(self):
+        return self._full_properties.get("proisstrict")
+
+    @property
+    def prosecdef(self):
+        return self._full_properties.get("prosecdef")
+
+    @property
+    def proiswindow(self):
+        return self._full_properties.get("proiswindow")
+
+    @property
+    def proparallel(self):
+        return self._full_properties.get("proparallel")
+
+    @property
+    def prorows(self):
+        return self._full_properties.get("prorows")
+
+    @property
+    def variables(self):
+        return self._full_properties.get("variables")
+
+    @property
+    def probin(self):
+        return self._full_properties.get("probin")
+
+    @property
+    def prosrc_c(self):
+        return self._full_properties.get("prosrc_c")
+
+    @property
+    def prosrc(self):
+        return self._full_properties.get("prosrc")
+
+    @property
+    def func_args_without(self):
+        return self._full_properties.get("func_args_without")
+
+    @property
+    def acl(self):
+        return self._full_properties.get("acl")
+
+    @property
+    def seclabels(self):
+        return self._full_properties.get("seclabels")
+
+    @property
+    def change_func(self):
+        return self._full_properties.get("change_func")
+
+    @property
+    def merged_variables(self):
+        return self._full_properties.get("merged_variables")
+
+    @property
+    def cascade(self):
+        return self._full_properties.get("cascade")
+
+    # SCRIPTING METHODS ##############################################################
+    def create_script(self, connection: querying.ServerConnection) -> str:
+        """ Function to retrieve create scripts for a functions """
+        data = self._create_query_data()
+        query_file = "create.sql"
+        return self._get_template(connection, query_file, data, paths_to_add=[self.MACRO_ROOT])
+
+    def delete_script(self, connection: querying.ServerConnection) -> str:
+        """ Function to retrieve delete scripts for a functions"""
+        data = self._delete_query_data()
+        query_file = "delete.sql"
+        return self._get_template(connection, query_file, data)
+
+    def update_script(self, connection: querying.ServerConnection) -> str:
+        """ Function to retrieve update scripts for a functions"""
+        data = self._update_query_data()
+        query_file = "update.sql"
+        return self._get_template(connection, query_file, data, paths_to_add=[self.MACRO_ROOT])
+
+    def _create_query_data(self) -> dict:
+        """ Provides data input for create script """
+        data = {"data": {
+            "name": self.name,
+            "pronamespace": self.parent.name,
+            "arguments": self.arguments,
+            "proretset": self.proretset,
+            "prorettypename": self.prorettypename,
+            "lanname": self.language_name,
+            "procost": self.procost,
+            "provolatile": self.provolatile,
+            "proleakproof": self.proleakproof,
+            "proisstrict": self.proisstrict,
+            "prosecdef": self.prosecdef,
+            "proiswindow": self.proiswindow,
+            "proparallel": self.proparallel,
+            "prorows": self.prorows,
+            "variables": self.variables,
+            "probin": self.probin,
+            "prosrc_c": self.prosrc_c,
+            "prosrc": self.prosrc,
+            "funcowner": self.owner,
+            "func_args_without": self.func_args_without,
+            "description": self.description,
+            "acl": self.acl,
+            "seclabels": self.seclabels
+        }}
+        return data
+
+    def _delete_query_data(self) -> dict:
+        """ Provides data input for delete script """
+        data = {
+            "scid": self.parent.oid,
+            "fnid": self.oid,
+            "cascade": self.cascade,
+        }
+        return data
+
+    def _update_query_data(self) -> dict:
+        """ Function that returns data for update script """
+        data = {
+            "data": {
+                "name": self.name,
+                "pronamespace": self.parent.name,
+                "arguments": self.arguments,
+                "lanname": self.language_name,
+                "procost": self.procost,
+                "provolatile": self.provolatile,
+                "proisstrict": self.proisstrict,
+                "prosecdef": self.prosecdef,
+                "proiswindow": self.proiswindow,
+                "prorows": self.prorows,
+                "variables": self.variables,
+                "probin": self.probin,
+                "prosrc": self.prosrc,
+                "funcowner": self.owner,
+                "description": self.description,
+                "acl": self.acl,
+                "seclabels": self.seclabels,
+                "change_func": self.change_func,
+                "merged_variables": self.merged_variables
+            },
+            "o_data": {
+                "name": "",
+                "pronamespace": "",
+                "proargtypenames": "",
+                "lanname": "",
+                "provolatile": "",
+                "proisstrict": "",
+                "prosecdef": "",
+                "proiswindow": "",
+                "procost": "",
+                "prorows": "",
+                "probin": "",
+                "prosrc_c": "",
+                "prosrc": ""
+            }
+        }
+        return data

pgsmo/objects/functions/macros/privilege.macros

@@ -0,0 +1,14 @@
+{##############################################}
+{# Macros for Privileges (functions module)   #}
+{##############################################}
+{% macro SET(conn, type, role, param, privs, with_grant_privs, schema, func_args) -%}
+{% if privs %}
+GRANT {{ privs|join(', ') }} ON {{ type }} {{ conn|qtIdent(schema, param) }}({{func_args}}) TO {{role }};
+{% endif %}
+{% if with_grant_privs %}
+GRANT {{ with_grant_privs|join(', ') }} ON {{ type }} {{ conn|qtIdent(schema, param) }}({{func_args}}) TO {{ role }} WITH GRANT OPTION;
+{% endif %}
+{%- endmacro %}
+{% macro UNSETALL(conn, type, role, param, schema, func_args) -%}
+REVOKE ALL ON {{ type }} {{ conn|qtIdent(schema, param) }}({{func_args}}) FROM {{role }};
+{%- endmacro %}

pgsmo/objects/functions/macros/security.macros

@@ -0,0 +1,9 @@
+{#################################################}
+{# Macros for Security Labels (functions module) #}
+{#################################################}
+{% macro SET(conn, type, name, provider, label, schema, func_args) -%}
+SECURITY LABEL{% if provider and provider != '' %} FOR {{ conn|qtIdent(provider) }}{% endif %} ON {{ type }} {{ conn|qtIdent(schema, name) }}({{func_args}}) IS {{ label|qtLiteral }};
+{%- endmacro %}
+{% macro UNSET(conn, type, name, provider, schema, func_args) -%}
+SECURITY LABEL FOR {{ provider }} ON {{ type }} {{ conn|qtIdent(schema, name) }}({{func_args}}) IS NULL;
+{%- endmacro %}

pgsmo/objects/functions/macros/variable.macros

@@ -0,0 +1,19 @@
+{################################################}
+{# Macros for Variables (functions module)      #}
+{################################################}
+{% macro SET(conn, object_type, object_name, options, schema, func_args) -%}
+
+{% for opt in options %}
+ALTER {{object_type}} {{ conn|qtIdent(schema, object_name) }}({{func_args}})
+    SET {{ conn|qtIdent(opt.name) }}={{ opt.value|qtLiteral }};
+
+{% endfor %}
+{%- endmacro %}
+{% macro UNSET(conn, object_type, object_name, options, schema, func_args) -%}
+
+{% for opt in options %}
+ALTER {{object_type}} {{ conn|qtIdent(schema, object_name) }}({{func_args}})
+    RESET {{ conn|qtIdent(opt.name) }};
+
+{% endfor %}
+{%- endmacro %}

pgsmo/objects/functions/templates_functions/pg/+default/create.sql

@@ -4,9 +4,9 @@
  # Copyright (C) 2013 - 2017, The pgAdmin Development Team
  # This software is released under the PostgreSQL Licence
  #}
-{% import 'macros/functions/security.macros' as SECLABEL %}
-{% import 'macros/functions/privilege.macros' as PRIVILEGE %}
-{% import 'macros/functions/variable.macros' as VARIABLE %}
+{% import 'security.macros' as SECLABEL %}
+{% import 'privilege.macros' as PRIVILEGE %}
+{% import 'variable.macros' as VARIABLE %}
 {% set is_columns = [] %}
 {% if data %}
 {% if query_for == 'sql_panel' and func_def is defined %}

pgsmo/objects/functions/templates_functions/pg/+default/update.sql

@@ -4,9 +4,9 @@
  # Copyright (C) 2013 - 2017, The pgAdmin Development Team
  # This software is released under the PostgreSQL Licence
  #}
-{% import 'macros/functions/security.macros' as SECLABEL %}
-{% import 'macros/functions/privilege.macros' as PRIVILEGE %}
-{% import 'macros/functions/variable.macros' as VARIABLE %}{% if data %}
+{% import 'security.macros' as SECLABEL %}
+{% import 'privilege.macros' as PRIVILEGE %}
+{% import 'variable.macros' as VARIABLE %}{% if data %}
 {% set name = o_data.name %}
 {% if data.name %}
 {% if data.name != o_data.name %}

pgsmo/objects/functions/templates_functions/pg/9.2_plus/create.sql

@@ -4,9 +4,9 @@
  # Copyright (C) 2013 - 2017, The pgAdmin Development Team
  # This software is released under the PostgreSQL Licence
  #}
-{% import 'macros/functions/security.macros' as SECLABEL %}
-{% import 'macros/functions/privilege.macros' as PRIVILEGE %}
-{% import 'macros/functions/variable.macros' as VARIABLE %}
+{% import 'security.macros' as SECLABEL %}
+{% import 'privilege.macros' as PRIVILEGE %}
+{% import 'variable.macros' as VARIABLE %}
 {% set is_columns = [] %}
 {% if data %}
 {% if query_for == 'sql_panel' and func_def is defined %}

pgsmo/objects/functions/templates_functions/pg/9.2_plus/update.sql

@@ -4,9 +4,9 @@
  # Copyright (C) 2013 - 2017, The pgAdmin Development Team
  # This software is released under the PostgreSQL Licence
  #}
-{% import 'macros/functions/security.macros' as SECLABEL %}
-{% import 'macros/functions/privilege.macros' as PRIVILEGE %}
-{% import 'macros/functions/variable.macros' as VARIABLE %}{% if data %}
+{% import 'security.macros' as SECLABEL %}
+{% import 'privilege.macros' as PRIVILEGE %}
+{% import 'variable.macros' as VARIABLE %}{% if data %}
 {% set name = o_data.name %}
 {% if data.name %}
 {% if data.name != o_data.name %}

pgsmo/objects/functions/templates_functions/pg/9.5_plus/create.sql

@@ -4,9 +4,9 @@
  # Copyright (C) 2013 - 2017, The pgAdmin Development Team
  # This software is released under the PostgreSQL Licence
  #}
-{% import 'macros/functions/security.macros' as SECLABEL %}
-{% import 'macros/functions/privilege.macros' as PRIVILEGE %}
-{% import 'macros/functions/variable.macros' as VARIABLE %}
+{% import 'security.macros' as SECLABEL %}
+{% import 'privilege.macros' as PRIVILEGE %}
+{% import 'variable.macros' as VARIABLE %}
 {% set is_columns = [] %}
 {% if data %}
 {% if query_for == 'sql_panel' and func_def is defined %}

pgsmo/objects/functions/templates_functions/pg/9.5_plus/update.sql

@@ -4,9 +4,9 @@
  # Copyright (C) 2013 - 2017, The pgAdmin Development Team
  # This software is released under the PostgreSQL Licence
  #}
-{% import 'macros/functions/security.macros' as SECLABEL %}
-{% import 'macros/functions/privilege.macros' as PRIVILEGE %}
-{% import 'macros/functions/variable.macros' as VARIABLE %}{% if data %}
+{% import 'security.macros' as SECLABEL %}
+{% import 'privilege.macros' as PRIVILEGE %}
+{% import 'variable.macros' as VARIABLE %}{% if data %}
 {% set name = o_data.name %}
 {% if data.name %}
 {% if data.name != o_data.name %}