-
List of PostgreSQL plugins.
Type
(function that evaluates to a(n) list of path) or (list of path) convertible to it
Default
Example
ps: with ps; [ postgis pg_repack ]
Declarations
-
Whether to enable Automatically migrate old data dir when major version of PostgreSQL
changes, using fc-postgresql/pg_upgrade.
The old data dir will be kept and has to be removed manually later.
You can run sudo -u postgres fc-postgresql prepare-autoupgrade to
create the new data dir before upgrading PostgreSQL to reduce downtime
and the risk of failure. You have to add databases to expectedDatabases
or disable checkExpectedDatabases to make this work.
.
Type
boolean
Default
false
Example
true
Declarations
-
Whether to enable Enable preconfigured PostgreSQL.
Type
boolean
Default
false
Example
true
Declarations
-
Check that only the databases specified by expectedDatabases
(and the standard internal databases) are present.
This is enabled by default and prevents auto-upgrades affecting
unexpected databases.
Type
boolean
Default
true
Declarations
-
List of databases that are expected to be present before upgrading.
If more databases are found, the upgrade will not run.
Type
list of string
Default
[ ]
Declarations
-
The major version of PostgreSQL to use (10, 11, 12, 13, 14).
-
Whether to enable PostgreSQL Server.
Type
boolean
Default
false
Example
true
Declarations
-
Whether to enable PostgreSQL dumps.
Type
boolean
Default
false
Example
true
Declarations
-
Whether to enable local postgresql integration.
Type
boolean
Default
false
Example
true
Declarations
-
Grants the user, created by the ensureUser attr, superuser permissions. From the postgres docs:
A database superuser bypasses all permission checks,
except the right to log in. This is a dangerous privilege
and should not be used carelessly; it is best to do most
of your work as a role that is not a superuser. To create
a new database superuser, use CREATE ROLE name SUPERUSER.
You must do this as a role that is already a superuser.
More information on postgres roles can be found here
Type
null or boolean
Default
null: do not set. For newly created roles, use PostgreSQL's default. For existing roles, do not touch this clause.
Declarations
-
Contents of the {file}recovery.conf file.
Type
null or strings concatenated with "\n"
Default
null
Declarations
-
Flush the WAL data to disk immediately after it has been received.
Also send a status packet back to the server immediately after flushing, regardless of {option}statusInterval.
This option should be specified if the replication client of {command}pg_receivewal is configured on the server as a synchronous standby,
to ensure that timely feedback is sent to the server.
Type
boolean
Default
false
Declarations
-
An attrset of clauses to grant to the user. Under the hood this uses the
ALTER USER syntax for each attrName where
the attrValue is true in the attrSet:
ALTER USER user.name WITH attrName
Type
submodule
Default
The default, null, means that the user created will have the default permissions assigned by PostgreSQL. Subsequent server starts will not set or unset the clause, so imperative changes are preserved.
Example
{
superuser = true;
createrole = true;
createdb = true;
}
Declarations
-
Specifies the number of seconds between status packets sent back to the server.
This allows for easier monitoring of the progress from server.
A value of zero disables the periodic status updates completely,
although an update will still be sent when requested by the server, to avoid timeout disconnect.
Type
signed integer
Default
10
Declarations
-
A file containing SQL statements to execute on first startup.
Type
null or path
Default
null
Example
pkgs.writeText "init-sql-script" ''
alter user postgres with password 'myPassword';
'';
Declarations