Add an optional parameter to pg_start_backup() that specifies whether to do
authorTom Lane
Tue, 7 Apr 2009 00:31:26 +0000 (00:31 +0000)
committerTom Lane
Tue, 7 Apr 2009 00:31:26 +0000 (00:31 +0000)
the checkpoint in immediate or lazy mode.  This is to address complaints
that pg_start_backup() takes a long time even when there's no need to minimize
its I/O consumption.

doc/src/sgml/backup.sgml
doc/src/sgml/func.sgml
src/backend/access/transam/xlog.c
src/backend/catalog/system_views.sql
src/include/catalog/catversion.h
src/include/catalog/pg_proc.h

index 51c3f909b31c7b9b06e4d02e5524329a986cb0b2..ae9563a8e385f7c4c4c43a7ac4bd36dd87593997 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
 
  Backup and Restore
@@ -730,19 +730,19 @@ SELECT pg_start_backup('label');
     
 
     
-     pg_start_backup can take a long time to finish.
+     By default, pg_start_backup can take a long time to finish.
      This is because it performs a checkpoint, and the I/O
-     required for a checkpoint will be spread out over a significant
+     required for the checkpoint will be spread out over a significant
      period of time, by default half your inter-checkpoint interval
      (see the configuration parameter
      ).  Usually
-     this is what you want because it minimizes the impact on query
+     this is what you want, because it minimizes the impact on query
      processing.  If you just want to start the backup as soon as
-     possible, execute a CHECKPOINT command
-     (which performs a checkpoint as quickly as possible) and then
-     immediately execute pg_start_backup.  Then there
-     will be very little for pg_start_backup's checkpoint
-     to do, and it won't take long.
+     possible, use:
+
+SELECT pg_start_backup('label', true);
+
+     This forces the checkpoint to be done as quickly as possible.
     
    
    
@@ -769,9 +769,9 @@ SELECT pg_stop_backup();
     
      Once the WAL segment files used during the backup are archived, you are
      done.  The file identified by pg_stop_backup's result is
-     the last segment that is required to form a complete set of backup files. 
+     the last segment that is required to form a complete set of backup files.
      pg_stop_backup does not return until the last segment has
-     been archived. 
+     been archived.
      Archiving of these files happens automatically since you have
      already configured archive_command. In most cases this
      happens quickly, but you are advised to monitor your archive
index bd05152f78333402975b770adeff5a2d65972b3d..f42f3e9341217695ca665f1b24dbf61a419a64ee 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
  
   Functions and Operators
@@ -12880,10 +12880,10 @@ SELECT set_config('log_statement_stats', 'off', false);
      
       
        
-        pg_start_backup(label text)
+        pg_start_backup(label text fast boolean )
         
        text
-       Set up for performing on-line backup
+       Prepare for performing on-line backup
       
       
        
@@ -12932,13 +12932,14 @@ SELECT set_config('log_statement_stats', 'off', false);
    
 
    
-    pg_start_backup accepts a single parameter which is an
+    pg_start_backup accepts a text parameter which is an
     arbitrary user-defined label for the backup.  (Typically this would be
     the name under which the backup dump file will be stored.)  The function
     writes a backup label file into the database cluster's data directory,
-    and then returns the backup's starting transaction log location as text.  The user
-    need not pay any attention to this result value, but it is provided in
-    case it is of use. 
+    performs a checkpoint,
+    and then returns the backup's starting transaction log location as text.
+    The user need not pay any attention to this result value, but it is
+    provided in case it is of use.
 
 postgres=# select pg_start_backup('label_goes_here');
  pg_start_backup
@@ -12946,6 +12947,10 @@ postgres=# select pg_start_backup('label_goes_here');
  0/D4445B8
 (1 row)
 
+    There is an optional boolean second parameter.  If true,
+    it specifies executing pg_start_backup as quickly as
+    possible.  This forces an immediate checkpoint which will cause a
+    spike in I/O operations, slowing any concurrently executing queries.
    
 
    
@@ -12961,7 +12966,7 @@ postgres=# select pg_start_backup('label_goes_here');
    
 
    
-    pg_switch_xlog moves to the next transaction log file, allowing the 
+    pg_switch_xlog moves to the next transaction log file, allowing the
     current file to be archived (assuming you are using continuous archiving).
     The result is the ending transaction log location + 1 within the just-completed transaction log file.
     If there has been no transaction log activity since the last transaction log switch,
