#127: Add logger_prefs.pref_type

Author: martindsouza

build/build.sh

@@ -85,12 +85,6 @@ printf 'PROMPT tables/logger_prefs_by_client_id.sql \n' | tee -a $INSTALL $NO_OP
 cat ../source/tables/logger_prefs_by_client_id.sql | tee -a $INSTALL $NO_OP > /dev/null
 printf '\n' | tee -a $INSTALL $NO_OP > /dev/null
 
-
-#CONTEXTS
-printf 'PROMPT contexts/logger_context.sql \n' >> $INSTALL
-cat ../source/contexts/logger_context.sql >> $INSTALL
-printf '\n' >> $INSTALL
-
 #JOBS
 printf 'PROMPT jobs/logger_purge_job.sql \n' >> $INSTALL
 cat ../source/jobs/logger_purge_job.sql >> $INSTALL
@@ -119,6 +113,14 @@ cat ../source/packages/logger.pkb >> $INSTALL
 printf '\n' >> $INSTALL
 
 
+#Recompile logger_prefs trigger as it has dependencies on logger.pks
+printf 'PROMPT Recompile biu_logger_prefs after logger.pkb \n' >> $INSTALL
+printf '\nalter trigger biu_logger_prefs compile;\n' | tee -a $INSTALL $NO_OP > /dev/null
+
+#CONTEXTS
+printf 'PROMPT contexts/logger_context.sql \n' >> $INSTALL
+cat ../source/contexts/logger_context.sql >> $INSTALL
+printf '\n' >> $INSTALL
 
 #PROCEDURES
 printf 'PROMPT procedures/logger_configure.plb \n' >> $INSTALL
@@ -151,7 +153,6 @@ printf '\n\n' >> $NO_OP
 #Recompile logger_logs_terse since it depends on logger
 printf '\nalter view logger_logs_terse compile;\n' | tee -a $INSTALL $NO_OP > /dev/null
 
-
 #Copy "other" scripts
 cp -f ../source/install/create_user.sql $RELEASE_FOLDER
 cp -f ../source/install/drop_logger.sql $RELEASE_FOLDER

demos/demo_plugin.sql

@@ -15,7 +15,9 @@ exec logger.set_level(p_level => logger.g_debug);
 
 update logger_prefs
   set pref_value = 'log_test_plugin'
-  where pref_name = 'PLUGIN_FN_ERROR';
+  where 1=1
+    and pref_type = 'LOGGER'
+    and pref_name = 'PLUGIN_FN_ERROR';
 
 exec logger_configure;
 

docs/Logger API.md

@@ -736,12 +736,13 @@ TODO
 
 <a name="procedure-get_pref"></a>
 ###GET_PREF
-Returns the preference from LOGGER_PREFS.
+Returns the preference from LOGGER_PREFS. If `p_pref_type` is not defined then the system level preferences will be returned.
 
 ####Syntax
 ```sql
 logger.get_pref(
-  p_pref_name     in  varchar2)
+  p_pref_name in logger_prefs.pref_name%type,
+  p_pref_type in logger_prefs.pref_type%type default logger.g_pref_type_logger)
   return varchar2
 ```
 
