implementation of in-comment options, prepare for 2.2.0

Author: okbob

META.json

@@ -2,15 +2,15 @@
    "name": "plpgsql_check",
    "abstract": "Additional tools for plpgsql functions validation",
    "description": "The plpgsql_check is PostgreSQL extension with functionality for direct or indirect extra validation of functions in plpgsql language. It verifies a validity of SQL identifiers used in plpgsql code. It try to identify a performance issues. Modern versions has integrated profiler. The table and function dependencies can be displayed",
-   "version": "2.1.10",
+   "version": "2.2.0",
    "maintainer": "Pavel STEHULE <pavel.stehule@gmail.com>",
    "license": "bsd",
    "provides": {
       "plpgsql_check": {
          "abstract": "Additional tools for plpgsql functions validation",
          "file": "sql/plpgsql_check_active.sql",
          "docfile": "README.md",
-         "version": "2.1.10"
+         "version": "2.2.0"
       }
    },
    "prereqs": {

Makefile

@@ -2,7 +2,7 @@
 
 MODULE_big = plpgsql_check
 OBJS = $(patsubst %.c,%.o,$(wildcard src/*.c))
-DATA = plpgsql_check--2.1.sql
+DATA = plpgsql_check--2.2.sql
 EXTENSION = plpgsql_check
 
 ifndef MAJORVERSION

README.md

@@ -172,6 +172,11 @@ You can set level of warnings via function's parameters:
 * `newtable DEFAULT NULL`, `oldtable DEFAULT NULL` - the names of NEW or OLD transitive
    tables. These parameters are required when transitive tables are used.
 
+* `use_incomment_options` - when it is true (default), then in-comment options are active
+
+* `incomment_options_usage_warning` - when it is true (default is false), then the warning is raised when
+   in-comment option is used.
+
 ## Triggers
 
 When you want to check any trigger, you have to enter a relation that will be
@@ -224,6 +229,30 @@ For triggers with transitive tables you can set a `oldtable` or `newtable` param
     select * from plpgsql_check_function('footab_trig_func','footab', newtable := 'newtab');
 
 
+## In-comment options
+
+plpgsql_check allows persistent setting written in comments. These options are taken from
+function's source code before checking. The syntax is:
+
+    @plpgsql_check_option: optioname [=] value [, optname [=] value ...]
+
+The settings from comment options has top high priority, but generally it can be disabled
+by option `use_incomment_options` to `false`.
+
+Example:
+
+    create or replace function fx(anyelement)
+    returns text as $$
+    begin
+      /*
+       * rewrite default polymorphic type to text */
+       * @plpgsql_check_options: anyelementtype = text
+       */
+      return $1;
+    end;
+    $$ language plpgsql;
+
+
 ## Mass check
 
 You can use the plpgsql_check_function for mass check functions and mass check

plpgsql_check--2.1.sql

@@ -1,6 +1,6 @@
 # plpgsql_check extension
 comment = 'extended check for plpgsql functions'
-default_version = '2.1'
+default_version = '2.2'
 module_pathname = '$libdir/plpgsql_check'
 relocatable = false
 requires = 'plpgsql'

plpgsql_check.control

@@ -3,7 +3,7 @@
 %global sname plpgsql_check
 
 Name:		%{sname}_%{pgmajorversion}
-Version:	2.1.10
+Version:	2.2.0
 Release:	1%{?dist}
 Summary:	Additional tools for plpgsql functions validation
 
@@ -48,6 +48,9 @@ rm -rf %{buildroot}
 %{pginstdir}/share/extension/*.control
 
 %changelog
+* Tue Sep 20 2022 - Pavel Stehule <pavel.stehule@gmail.com> 2.2.0
+- possibility to use in comment options
+
 * Wed Dec 29 2021 - Pavel Stehule <pavel.stehule@gmail.com> 2.1.0
 - possibility to count statement's aborted execution
 - possibility to count "unfinished" statements due exception

postgresql10-plpgsql_check.spec

@@ -3,7 +3,7 @@
 %global sname plpgsql_check
 
 Name:		%{sname}_%{pgmajorversion}
-Version:	2.1.10
+Version:	2.2.0
 Release:	1%{?dist}
 Summary:	Additional tools for plpgsql functions validation
 
@@ -49,6 +49,9 @@ rm -rf %{buildroot}
 %{pginstdir}/share/extension/*.control
 
 %changelog
+* Tue Sep 20 2022 - Pavel Stehule <pavel.stehule@gmail.com> 2.2.0
+- possibility to use in comment options
+
 * Wed Dec 29 2021 - Pavel Stehule <pavel.stehule@gmail.com> 2.1.0
 - possibility to count statement's aborted execution
 - possibility to count "unfinished" statements due exception

postgresql11-plpgsql_check.spec

@@ -3,7 +3,7 @@
 %global sname plpgsql_check
 
 Name:		%{sname}_%{pgmajorversion}
-Version:	2.1.10
+Version:	2.2.0
 Release:	1%{?dist}
 Summary:	Additional tools for plpgsql functions validation
 
@@ -49,6 +49,9 @@ rm -rf %{buildroot}
 %{pginstdir}/share/extension/*.control
 
 %changelog
+* Tue Sep 20 2022 - Pavel Stehule <pavel.stehule@gmail.com> 2.2.0
+- possibility to use in comment options
+
 * Wed Dec 29 2021 - Pavel Stehule <pavel.stehule@gmail.com> 2.1.0
 - possibility to count statement's aborted execution
 - possibility to count "unfinished" statements due exception