index 3027129eb7c1523ee822b3f3981e6d8a60f9457c..65484b6f70d89bd9791b964e6813c12d3a8a1d19 100644 (file)
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/backend/access/transam/xlog.c,v 1.334 2009/03/11 23:19:24 tgl Exp $
+ * $PostgreSQL: pgsql/src/backend/access/transam/xlog.c,v 1.335 2009/04/07 00:31:26 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -6914,6 +6914,7 @@ Datum
 pg_start_backup(PG_FUNCTION_ARGS)
 {
    text       *backupid = PG_GETARG_TEXT_P(0);
+   bool        fast = PG_GETARG_BOOL(1);
    char       *backupidstr;
    XLogRecPtr  checkpointloc;
    XLogRecPtr  startpoint;
@@ -6983,9 +6984,11 @@ pg_start_backup(PG_FUNCTION_ARGS)
         * have different checkpoint positions and hence different history
         * file names, even if nothing happened in between.
         *
-        * We don't use CHECKPOINT_IMMEDIATE, hence this can take awhile.
+        * We use CHECKPOINT_IMMEDIATE only if requested by user (via
+        * passing fast = true).  Otherwise this can take awhile.
         */
-       RequestCheckpoint(CHECKPOINT_FORCE | CHECKPOINT_WAIT);
+       RequestCheckpoint(CHECKPOINT_FORCE | CHECKPOINT_WAIT |
+                         (fast ? CHECKPOINT_IMMEDIATE : 0));
 
        /*
         * Now we need to fetch the checkpoint record location, and also its
index 897d930bfeb03ef091e5d4835e4a8cf54f4b6b29..73e391c896878fa71b3f08567a6df492ae49ce06 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 1996-2009, PostgreSQL Global Development Group
  *
- * $PostgreSQL: pgsql/src/backend/catalog/system_views.sql,v 1.59 2009/02/06 21:15:11 tgl Exp $
+ * $PostgreSQL: pgsql/src/backend/catalog/system_views.sql,v 1.60 2009/04/07 00:31:26 tgl Exp $
  */
 
 CREATE VIEW pg_roles AS 
@@ -403,6 +403,12 @@ CREATE VIEW pg_user_mappings AS
 
 REVOKE ALL on pg_user_mapping FROM public;
 
+--
+-- We have a few function definitions in here, too.
+-- At some point there might be enough to justify breaking them out into
+-- a separate "system_functions.sql" file.
+--
+
 -- Tsearch debug function.  Defined here because it'd be pretty unwieldy
 -- to put it into pg_proc.h
 
@@ -464,3 +470,16 @@ LANGUAGE SQL STRICT STABLE;
 
 COMMENT ON FUNCTION ts_debug(text) IS
     'debug function for current text search configuration';
+
+--
+-- Redeclare built-in functions that need default values attached to their
+-- arguments.  It's impractical to set those up directly in pg_proc.h because
+-- of the complexity and platform-dependency of the expression tree
+-- representation.  (Note that internal functions still have to have entries
+-- in pg_proc.h; we are merely causing their proargnames and proargdefaults
+-- to get filled in.)
+--
+
+CREATE OR REPLACE FUNCTION
+  pg_start_backup(label text, fast boolean DEFAULT false)
+  RETURNS text STRICT VOLATILE LANGUAGE internal AS 'pg_start_backup';
index 95bd0ddb6b97e7f1ea32996bc657e07eda940919..64c6e08e4529cc18ec0cc70d7f460a0145e3b887 100644 (file)
@@ -37,7 +37,7 @@
  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/catalog/catversion.h,v 1.528 2009/04/05 22:28:59 tgl Exp $
+ * $PostgreSQL: pgsql/src/include/catalog/catversion.h,v 1.529 2009/04/07 00:31:26 tgl Exp $
  *
  *-------------------------------------------------------------------------
  */
@@ -53,6 +53,6 @@
  */
 
 /*                         yyyymmddN */
-#define CATALOG_VERSION_NO 200904051
+#define CATALOG_VERSION_NO 200904061
 
 #endif
index 00c82673706298d0cd0ca1383c875447963b43ce..fb711375a07a2d5849d2f28d95fb50eb681b1037 100644 (file)
@@ -7,7 +7,7 @@
  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/catalog/pg_proc.h,v 1.540 2009/04/05 22:28:59 tgl Exp $
+ * $PostgreSQL: pgsql/src/include/catalog/pg_proc.h,v 1.541 2009/04/07 00:31:26 tgl Exp $
  *
  * NOTES
  *   The script catalog/genbki.sh reads this file and generates .bki
@@ -3252,7 +3252,7 @@ DATA(insert OID = 2171 ( pg_cancel_backend        PGNSP PGUID 12 1 0 0 f f f t f v 1 0
 DESCR("cancel a server process' current query");
 DATA(insert OID = 2096 ( pg_terminate_backend      PGNSP PGUID 12 1 0 0 f f f t f v 1 0 16 "23" _null_ _null_ _null_ _null_ pg_terminate_backend _null_ _null_ _null_ ));
 DESCR("terminate a server process");
-DATA(insert OID = 2172 ( pg_start_backup       PGNSP PGUID 12 1 0 0 f f f t f v 1 0 25 "25" _null_ _null_ _null_ _null_ pg_start_backup _null_ _null_ _null_ ));
+DATA(insert OID = 2172 ( pg_start_backup       PGNSP PGUID 12 1 0 0 f f f t f v 2 0 25 "25 16" _null_ _null_ _null_ _null_ pg_start_backup _null_ _null_ _null_ ));
 DESCR("prepare for taking an online backup");
 DATA(insert OID = 2173 ( pg_stop_backup            PGNSP PGUID 12 1 0 0 f f f t f v 0 0 25 "" _null_ _null_ _null_ _null_ pg_stop_backup _null_ _null_ _null_ ));
 DESCR("finish taking an online backup");