@@ -755,7 +756,11 @@ logger.get_pref(
     <td>p_pref_name</td>
     <td>Preference to get value for.</td>
   </tr>
-    <tr>
+  <tr>
+    <td>p_pref_type</td>
+    <td>Preference type</td>
+  </tr>
+  <tr>
     <td>return</td>
     <td>Prefence value.</td>
   </tr>
@@ -767,19 +772,20 @@ dbms_output.put_line('Logger level: ' || logger.get_pref('LEVEL'));
 ```
 
 
-<a name="procedure-set_cust_pref"></a>
-###SET_CUST_PREF
+<a name="procedure-set_pref"></a>
+###SET_PREF
 In some cases you may want to store custom preferences in the `LOGGER_PREFS` table. A use case for this would be when creating a plugin that needs to reference some parameters.
 
-This procedure allows you to leverage the `LOGGER_PREFS` table to store your custom preferences. To avoid any naming comflicts with Logger, all custom preferences must be prefixed with `CUST_`.
+This procedure allows you to leverage the `LOGGER_PREFS` table to store your custom preferences. To avoid any naming conflicts with Logger, you must use a type (defined in `p_pref_type`). You can not use the type `LOGGER` as it is reserved for Logger system preferences.
 
-`SET_CUST_PREF` will either create or udpate a value. Values must contain data. If not, use [`DEL_CUST_PREF`](#procedure-del_cust_pref) to delete unused preferences.
+`SET_PREF` will either create or udpate a value. Values must contain data. If not, use [`DEL_PREF`](#procedure-del_pref) to delete unused preferences.
 
 ####Syntax
 ```sql
-logger.set_cust_pref(
-  p_pref_name  in logger_prefs.pref_name%type,
-  p_pref_value in logger_prefs.pref_value%type)
+logger.set_pref(
+  p_pref_type in logger_prefs.pref_type%type,
+  p_pref_name in logger_prefs.pref_name%type,
+  p_pref_value in logger_prefs.pref_value%type);
 ```
 
 ####Parameters
@@ -788,32 +794,38 @@ logger.set_cust_pref(
     <th>Prameter</th>
     <th>Description</th>
   </tr>
+  <tr>
+    <td>p_pref_type</td>
+    <td>Type of preference. Use your own name space to avoid conflicts with Logger. Types will automatically be converted to uppercase</td>
+  </tr>
   <tr>
     <td>p_pref_name</td>
     <td>Preference to get value for. Must be prefixed with "CUST_". Value will be created or updated. This value will be stored as uppercase.</td>
   </tr>
-    <tr>
+  <tr>
     <td>p_pref_value</td>
     <td>Prefence value.</td>
   </tr>
 </table>
 
 ####Example
 ```sql
-logger.set_cust_pref(
-  p_pref_name => 'CUST_MY_PREF',
+logger.set_pref(
+  p_pref_type => 'CUSTOM'
+  p_pref_name => 'MY_PREF',
   p_pref_value => 'some value');
 ```
 
 
-<a name="procedure-del_cust_pref"></a>
-###DEL_CUST_PREF
-Deletes a custom preference.
+<a name="procedure-del_pref"></a>
+###DEL_PREF
+Deletes a preference except for system level preferences.
 
 ####Syntax
 ```sql
-logger.del_cust_pref(
-  p_pref_name  in logger_prefs.pref_name%type);
+logger.del_pref(
+  p_pref_type in logger_prefs.pref_type%type,
+  p_pref_name in logger_prefs.pref_name%type);
 ```
 
 ####Parameters
@@ -822,6 +834,10 @@ logger.del_cust_pref(
     <th>Prameter</th>
     <th>Description</th>
   </tr>
+  <tr>
+    <td>p_pref_type</td>
+    <td>Namepsace / type of preference.</td>
+  </tr>
   <tr>
     <td>p_pref_name</td>
     <td>Custom preference to delete.</td>
@@ -830,8 +846,9 @@ logger.del_cust_pref(
 
 ####Example
 ```sql
-logger.del_cust_pref(
-  p_pref_name => 'CUST_MY_PREF');
+logger.del_pref(
+  p_pref_type => 'CUSTOM'
+  p_pref_name => 'MY_PREF');
 ```
 
 

docs/Plugins.md

@@ -30,16 +30,18 @@ There are two steps to configure a plugin. The first is to register a custom fun
 ```sql
 update logger_prefs
 set pref_value = 'custom_plugin_method'
-where pref_name = 'PLUGIN_FN_ERROR'
+where 1=1
+  and pref_type = logger.g_pref_type_logger
+  and pref_name = 'PLUGIN_FN_ERROR'
 ```
 
-Once the custom method has been set in the ```logger_prefs table```, you must run the ```logger_configure``` procedure which will recompile Logger. 
+Once the custom method has been set in the `logger_prefs table`, you must run the `logger_configure` procedure which will recompile Logger.
 
 ```sql
 exec logger_configure;
 ```
 
-To deregister a plugin, set the appropriate ```logger_prefs.pref_value``` to ```null``` and re-run the ```logger_configure``` procedure. *Note: since ```pref_value``` is not a nullable column, null values will be automatically converted to "NONE".*
+To deregister a plugin, set the appropriate `logger_prefs.pref_value` to `null` and re-run the `logger_configure` procedure. *Note: since `pref_value` is not a nullable column, null values will be automatically converted to "NONE".*
 
 <a name="plugin-interface"></a>
 #Plugin Interface
@@ -50,7 +52,7 @@ procedure <name_of_procedure>(
   p_rec in logger.rec_logger_log)
 ```
 
-For more information about the ```logger.rec_logger_log``` type please see the [Types documentation](Logger%20API.md#types).
+For more information about the `logger.rec_logger_log` type please see the [Types documentation](Logger%20API.md#types).
 
 <a name="example"></a>
 #Example
@@ -69,14 +71,14 @@ as
 begin
   dbms_output.put_line('In Plugin');
   dbms_output.put_line('p_rec.id: ' || p_rec.id);
-  
+
   select text
   into l_text
   from logger_logs_5_min
   where id = p_rec.id;
-  
+
   dbms_output.put_line('Text: ' || l_text);
-  
+
 end;
 /
 ```
@@ -88,7 +90,9 @@ end;
 -- Register new plugin procedure for errors
 update logger_prefs
   set pref_value = 'log_test_plugin'
-  where pref_name = 'PLUGIN_FN_ERROR';
+  where 1=1
+    and pref_type = logger.g_pref_type_logger
+    and pref_name = 'PLUGIN_FN_ERROR';
 
 -- Configure with Logger
 exec logger_configure;
@@ -123,8 +127,8 @@ as
   l_text logger_logs.text%type;
 begin
   dbms_output.put_line('In Plugin');
-  
-  -- This will not trigger the plugin to be 
+
+  -- This will not trigger the plugin to be
   -- run again since called inside the plugin
   logger.log_error('will not trigger plugin');  
 end;
@@ -150,8 +154,8 @@ as
   l_text logger_logs.text%type;
 begin
   dbms_output.put_line('In Plugin');
- 
-  raise_application_error(-20001, 'test error'); 
+
+  raise_application_error(-20001, 'test error');
 end;
 /
 

source/contexts/logger_context.sql

@@ -1,16 +1,18 @@
-declare 
-	-- the following line is also used in a constant declaration in logger.pkb  
+declare
+	-- the following line is also used in a constant declaration in logger.pkb
 	l_ctx_name varchar2(35) := substr(sys_context('USERENV','CURRENT_SCHEMA'),1,23)||'_LOGCTX';
 begin
 	execute immediate 'create or replace context '||l_ctx_name||' using logger accessed globally';
-	
+
 	merge into logger_prefs p
-	using (select 'GLOBAL_CONTEXT_NAME' PREF_NAME,  l_ctx_name PREF_VALUE from dual) d
-		on (p.pref_name = d.pref_name)
-	when matched then 
+	using (select 'GLOBAL_CONTEXT_NAME' pref_name, l_ctx_name pref_value, logger.g_pref_type_logger pref_type from dual) d
+		on (1=1
+			and p.pref_type = d.pref_type
+			and p.pref_name = d.pref_name)
+	when matched then
 		update set p.pref_value = d.pref_value
-	when not matched then 
-		insert (p.pref_name,p.pref_value)
-		values (d.pref_name,d.pref_value);
+	when not matched then
+		insert (p.pref_name, p.pref_value, p.pref_type)
+		values (d.pref_name, d.pref_value, d.pref_type);
 end;
-/
+/

source/install/post_install_configuration.sql

@@ -10,30 +10,32 @@ end;
 PROMPT Setting Logger Level
 declare
   l_current_level logger_prefs.pref_value%type;
-begin 
+begin
 
   select pref_value
   into l_current_level
   from logger_prefs
-  where pref_name = 'LEVEL';
-  
+  where 1=1
+    and pref_type = logger.g_pref_type_logger
+    and pref_name = 'LEVEL';
+
   -- Note: Probably not necessary but pre 1.4.0 code had this in place
-  logger.set_level(l_current_level);  
+  logger.set_level(l_current_level);
 end;
 /
 
-prompt 
-prompt ************************************************* 
+prompt
+prompt *************************************************
 prompt Now executing LOGGER.STATUS...
-prompt 
+prompt
 
-begin 
-	logger.status; 
+begin
+	logger.status;
 end;
 /
 
-prompt ************************************************* 
-begin 
-	logger.log_permanent('Logger version '||logger.get_pref('LOGGER_VERSION')||' installed.'); 
+prompt *************************************************
+begin
+	logger.log_permanent('Logger version '||logger.get_pref('LOGGER_VERSION')||' installed.');
 end;
 /