commit 759fd9b0b031ae7b293854bcb09ed1317ddc3d55 · pyrox.dev/nixpkgs

+45 -2

nixos/modules/services/databases/postgresql.xml

···

       63
        
         <title>Upgrading</title>

     

       64
        
       

     

       65
        
         <para>

     

       66
       -
          FIXME: document dump/upgrade/load cycle.

     

       67
       -
         </para>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       68
        
        </section>

     

       69
        
        <section xml:id="module-services-postgres-options">

     

       70
        
         <title>Options</title>

···

       63
        
         <title>Upgrading</title>

     

       64
        
       

     

       65
        
         <para>

     

       66
       +
          Major PostgreSQL upgrade requires PostgreSQL downtime and a few imperative steps to be called. To simplify this process, use the following NixOS module:

     

       67
       +
       

     

       68
       +
       <programlisting>

     

       69
       +
         containers.temp-pg.config.services.postgresql = {

     

       70
       +
           enable = true;

     

       71
       +
           package = pkgs.postgresql_12;

     

       72
       +
           ## set a custom new dataDir

     

       73
       +
           # dataDir = "/some/data/dir";

     

       74
       +
         };

     

       75
       +
         environment.systemPackages =

     

       76
       +
           let newpg = config.containers.temp-pg.config.services.postgresql;

     

       77
       +
           in [

     

       78
       +
             (pkgs.writeScriptBin "upgrade-pg-cluster" ''

     

       79
       +
               set -x

     

       80
       +
               export OLDDATA="${config.services.postgresql.dataDir}"

     

       81
       +
               export NEWDATA="${newpg.dataDir}"

     

       82
       +
               export OLDBIN="${config.services.postgresql.package}/bin"

     

       83
       +
               export NEWBIN="${newpg.package}/bin"

     

       84
       +
       

     

       85
       +
               install -d -m 0700 -o postgres -g postgres "$NEWDATA"

     

       86
       +
               cd "$NEWDATA"

     

       87
       +
               sudo -u postgres $NEWBIN/initdb -D "$NEWDATA"

     

       88
       +
       

     

       89
       +
               systemctl stop postgresql    # old one

     

       90
       +
       

     

       91
       +
               sudo -u postgres $NEWBIN/pg_upgrade \

     

       92
       +
                 --old-datadir "$OLDDATA" --new-datadir "$NEWDATA" \

     

       93
       +
                 --old-bindir $OLDBIN --new-bindir $NEWBIN \

     

       94
       +
                 "$@"

     

       95
       +
             '')

     

       96
       +
           ];

     

       97
       +
       </programlisting>

     

       98
       +
           </para>

     

       99
       +
         <para>

     

       100
       +
             The upgrade process is:</para>

     

       101
       +
       

     

       102
       +
         <orderedlist>

     

       103
       +
             <listitem><para>Rebuild nixos configuration with the configuration above added to your <filename>configuration.nix</filename>. Alternatively, add that into separate file and reference it in <literal>imports</literal> list.</para></listitem>

     

       104
       +
                 <listitem><para>Login as root (<literal>sudo su -</literal>)</para></listitem>

     

       105
       +
                     <listitem><para>Run <literal>upgrade-pg-cluster</literal>. It will stop old postgresql, initialize new one and migrate old one to new one. You may supply arguments like <literal>--jobs 4</literal> and <literal>--link</literal> to speedup migration process. See <link xlink:href="https://www.postgresql.org/docs/current/pgupgrade.html" /> for details.</para></listitem>

     

       106
       +
                         <listitem><para>Change postgresql package in NixOS configuration to the one you were upgrading to, and change <literal>dataDir</literal> to the one you have migrated to. Rebuild NixOS. This should start new postgres using upgraded data directory.</para></listitem>

     

       107
       +
                             <listitem><para>After upgrade you may want to <literal>ANALYZE</literal> new db.</para></listitem>

     

       108
       +
         </orderedlist>

     

       109
       +
         

     

       110
       +
       

     

       111
        
        </section>

     

       112
        
        <section xml:id="module-services-postgres-options">

     

       113
        
         <title>Options</title>