Add documentation for pg_cancel_backend and pg_terminate_backend.
authorTom Lane
Thu, 24 Jun 2004 19:57:14 +0000 (19:57 +0000)
committerTom Lane
Thu, 24 Jun 2004 19:57:14 +0000 (19:57 +0000)
Magnus Hagander

doc/src/sgml/func.sgml

index 3de1adafc9a786f6429931284a1d2a3a0fa34aa2..106c4cf775fa5f945225f7b965f453e225272a87 100644 (file)
@@ -1,5 +1,5 @@
 
 
@@ -7406,6 +7406,60 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
     columns do not have OIDs of their own.
    
 
+   
+    pg_cancel_backend
+   
+
+   
+    pg_terminate_backend
+   
+
+   
+    signal
+    backend processes
+   
+
+   
+    The functions shown in 
+    linkend="functions-misc-signal-table"> send control signals to
+    other server processes.  Use of these functions is restricted
+    to superusers.
+   
+
+   
+    Backend Signalling Functions
+    
+     
+      Name Return Type Description
+      
+     
+
+     
+      
+       
+   pg_cancel_backend(pid)
+   
+       int
+       Cancel a backend's current query
+      
+      
+       
+   pg_terminate_backend(pid)
+       
+       int
+       Terminate a backend process
+      
+     
+    
+   
+
+   
+    These functions return 1 if successful, 0 if not successful.
+    The process ID (pid) of an active backend can be found
+    from the procpid column in the
+    pg_stat_activity view, or by listing the postgres
+    processes on the server.
+