PostgreSQLSource:modules/services/databases/postgresql.nixUpstream documentation:
PostgreSQL is an advanced, free relational database.
Configuring
To enable PostgreSQL, add the following to your
configuration.nix:
= true;
= pkgs.postgresql_11;
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
such as the most recent
release of PostgreSQL.
By default, PostgreSQL stores its databases in
/var/lib/postgresql/$psqlSchema. You can override this using
, e.g.
= "/data/postgresql";
Upgrading
FIXME: document dump/upgrade/load cycle.
Options
A complete list of options for the PostgreSQL module may be found
here.
Plugins
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:
$ nix repl '<nixpkgs>'
Loading '<nixpkgs>'...
Added 10574 variables.
nix-repl> postgresql_11.pkgs.<TAB><TAB>
postgresql_11.pkgs.cstore_fdw postgresql_11.pkgs.pg_repack
postgresql_11.pkgs.pg_auto_failover postgresql_11.pkgs.pg_safeupdate
postgresql_11.pkgs.pg_bigm postgresql_11.pkgs.pg_similarity
postgresql_11.pkgs.pg_cron postgresql_11.pkgs.pg_topn
postgresql_11.pkgs.pg_hll postgresql_11.pkgs.pgjwt
postgresql_11.pkgs.pg_partman postgresql_11.pkgs.pgroonga
...
To add plugins via NixOS configuration, set services.postgresql.extraPlugins:
= pkgs.postgresql_11;
= with pkgs.postgresql_11.pkgs; [
pg_repack
postgis
];
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:
self: super: {
postgresql_custom = self.postgresql_11.withPackages (ps: [
ps.pg_repack
ps.postgis
]);
}
Here's a recipe on how to override a particular plugin through an overlay:
self: super: {
postgresql_11 = super.postgresql_11.override { this = self.postgresql_11; } // {
pkgs = super.postgresql_11.pkgs // {
pg_repack = super.postgresql_11.pkgs.pg_repack.overrideAttrs (_: {
name = "pg_repack-v20181024";
src = self.fetchzip {
url = "https://github.com/reorg/pg_repack/archive/923fa2f3c709a506e111cc963034bf2fd127aa00.tar.gz";
sha256 = "17k6hq9xaax87yz79j773qyigm4fwk8z4zh5cyp6z0sxnwfqxxw5";
};
});
};
};
}