CVS User Account cvsuser
Wed May 4 21:54:26 PDT 2005
Log Message:
-----------
Add in documentation for recently created functions and tables and columns.

Modified Files:
--------------
    slony1-engine/src/backend:
        slony1_base.sql (r1.25 -> r1.26)
        slony1_funcs.sql (r1.62 -> r1.63)

-------------- next part --------------
Index: slony1_base.sql
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/src/backend/slony1_base.sql,v
retrieving revision 1.25
retrieving revision 1.26
diff -Lsrc/backend/slony1_base.sql -Lsrc/backend/slony1_base.sql -u -w -r1.25 -r1.26
--- src/backend/slony1_base.sql
+++ src/backend/slony1_base.sql
@@ -31,6 +31,7 @@
 comment on column @NAMESPACE at .sl_node.no_id is 'The unique ID number for the node';  
 comment on column @NAMESPACE at .sl_node.no_active is 'Is the node active in replication yet?';  
 comment on column @NAMESPACE at .sl_node.no_comment is 'A human-oriented description of the node';
+comment on column @NAMESPACE at .sl_node.no_spool is 'Is the node being used for log shipping?';  
 
 
 -- ----------------------------------------------------------------------
@@ -234,7 +235,7 @@
 comment on column @NAMESPACE at .sl_subscribe.sub_provider is 'ID# (from sl_node) of the node providing data';
 comment on column @NAMESPACE at .sl_subscribe.sub_receiver is 'ID# (from sl_node) of the node receiving data from the provider';
 comment on column @NAMESPACE at .sl_subscribe.sub_forward is 'Does this provider keep data in sl_log_1/sl_log_2 to allow it to be a provider for other nodes?';
-comment on column @NAMESPACE at .sl_subscribe.sub_active is 'Has this subscription been activated?  This is not set until the subscriber has received COPY data from the provider';
+comment on column @NAMESPACE at .sl_subscribe.sub_active is 'Has this subscription been activated?  This is not set on the subscriber until AFTER the subscriber has received COPY data from the provider';
 
 
 -- ----------------------------------------------------------------------
@@ -285,6 +286,7 @@
 				STORE_TRIGGER		=
 				DROP_TRIGGER		=
 				MOVE_SET			=
+				ACCEPT_SET			=
 				SET_DROP_TABLE			=
 				SET_DROP_SEQUENCE		=
 				SET_MOVE_TABLE			=
@@ -367,6 +369,12 @@
 end;
 ' language plpgsql;
 
+comment on function @NAMESPACE at .sequenceLastValue(text) is
+'sequenceLastValue(p_seqname)
+
+Utility function used in sl_seqlastvalue view to compactly get the
+last value from the requested sequence.';
+
 -- ----------------------------------------------------------------------
 -- TABLE sl_log_1
 -- ----------------------------------------------------------------------
@@ -501,6 +509,8 @@
 	1		sl_log_2 active, sl_log_1 clean
 	2		sl_log_1 active, sl_log_2 unknown - cleanup
 	3		sl_log_2 active, sl_log_1 unknown - cleanup
+
+This is not yet in use.
 ';
 
 
Index: slony1_funcs.sql
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/src/backend/slony1_funcs.sql,v
retrieving revision 1.62
retrieving revision 1.63
diff -Lsrc/backend/slony1_funcs.sql -Lsrc/backend/slony1_funcs.sql -u -w -r1.62 -r1.63
--- src/backend/slony1_funcs.sql
+++ src/backend/slony1_funcs.sql
@@ -192,7 +192,11 @@
 	security definer;
 
 comment on function @NAMESPACE at .setSessionRole (name, text) is 
-  'not yet documented';
+  'setSessionRole(username, role) - set role for session.
+
+role can be "normal" or "slon"; setting the latter is necessary, on
+subscriber nodes, in order to override the denyaccess() trigger
+attached to subscribing tables.';
 
 grant execute on function @NAMESPACE at .setSessionRole (name, text) to public;
 
@@ -3097,6 +3101,11 @@
 end;
 ' language plpgsql;
 
+comment on function @NAMESPACE at .setMoveSequence (int4, int4) is
+'setMoveSequence(p_seq_id, p_new_set_id) - This generates the
+SET_MOVE_SEQUENCE event, after validation, notably that both sets
+exist, are distinct, and have exactly the same subscription lists';
+
 
 -- ----------------------------------------------------------------------
 -- FUNCTION setMoveSequence_int (seq_id, new_set_id)
@@ -3126,6 +3135,10 @@
 end;
 ' language plpgsql;
 
+comment on function @NAMESPACE at .setMoveSequence_int (int4, int4) is
+'setMoveSequence_int(p_seq_id, p_new_set_id) - processes the
+SET_MOVE_SEQUENCE event, moving a sequence to another replication
+set.';
 
 -- ----------------------------------------------------------------------
 -- FUNCTION sequenceSetValue (seq_id, seq_origin, ev_seqno, last_value)
@@ -4833,7 +4846,7 @@
 ' language plpgsql;
 
 comment on function @NAMESPACE at .generate_sync_event(interval) is
-  'Generate a sync event if there has not been one in 30 seconds.';
+  'Generate a sync event if there has not been one in the requested interval.';
 
 -- ----------------------------------------------------------------------
 -- FUNCTION tableHasSerialKey (tab_fqname)


More information about the Slony1-commit mailing list