commit 453b2bed053dfdeb9d21d8c10e7eebe9ff446217 · pyrox.dev/nixpkgs

+173

nixos/modules/services/databases/postgresql.md

···

       1
       1
       +
       # PostgreSQL {#module-postgresql}

     

       2
       2
       +
       

     

       3
       3
       +
       <!-- FIXME: render nicely -->

     

       4
       4
       +
       <!-- FIXME: source can be added automatically -->

     

       5
       5
       +
       

     

       6
       6
       +
       *Source:* {file}`modules/services/databases/postgresql.nix`

     

       7
       7
       +
       

     

       8
       8
       +
       *Upstream documentation:* <http://www.postgresql.org/docs/>

     

       9
       9
       +
       

     

       10
       10
       +
       <!-- FIXME: more stuff, like maintainer? -->

     

       11
       11
       +
       

     

       12
       12
       +
       PostgreSQL is an advanced, free relational database.

     

       13
       13
       +
       <!-- MORE -->

     

       14
       14
       +
       

     

       15
       15
       +
       ## Configuring {#module-services-postgres-configuring}

     

       16
       16
       +
       

     

       17
       17
       +
       To enable PostgreSQL, add the following to your {file}`configuration.nix`:

     

       18
       18
       +
       ```

     

       19
       19
       +
       services.postgresql.enable = true;

     

       20
       20
       +
       services.postgresql.package = pkgs.postgresql_11;

     

       21
       21
       +
       ```

     

       22
       22
       +
       Note that you are required to specify the desired version of PostgreSQL (e.g. `pkgs.postgresql_11`). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for [](#opt-services.postgresql.package) such as the most recent release of PostgreSQL.

     

       23
       23
       +
       

     

       24
       24
       +
       <!--

     

       25
       25
       +
       After running {command}`nixos-rebuild`, you can verify

     

       26
       26
       +
       whether PostgreSQL works by running {command}`psql`:

     

       27
       27
       +
       

     

       28
       28
       +
       ```ShellSession

     

       29
       29
       +
       $ psql

     

       30
       30
       +
       psql (9.2.9)

     

       31
       31
       +
       Type "help" for help.

     

       32
       32
       +
       

     

       33
       33
       +
       alice=>

     

       34
       34
       +
       ```

     

       35
       35
       +
       -->

     

       36
       36
       +
       

     

       37
       37
       +
       By default, PostgreSQL stores its databases in {file}`/var/lib/postgresql/$psqlSchema`. You can override this using [](#opt-services.postgresql.dataDir), e.g.

     

       38
       38
       +
       ```

     

       39
       39
       +
       services.postgresql.dataDir = "/data/postgresql";

     

       40
       40
       +
       ```

     

       41
       41
       +
       

     

       42
       42
       +
       ## Upgrading {#module-services-postgres-upgrading}

     

       43
       43
       +
       

     

       44
       44
       +
       ::: {.note}

     

       45
       45
       +
       The steps below demonstrate how to upgrade from an older version to `pkgs.postgresql_13`.

     

       46
       46
       +
       These instructions are also applicable to other versions.

     

       47
       47
       +
       :::

     

       48
       48
       +
       

     

       49
       49
       +
       Major PostgreSQL upgrades require a downtime and a few imperative steps to be called. This is the case because

     

       50
       50
       +
       each major version has some internal changes in the databases' state during major releases. Because of that,

     

       51
       51
       +
       NixOS places the state into {file}`/var/lib/postgresql/&lt;version&gt;` where each `version`

     

       52
       52
       +
       can be obtained like this:

     

       53
       53
       +
       ```

     

       54
       54
       +
       $ nix-instantiate --eval -A postgresql_13.psqlSchema

     

       55
       55
       +
       "13"

     

       56
       56
       +
       ```

     

       57
       57
       +
       For an upgrade, a script like this can be used to simplify the process:

     

       58
       58
       +
       ```

     

       59
       59
       +
       { config, pkgs, ... }:

     

       60
       60
       +
       {

     

       61
       61
       +
         environment.systemPackages = [

     

       62
       62
       +
           (let

     

       63
       63
       +
             # XXX specify the postgresql package you'd like to upgrade to.

     

       64
       64
       +
             # Do not forget to list the extensions you need.

     

       65
       65
       +
             newPostgres = pkgs.postgresql_13.withPackages (pp: [

     

       66
       66
       +
               # pp.plv8

     

       67
       67
       +
             ]);

     

       68
       68
       +
           in pkgs.writeScriptBin "upgrade-pg-cluster" ''

     

       69
       69
       +
             set -eux

     

       70
       70
       +
             # XXX it's perhaps advisable to stop all services that depend on postgresql

     

       71
       71
       +
             systemctl stop postgresql

     

       72
       72
       +
       

     

       73
       73
       +
             export NEWDATA="/var/lib/postgresql/${newPostgres.psqlSchema}"

     

       74
       74
       +
       

     

       75
       75
       +
             export NEWBIN="${newPostgres}/bin"

     

       76
       76
       +
       

     

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

     

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

     

       79
       79
       +
       

     

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

     

       81
       81
       +
             cd "$NEWDATA"

     

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

     

       83
       83
       +
       

     

       84
       84
       +
             sudo -u postgres $NEWBIN/pg_upgrade \

     

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

     

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

     

       87
       87
       +
               "$@"

     

       88
       88
       +
           '')

     

       89
       89
       +
         ];

     

       90
       90
       +
       }

     

       91
       91
       +
       ```

     

       92
       92
       +
       

     

       93
       93
       +
       The upgrade process is:

     

       94
       94
       +
       

     

       95
       95
       +
         1. Rebuild nixos configuration with the configuration above added to your {file}`configuration.nix`. Alternatively, add that into separate file and reference it in `imports` list.

     

       96
       96
       +
         2. Login as root (`sudo su -`)

     

       97
       97
       +
         3. Run `upgrade-pg-cluster`. It will stop old postgresql, initialize a new one and migrate the old one to the new one. You may supply arguments like `--jobs 4` and `--link` to speedup migration process. See <https://www.postgresql.org/docs/current/pgupgrade.html> for details.

     

       98
       98
       +
         4. Change postgresql package in NixOS configuration to the one you were upgrading to via [](#opt-services.postgresql.package). Rebuild NixOS. This should start new postgres using upgraded data directory and all services you stopped during the upgrade.

     

       99
       99
       +
         5. After the upgrade it's advisable to analyze the new cluster.

     

       100
       100
       +
       

     

       101
       101
       +
              - For PostgreSQL ≥ 14, use the `vacuumdb` command printed by the upgrades script.

     

       102
       102
       +
              - For PostgreSQL < 14, run (as `su -l postgres` in the [](#opt-services.postgresql.dataDir), in this example {file}`/var/lib/postgresql/13`):

     

       103
       103
       +
       

     

       104
       104
       +
                ```

     

       105
       105
       +
                $ ./analyze_new_cluster.sh

     

       106
       106
       +
                ```

     

       107
       107
       +
       

     

       108
       108
       +
            ::: {.warning}

     

       109
       109
       +
            The next step removes the old state-directory!

     

       110
       110
       +
            :::

     

       111
       111
       +
       

     

       112
       112
       +
            ```

     

       113
       113
       +
            $ ./delete_old_cluster.sh

     

       114
       114
       +
            ```

     

       115
       115
       +
       

     

       116
       116
       +
       ## Options {#module-services-postgres-options}

     

       117
       117
       +
       

     

       118
       118
       +
       A complete list of options for the PostgreSQL module may be found [here](#opt-services.postgresql.enable).

     

       119
       119
       +
       

     

       120
       120
       +
       ## Plugins {#module-services-postgres-plugins}

     

       121
       121
       +
       

     

       122
       122
       +
       Plugins collection for each PostgreSQL version can be accessed with `.pkgs`. For example, for `pkgs.postgresql_11` package, its plugin collection is accessed by `pkgs.postgresql_11.pkgs`:

     

       123
       123
       +
       ```ShellSession

     

       124
       124
       +
       $ nix repl '<nixpkgs>'

     

       125
       125
       +
       

     

       126
       126
       +
       Loading '<nixpkgs>'...

     

       127
       127
       +
       Added 10574 variables.

     

       128
       128
       +
       

     

       129
       129
       +
       nix-repl> postgresql_11.pkgs.<TAB><TAB>

     

       130
       130
       +
       postgresql_11.pkgs.cstore_fdw        postgresql_11.pkgs.pg_repack

     

       131
       131
       +
       postgresql_11.pkgs.pg_auto_failover  postgresql_11.pkgs.pg_safeupdate

     

       132
       132
       +
       postgresql_11.pkgs.pg_bigm           postgresql_11.pkgs.pg_similarity

     

       133
       133
       +
       postgresql_11.pkgs.pg_cron           postgresql_11.pkgs.pg_topn

     

       134
       134
       +
       postgresql_11.pkgs.pg_hll            postgresql_11.pkgs.pgjwt

     

       135
       135
       +
       postgresql_11.pkgs.pg_partman        postgresql_11.pkgs.pgroonga

     

       136
       136
       +
       ...

     

       137
       137
       +
       ```

     

       138
       138
       +
       

     

       139
       139
       +
       To add plugins via NixOS configuration, set `services.postgresql.extraPlugins`:

     

       140
       140
       +
       ```

     

       141
       141
       +
       services.postgresql.package = pkgs.postgresql_11;

     

       142
       142
       +
       services.postgresql.extraPlugins = with pkgs.postgresql_11.pkgs; [

     

       143
       143
       +
         pg_repack

     

       144
       144
       +
         postgis

     

       145
       145
       +
       ];

     

       146
       146
       +
       ```

     

       147
       147
       +
       

     

       148
       148
       +
       You can build custom PostgreSQL-with-plugins (to be used outside of NixOS) using function `.withPackages`. For example, creating a custom PostgreSQL package in an overlay can look like:

     

       149
       149
       +
       ```

     

       150
       150
       +
       self: super: {

     

       151
       151
       +
         postgresql_custom = self.postgresql_11.withPackages (ps: [

     

       152
       152
       +
           ps.pg_repack

     

       153
       153
       +
           ps.postgis

     

       154
       154
       +
         ]);

     

       155
       155
       +
       }

     

       156
       156
       +
       ```

     

       157
       157
       +
       

     

       158
       158
       +
       Here's a recipe on how to override a particular plugin through an overlay:

     

       159
       159
       +
       ```

     

       160
       160
       +
       self: super: {

     

       161
       161
       +
         postgresql_11 = super.postgresql_11.override { this = self.postgresql_11; } // {

     

       162
       162
       +
           pkgs = super.postgresql_11.pkgs // {

     

       163
       163
       +
             pg_repack = super.postgresql_11.pkgs.pg_repack.overrideAttrs (_: {

     

       164
       164
       +
               name = "pg_repack-v20181024";

     

       165
       165
       +
               src = self.fetchzip {

     

       166
       166
       +
                 url = "https://github.com/reorg/pg_repack/archive/923fa2f3c709a506e111cc963034bf2fd127aa00.tar.gz";

     

       167
       167
       +
                 sha256 = "17k6hq9xaax87yz79j773qyigm4fwk8z4zh5cyp6z0sxnwfqxxw5";

     

       168
       168
       +
               };

     

       169
       169
       +
             });

     

       170
       170
       +
           };

     

       171
       171
       +
         };

     

       172
       172
       +
       }

     

       173
       173
       +
       ```

nixos/modules/services/databases/postgresql.nix

···

       585
       585
        
       

     

       586
       586
        
         };

     

       587
       587
        
       

     

       588
       588
       +
         # Don't edit the docbook xml directly, edit the md and generate it:

     

       589
       589
       +
         # `pandoc postgresql.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > postgresql.xml`

     

       588
       590
        
         meta.doc = ./postgresql.xml;

     

       589
       591
        
         meta.maintainers = with lib.maintainers; [ thoughtpolice danbst ];

     

       590
       592
        
       }

+179 -160

nixos/modules/services/databases/postgresql.xml

···

       1
       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
                version="5.0"

     

       5
       5
       -
                xml:id="module-postgresql">

     

       6
       6
       -
        <title>PostgreSQL</title>

     

       7
       7
       -
       <!-- FIXME: render nicely -->

     

       8
       8
       -
       <!-- FIXME: source can be added automatically -->

     

       9
       9
       -
        <para>

     

       10
       10
       -
         <emphasis>Source:</emphasis> <filename>modules/services/databases/postgresql.nix</filename>

     

       11
       11
       -
        </para>

     

       12
       12
       -
        <para>

     

       13
       13
       -
         <emphasis>Upstream documentation:</emphasis> <link xlink:href="http://www.postgresql.org/docs/"/>

     

       14
       14
       -
        </para>

     

       15
       15
       -
       <!-- FIXME: more stuff, like maintainer? -->

     

       16
       16
       -
        <para>

     

       17
       17
       -
         PostgreSQL is an advanced, free relational database.

     

       18
       18
       -
       <!-- MORE -->

     

       19
       19
       -
        </para>

     

       20
       20
       -
        <section xml:id="module-services-postgres-configuring">

     

       21
       21
       -
         <title>Configuring</title>

     

       22
       22
       -
       

     

       1
       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-postgresql">

     

       2
       2
       +
         <title>PostgreSQL</title>

     

       23
       3
        
         <para>

     

       24
       24
       -
          To enable PostgreSQL, add the following to your <filename>configuration.nix</filename>:

     

       25
       25
       -
       <programlisting>

     

       26
       26
       -
       services.postgresql.enable = true;

     

       27
       27
       -
       services.postgresql.package = pkgs.postgresql_11;

     

       28
       28
       -
       </programlisting>

     

       29
       29
       -
          Note that you are required to specify the desired version of PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for <xref linkend="opt-services.postgresql.package"/> such as the most recent release of PostgreSQL.

     

       4
       4
       +
           <emphasis>Source:</emphasis>

     

       5
       5
       +
           <filename>modules/services/databases/postgresql.nix</filename>

     

       30
       6
        
         </para>

     

       31
       31
       -
       

     

       32
       32
       -
       <!--

     

       33
       33
       -
       <para>After running <command>nixos-rebuild</command>, you can verify

     

       34
       34
       -
       whether PostgreSQL works by running <command>psql</command>:

     

       35
       35
       -
       

     

       36
       36
       -
       <screen>

     

       37
       37
       -
       <prompt>$ </prompt>psql

     

       38
       38
       -
       psql (9.2.9)

     

       39
       39
       -
       Type "help" for help.

     

       40
       40
       -
       

     

       41
       41
       -
       <prompt>alice=></prompt>

     

       42
       42
       -
       </screen>

     

       43
       43
       -
       -->

     

       44
       44
       -
       

     

       45
       7
        
         <para>

     

       46
       46
       -
          By default, PostgreSQL stores its databases in <filename>/var/lib/postgresql/$psqlSchema</filename>. You can override this using <xref linkend="opt-services.postgresql.dataDir"/>, e.g.

     

       47
       47
       -
       <programlisting>

     

       48
       48
       -
       services.postgresql.dataDir = "/data/postgresql";

     

       49
       49
       -
       </programlisting>

     

       8
       8
       +
           <emphasis>Upstream documentation:</emphasis>

     

       9
       9
       +
           <link xlink:href="http://www.postgresql.org/docs/" role="uri">http://www.postgresql.org/docs/</link>

     

       50
       10
        
         </para>

     

       51
       51
       -
        </section>

     

       52
       52
       -
        <section xml:id="module-services-postgres-upgrading">

     

       53
       53
       -
         <title>Upgrading</title>

     

       54
       54
       -
       

     

       55
       55
       -
         <note>

     

       56
       56
       -
          <para>

     

       57
       57
       -
           The steps below demonstrate how to upgrade from an older version to <literal>pkgs.postgresql_13</literal>.

     

       58
       58
       -
           These instructions are also applicable to other versions.

     

       59
       59
       -
          </para>

     

       60
       60
       -
         </note>

     

       61
       11
        
         <para>

     

       62
       62
       -
          Major PostgreSQL upgrades require a downtime and a few imperative steps to be called. This is the case because

     

       63
       63
       -
          each major version has some internal changes in the databases' state during major releases. Because of that,

     

       64
       64
       -
          NixOS places the state into <filename>/var/lib/postgresql/&lt;version&gt;</filename> where each <literal>version</literal>

     

       65
       65
       -
          can be obtained like this:

     

       66
       66
       -
       <programlisting>

     

       67
       67
       -
       <prompt>$ </prompt>nix-instantiate --eval -A postgresql_13.psqlSchema

     

       68
       68
       -
       "13"

     

       12
       12
       +
           PostgreSQL is an advanced, free relational database. <!-- MORE -->

     

       13
       13
       +
         </para>

     

       14
       14
       +
         <section xml:id="module-services-postgres-configuring">

     

       15
       15
       +
           <title>Configuring</title>

     

       16
       16
       +
           <para>

     

       17
       17
       +
             To enable PostgreSQL, add the following to your

     

       18
       18
       +
             <filename>configuration.nix</filename>:

     

       19
       19
       +
           </para>

     

       20
       20
       +
           <programlisting>

     

       21
       21
       +
       services.postgresql.enable = true;

     

       22
       22
       +
       services.postgresql.package = pkgs.postgresql_11;

     

       69
       23
        
       </programlisting>

     

       70
       70
       -
          For an upgrade, a script like this can be used to simplify the process:

     

       71
       71
       -
       <programlisting>

     

       24
       24
       +
           <para>

     

       25
       25
       +
             Note that you are required to specify the desired version of

     

       26
       26
       +
             PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since

     

       27
       27
       +
             upgrading your PostgreSQL version requires a database dump and

     

       28
       28
       +
             reload (see below), NixOS cannot provide a default value for

     

       29
       29
       +
             <xref linkend="opt-services.postgresql.package"></xref> such as

     

       30
       30
       +
             the most recent release of PostgreSQL.

     

       31
       31
       +
           </para>

     

       32
       32
       +
           <para>

     

       33
       33
       +
             By default, PostgreSQL stores its databases in

     

       34
       34
       +
             <filename>/var/lib/postgresql/$psqlSchema</filename>. You can

     

       35
       35
       +
             override this using

     

       36
       36
       +
             <xref linkend="opt-services.postgresql.dataDir"></xref>, e.g.

     

       37
       37
       +
           </para>

     

       38
       38
       +
           <programlisting>

     

       39
       39
       +
       services.postgresql.dataDir = &quot;/data/postgresql&quot;;

     

       40
       40
       +
       </programlisting>

     

       41
       41
       +
         </section>

     

       42
       42
       +
         <section xml:id="module-services-postgres-upgrading">

     

       43
       43
       +
           <title>Upgrading</title>

     

       44
       44
       +
           <note>

     

       45
       45
       +
             <para>

     

       46
       46
       +
               The steps below demonstrate how to upgrade from an older version

     

       47
       47
       +
               to <literal>pkgs.postgresql_13</literal>. These instructions are

     

       48
       48
       +
               also applicable to other versions.

     

       49
       49
       +
             </para>

     

       50
       50
       +
           </note>

     

       51
       51
       +
           <para>

     

       52
       52
       +
             Major PostgreSQL upgrades require a downtime and a few imperative

     

       53
       53
       +
             steps to be called. This is the case because each major version

     

       54
       54
       +
             has some internal changes in the databases' state during major

     

       55
       55
       +
             releases. Because of that, NixOS places the state into

     

       56
       56
       +
             <filename>/var/lib/postgresql/&lt;version&gt;</filename> where

     

       57
       57
       +
             each <literal>version</literal> can be obtained like this:

     

       58
       58
       +
           </para>

     

       59
       59
       +
           <programlisting>

     

       60
       60
       +
       $ nix-instantiate --eval -A postgresql_13.psqlSchema

     

       61
       61
       +
       &quot;13&quot;

     

       62
       62
       +
       </programlisting>

     

       63
       63
       +
           <para>

     

       64
       64
       +
             For an upgrade, a script like this can be used to simplify the

     

       65
       65
       +
             process:

     

       66
       66
       +
           </para>

     

       67
       67
       +
           <programlisting>

     

       72
       68
        
       { config, pkgs, ... }:

     

       73
       69
        
       {

     

       74
       70
        
         environment.systemPackages = [

     
···

       78
       74
        
             newPostgres = pkgs.postgresql_13.withPackages (pp: [

     

       79
       75
        
               # pp.plv8

     

       80
       76
        
             ]);

     

       81
       81
       -
           in pkgs.writeScriptBin "upgrade-pg-cluster" ''

     

       77
       77
       +
           in pkgs.writeScriptBin &quot;upgrade-pg-cluster&quot; ''

     

       82
       78
        
             set -eux

     

       83
       79
        
             # XXX it's perhaps advisable to stop all services that depend on postgresql

     

       84
       80
        
             systemctl stop postgresql

     

       85
       81
        
       

     

       86
       86
       -
             export NEWDATA="/var/lib/postgresql/${newPostgres.psqlSchema}"

     

       82
       82
       +
             export NEWDATA=&quot;/var/lib/postgresql/${newPostgres.psqlSchema}&quot;

     

       87
       83
        
       

     

       88
       88
       -
             export NEWBIN="${newPostgres}/bin"

     

       84
       84
       +
             export NEWBIN=&quot;${newPostgres}/bin&quot;

     

       89
       85
        
       

     

       90
       90
       -
             export OLDDATA="${config.services.postgresql.dataDir}"

     

       91
       91
       -
             export OLDBIN="${config.services.postgresql.package}/bin"

     

       86
       86
       +
             export OLDDATA=&quot;${config.services.postgresql.dataDir}&quot;

     

       87
       87
       +
             export OLDBIN=&quot;${config.services.postgresql.package}/bin&quot;

     

       92
       88
        
       

     

       93
       93
       -
             install -d -m 0700 -o postgres -g postgres "$NEWDATA"

     

       94
       94
       -
             cd "$NEWDATA"

     

       95
       95
       -
             sudo -u postgres $NEWBIN/initdb -D "$NEWDATA"

     

       89
       89
       +
             install -d -m 0700 -o postgres -g postgres &quot;$NEWDATA&quot;

     

       90
       90
       +
             cd &quot;$NEWDATA&quot;

     

       91
       91
       +
             sudo -u postgres $NEWBIN/initdb -D &quot;$NEWDATA&quot;

     

       96
       92
        
       

     

       97
       93
        
             sudo -u postgres $NEWBIN/pg_upgrade \

     

       98
       98
       -
               --old-datadir "$OLDDATA" --new-datadir "$NEWDATA" \

     

       94
       94
       +
               --old-datadir &quot;$OLDDATA&quot; --new-datadir &quot;$NEWDATA&quot; \

     

       99
       95
        
               --old-bindir $OLDBIN --new-bindir $NEWBIN \

     

       100
       100
       -
               "$@"

     

       96
       96
       +
               &quot;$@&quot;

     

       101
       97
        
           '')

     

       102
       98
        
         ];

     

       103
       99
        
       }

     

       104
       100
        
       </programlisting>

     

       105
       105
       -
         </para>

     

       106
       106
       -
       

     

       107
       107
       -
         <para>

     

       108
       108
       -
          The upgrade process is:

     

       109
       109
       -
         </para>

     

       110
       110
       -
       

     

       111
       111
       -
         <orderedlist>

     

       112
       112
       -
          <listitem>

     

       113
       101
        
           <para>

     

       114
       114
       -
            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.

     

       102
       102
       +
             The upgrade process is:

     

       115
       103
        
           </para>

     

       116
       116
       -
          </listitem>

     

       117
       117
       -
          <listitem>

     

       118
       118
       -
           <para>

     

       119
       119
       -
            Login as root (<literal>sudo su -</literal>)

     

       120
       120
       -
           </para>

     

       121
       121
       -
          </listitem>

     

       122
       122
       -
          <listitem>

     

       104
       104
       +
           <orderedlist numeration="arabic">

     

       105
       105
       +
             <listitem>

     

       106
       106
       +
               <para>

     

       107
       107
       +
                 Rebuild nixos configuration with the configuration above added

     

       108
       108
       +
                 to your <filename>configuration.nix</filename>. Alternatively,

     

       109
       109
       +
                 add that into separate file and reference it in

     

       110
       110
       +
                 <literal>imports</literal> list.

     

       111
       111
       +
               </para>

     

       112
       112
       +
             </listitem>

     

       113
       113
       +
             <listitem>

     

       114
       114
       +
               <para>

     

       115
       115
       +
                 Login as root (<literal>sudo su -</literal>)

     

       116
       116
       +
               </para>

     

       117
       117
       +
             </listitem>

     

       118
       118
       +
             <listitem>

     

       119
       119
       +
               <para>

     

       120
       120
       +
                 Run <literal>upgrade-pg-cluster</literal>. It will stop old

     

       121
       121
       +
                 postgresql, initialize a new one and migrate the old one to

     

       122
       122
       +
                 the new one. You may supply arguments like

     

       123
       123
       +
                 <literal>--jobs 4</literal> and <literal>--link</literal> to

     

       124
       124
       +
                 speedup migration process. See

     

       125
       125
       +
                 <link xlink:href="https://www.postgresql.org/docs/current/pgupgrade.html" role="uri">https://www.postgresql.org/docs/current/pgupgrade.html</link>

     

       126
       126
       +
                 for details.

     

       127
       127
       +
               </para>

     

       128
       128
       +
             </listitem>

     

       129
       129
       +
             <listitem>

     

       130
       130
       +
               <para>

     

       131
       131
       +
                 Change postgresql package in NixOS configuration to the one

     

       132
       132
       +
                 you were upgrading to via

     

       133
       133
       +
                 <xref linkend="opt-services.postgresql.package"></xref>.

     

       134
       134
       +
                 Rebuild NixOS. This should start new postgres using upgraded

     

       135
       135
       +
                 data directory and all services you stopped during the

     

       136
       136
       +
                 upgrade.

     

       137
       137
       +
               </para>

     

       138
       138
       +
             </listitem>

     

       139
       139
       +
             <listitem>

     

       140
       140
       +
               <para>

     

       141
       141
       +
                 After the upgrade it's advisable to analyze the new cluster.

     

       142
       142
       +
               </para>

     

       143
       143
       +
               <itemizedlist>

     

       144
       144
       +
                 <listitem>

     

       145
       145
       +
                   <para>

     

       146
       146
       +
                     For PostgreSQL ≥ 14, use the <literal>vacuumdb</literal>

     

       147
       147
       +
                     command printed by the upgrades script.

     

       148
       148
       +
                   </para>

     

       149
       149
       +
                 </listitem>

     

       150
       150
       +
                 <listitem>

     

       151
       151
       +
                   <para>

     

       152
       152
       +
                     For PostgreSQL &lt; 14, run (as

     

       153
       153
       +
                     <literal>su -l postgres</literal> in the

     

       154
       154
       +
                     <xref linkend="opt-services.postgresql.dataDir"></xref>,

     

       155
       155
       +
                     in this example

     

       156
       156
       +
                     <filename>/var/lib/postgresql/13</filename>):

     

       157
       157
       +
                   </para>

     

       158
       158
       +
                   <programlisting>

     

       159
       159
       +
       $ ./analyze_new_cluster.sh

     

       160
       160
       +
       </programlisting>

     

       161
       161
       +
                 </listitem>

     

       162
       162
       +
               </itemizedlist>

     

       163
       163
       +
               <warning>

     

       164
       164
       +
                 <para>

     

       165
       165
       +
                   The next step removes the old state-directory!

     

       166
       166
       +
                 </para>

     

       167
       167
       +
               </warning>

     

       168
       168
       +
               <programlisting>

     

       169
       169
       +
       $ ./delete_old_cluster.sh

     

       170
       170
       +
       </programlisting>

     

       171
       171
       +
             </listitem>

     

       172
       172
       +
           </orderedlist>

     

       173
       173
       +
         </section>

     

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

     

       175
       175
       +
           <title>Options</title>

     

       123
       176
        
           <para>

     

       124
       124
       -
            Run <literal>upgrade-pg-cluster</literal>. It will stop old postgresql, initialize a new one and migrate the old one to the 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.

     

       177
       177
       +
             A complete list of options for the PostgreSQL module may be found

     

       178
       178
       +
             <link linkend="opt-services.postgresql.enable">here</link>.

     

       125
       179
        
           </para>

     

       126
       126
       -
          </listitem>

     

       127
       127
       -
          <listitem>

     

       180
       180
       +
         </section>

     

       181
       181
       +
         <section xml:id="module-services-postgres-plugins">

     

       182
       182
       +
           <title>Plugins</title>

     

       128
       183
        
           <para>

     

       129
       129
       -
            Change postgresql package in NixOS configuration to the one you were upgrading to via <xref linkend="opt-services.postgresql.package" />. Rebuild NixOS. This should start new postgres using upgraded data directory and all services you stopped during the upgrade.

     

       184
       184
       +
             Plugins collection for each PostgreSQL version can be accessed

     

       185
       185
       +
             with <literal>.pkgs</literal>. For example, for

     

       186
       186
       +
             <literal>pkgs.postgresql_11</literal> package, its plugin

     

       187
       187
       +
             collection is accessed by

     

       188
       188
       +
             <literal>pkgs.postgresql_11.pkgs</literal>:

     

       130
       189
        
           </para>

     

       131
       131
       -
          </listitem>

     

       132
       132
       -
          <listitem>

     

       133
       133
       -
           <para>

     

       134
       134
       -
            After the upgrade it's advisable to analyze the new cluster.

     

       135
       135
       -
           </para>

     

       136
       136
       -
           <itemizedlist>

     

       137
       137
       -
            <listitem>

     

       138
       138
       -
             <para>

     

       139
       139
       -
              For PostgreSQL ≥ 14, use the <literal>vacuumdb</literal> command printed by the upgrades script.

     

       140
       140
       -
             </para>

     

       141
       141
       -
            </listitem>

     

       142
       142
       -
            <listitem>

     

       143
       143
       -
              <para>

     

       144
       144
       -
               For PostgreSQL &lt; 14, run (as <literal>su -l postgres</literal> in the <xref linkend="opt-services.postgresql.dataDir" />, in this example <filename>/var/lib/postgresql/13</filename>):

     

       145
       145
       -
       <programlisting>

     

       146
       146
       -
       <prompt>$ </prompt>./analyze_new_cluster.sh

     

       147
       147
       -
       </programlisting>

     

       148
       148
       -
              </para>

     

       149
       149
       -
            </listitem>

     

       150
       150
       -
           </itemizedlist>

     

       151
       151
       -
           <para>

     

       152
       152
       -
             <warning><para>The next step removes the old state-directory!</para></warning>

     

       153
       153
       -
       <programlisting>

     

       154
       154
       -
       <prompt>$ </prompt>./delete_old_cluster.sh

     

       155
       155
       -
       </programlisting>

     

       156
       156
       -
           </para>

     

       157
       157
       -
          </listitem>

     

       158
       158
       -
         </orderedlist>

     

       159
       159
       -
        </section>

     

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

     

       161
       161
       -
         <title>Options</title>

     

       162
       162
       -
       

     

       163
       163
       -
         <para>

     

       164
       164
       -
          A complete list of options for the PostgreSQL module may be found <link linkend="opt-services.postgresql.enable">here</link>.

     

       165
       165
       -
         </para>

     

       166
       166
       -
        </section>

     

       167
       167
       -
        <section xml:id="module-services-postgres-plugins">

     

       168
       168
       -
         <title>Plugins</title>

     

       169
       169
       -
       

     

       170
       170
       -
         <para>

     

       171
       171
       -
          Plugins collection for each PostgreSQL version can be accessed with <literal>.pkgs</literal>. For example, for <literal>pkgs.postgresql_11</literal> package, its plugin collection is accessed by <literal>pkgs.postgresql_11.pkgs</literal>:

     

       172
       172
       -
       <screen>

     

       173
       173
       -
       <prompt>$ </prompt>nix repl '&lt;nixpkgs&gt;'

     

       190
       190
       +
           <programlisting>

     

       191
       191
       +
       $ nix repl '&lt;nixpkgs&gt;'

     

       174
       192
        
       

     

       175
       193
        
       Loading '&lt;nixpkgs&gt;'...

     

       176
       194
        
       Added 10574 variables.

     

       177
       195
        
       

     

       178
       178
       -
       <prompt>nix-repl&gt; </prompt>postgresql_11.pkgs.&lt;TAB&gt;&lt;TAB&gt;

     

       196
       196
       +
       nix-repl&gt; postgresql_11.pkgs.&lt;TAB&gt;&lt;TAB&gt;

     

       179
       197
        
       postgresql_11.pkgs.cstore_fdw        postgresql_11.pkgs.pg_repack

     

       180
       198
        
       postgresql_11.pkgs.pg_auto_failover  postgresql_11.pkgs.pg_safeupdate

     

       181
       199
        
       postgresql_11.pkgs.pg_bigm           postgresql_11.pkgs.pg_similarity

     
···

       183
       201
        
       postgresql_11.pkgs.pg_hll            postgresql_11.pkgs.pgjwt

     

       184
       202
        
       postgresql_11.pkgs.pg_partman        postgresql_11.pkgs.pgroonga

     

       185
       203
        
       ...

     

       186
       186
       -
       </screen>

     

       187
       187
       -
         </para>

     

       188
       188
       -
       

     

       189
       189
       -
         <para>

     

       190
       190
       -
          To add plugins via NixOS configuration, set <literal>services.postgresql.extraPlugins</literal>:

     

       191
       191
       -
       <programlisting>

     

       204
       204
       +
       </programlisting>

     

       205
       205
       +
           <para>

     

       206
       206
       +
             To add plugins via NixOS configuration, set

     

       207
       207
       +
             <literal>services.postgresql.extraPlugins</literal>:

     

       208
       208
       +
           </para>

     

       209
       209
       +
           <programlisting>

     

       192
       210
        
       services.postgresql.package = pkgs.postgresql_11;

     

       193
       211
        
       services.postgresql.extraPlugins = with pkgs.postgresql_11.pkgs; [

     

       194
       212
        
         pg_repack

     

       195
       213
        
         postgis

     

       196
       214
        
       ];

     

       197
       215
        
       </programlisting>

     

       198
       198
       -
         </para>

     

       199
       199
       -
       

     

       200
       200
       -
         <para>

     

       201
       201
       -
          You can build custom PostgreSQL-with-plugins (to be used outside of NixOS) using function <literal>.withPackages</literal>. For example, creating a custom PostgreSQL package in an overlay can look like:

     

       202
       202
       -
       <programlisting>

     

       216
       216
       +
           <para>

     

       217
       217
       +
             You can build custom PostgreSQL-with-plugins (to be used outside

     

       218
       218
       +
             of NixOS) using function <literal>.withPackages</literal>. For

     

       219
       219
       +
             example, creating a custom PostgreSQL package in an overlay can

     

       220
       220
       +
             look like:

     

       221
       221
       +
           </para>

     

       222
       222
       +
           <programlisting>

     

       203
       223
        
       self: super: {

     

       204
       224
        
         postgresql_custom = self.postgresql_11.withPackages (ps: [

     

       205
       225
        
           ps.pg_repack

     
···

       207
       227
        
         ]);

     

       208
       228
        
       }

     

       209
       229
        
       </programlisting>

     

       210
       210
       -
         </para>

     

       211
       211
       -
       

     

       212
       212
       -
         <para>

     

       213
       213
       -
          Here's a recipe on how to override a particular plugin through an overlay:

     

       214
       214
       -
       <programlisting>

     

       230
       230
       +
           <para>

     

       231
       231
       +
             Here's a recipe on how to override a particular plugin through an

     

       232
       232
       +
             overlay:

     

       233
       233
       +
           </para>

     

       234
       234
       +
           <programlisting>

     

       215
       235
        
       self: super: {

     

       216
       236
        
         postgresql_11 = super.postgresql_11.override { this = self.postgresql_11; } // {

     

       217
       237
        
           pkgs = super.postgresql_11.pkgs // {

     

       218
       238
        
             pg_repack = super.postgresql_11.pkgs.pg_repack.overrideAttrs (_: {

     

       219
       219
       -
               name = "pg_repack-v20181024";

     

       239
       239
       +
               name = &quot;pg_repack-v20181024&quot;;

     

       220
       240
        
               src = self.fetchzip {

     

       221
       221
       -
                 url = "https://github.com/reorg/pg_repack/archive/923fa2f3c709a506e111cc963034bf2fd127aa00.tar.gz";

     

       222
       222
       -
                 sha256 = "17k6hq9xaax87yz79j773qyigm4fwk8z4zh5cyp6z0sxnwfqxxw5";

     

       241
       241
       +
                 url = &quot;https://github.com/reorg/pg_repack/archive/923fa2f3c709a506e111cc963034bf2fd127aa00.tar.gz&quot;;

     

       242
       242
       +
                 sha256 = &quot;17k6hq9xaax87yz79j773qyigm4fwk8z4zh5cyp6z0sxnwfqxxw5&quot;;

     

       223
       243
        
               };

     

       224
       244
        
             });

     

       225
       245
        
           };

     

       226
       246
        
         };

     

       227
       247
        
       }

     

       228
       248
        
       </programlisting>

     

       229
       229
       -
         </para>

     

       230
       230
       -
        </section>

     

       249
       249
       +
         </section>

     

       231
       250
        
       </chapter>