Merge pull request #860 from utPLSQL/feature/add_version_info_to_doc

jgebal · web-flow · commit 23e2a373fbe6 · 2019-03-18T11:27:17.000Z
Added `ut.version` and `ut_run_info()` onto documentation.
diff --git a/docs/userguide/install.md b/docs/userguide/install.md
@@ -2,7 +2,7 @@
 
 # Downloading latest version of utPLSQL
 
-To download latest version of utPLSQL from github on both Unix/Linux as well as Windows machines use the below smippets.
+To download latest version of utPLSQL from github on both Unix/Linux as well as Windows machines use the below snippets.
 
 ## Unix/Linux
 
@@ -51,6 +51,20 @@ foreach ($i in $urlList) {
 }
 ```
 
+# Checking environment and utPLSQL version
+
+To check the framework version execute the following query:
+```sql
+select substr(ut.version(),1,60) as ut_version from dual;
+```
+
+Additionally you may retrieve more information about your environment by executing the following query:
+```sql
+select 
+  xmlserialize( content xmltype(ut_run_info()) as clob indent size = 2 )
+  from dual;
+```
+
 # Supported database versions
 
 The utPLSQL may be installed on any supported version of Oracle Database [see](http://www.oracle.com/us/support/library/lifetime-support-technology-069183.pdf#page=6)
@@ -187,9 +201,11 @@ If you have extended any utPLSQL types such as a custom reporter, these will nee
 
 The uninstall script does not drop the schema.
 
-In order for the uninstall to be successful, you need to use the uninstall script that was provided with the exact utPLSQL version installed on your database.
+**In order for the uninstall to be successful, you need to use the uninstall script that was provided with the exact utPLSQL version installed on your database.**
 i.e. the uninstall script provided with version 3.0.1 will probably not work if you want to remove version 3.0.0 from your database.
 
+Alternatively you can drop the user that owns utPLSQL and re-create it using headless install.
+
 # Version upgrade
 
 Currently, the only way to upgrade version of utPLSQL v3.0.0 and above is to remove the previous version and install the new version.
diff --git a/source/create_synonyms_and_grants_for_public.sql b/source/create_synonyms_and_grants_for_public.sql
@@ -106,6 +106,7 @@ grant select, insert, delete, update on &&ut3_owner..dbmspcc_runs   to public;
 grant select, insert, delete, update on &&ut3_owner..dbmspcc_units  to public;
 grant execute on &&ut3_owner..ut_matcher_options to public;
 grant execute on &&ut3_owner..ut_matcher_options_items to public;
+grant execute on &&ut3_owner..ut_run_info to public;
 
 prompt Creating synonyms for UTPLSQL objects in &&ut3_owner schema to PUBLIC
 
@@ -165,3 +166,4 @@ create public synonym ut_realtime_reporter for &&ut3_owner..ut_realtime_reporter
 create public synonym dbmspcc_blocks for &&ut3_owner..dbmspcc_blocks;
 create public synonym dbmspcc_runs for &&ut3_owner..dbmspcc_runs;
 create public synonym dbmspcc_units for &&ut3_owner..dbmspcc_units;
+create public synonym ut_run_info for &&ut3_owner..ut_run_info;
diff --git a/source/create_user_grants.sql b/source/create_user_grants.sql
@@ -125,4 +125,5 @@ grant select, insert, delete, update on &&ut3_owner..dbmspcc_runs to &ut3_user;
 grant select, insert, delete, update on &&ut3_owner..dbmspcc_units to &ut3_user;
 grant execute on &&ut3_owner..ut_matcher_options to &ut3_user;
 grant execute on &&ut3_owner..ut_matcher_options_items to &ut3_user;
+grant execute on &&ut3_owner..ut_run_info to &ut3_user;
 
diff --git a/source/create_user_synonyms.sql b/source/create_user_synonyms.sql
@@ -108,3 +108,4 @@ create or replace synonym &ut3_user..ut_realtime_reporter for &&ut3_owner..ut_re
 create or replace synonym &ut3_user..dbmspcc_blocks for &&ut3_owner..dbmspcc_blocks;
 create or replace synonym &ut3_user..dbmspcc_runs for &&ut3_owner..dbmspcc_runs;
 create or replace synonym &ut3_user..dbmspcc_units for &&ut3_owner..dbmspcc_units;
+create or replace synonym &ut3_user..ut_run_info for &&ut3_owner..ut_run_info;
