Skip to content

postgresql: Add ensureExtensions option to service setup #75688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kampka wants to merge 1 commit into from
Closed

postgresql: Add ensureExtensions option to service setup #75688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions nixos/modules/services/databases/postgresql.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,25 @@ in
];
};

ensureExtensions = mkOption {
type = types.listOf types.str;
default = [];
description = ''
Ensures that the specified extensions exist.
Extensions will be created in the 'public' schema, thus making them automatically
availabe on the default search path.

This option will never drop existing extensions, especially not when the value of this
option is changed. This means that extensions created once through this option or
otherwise have to be removed manually.
'';
example = [
"hstore"
"pgcrypto"
"pg_trgm"
];
};

ensureUsers = mkOption {
type = types.listOf (types.submodule {
options = {
Expand Down Expand Up @@ -344,6 +363,10 @@ in
$PSQL -tAc 'GRANT ${permission} ON ${database} TO "${user.name}"'
'') user.ensurePermissions)}
'') cfg.ensureUsers}
'' + optionalString (cfg.ensureExtensions != []) ''
${concatMapStrings (extension: ''
$PSQL -tAc "SELECT 1 FROM pg_available_extensions WHERE name = '${extension}' and installed_version is not null" | grep -q 1 || $PSQL -tAc 'CREATE EXTENSION "${extension}" SCHEMA public CASCADE'
'') cfg.ensureExtensions}
'';

unitConfig.RequiresMountsFor = "${cfg.dataDir}";
Expand Down
7 changes: 7 additions & 0 deletions nixos/tests/postgresql.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ let
{
services.postgresql.enable = true;
services.postgresql.package = postgresql-package;
services.postgresql.ensureExtensions = [ "hstore" ];

services.postgresqlBackup.enable = true;
services.postgresqlBackup.databases = optional (!backup-all) "postgres";
Expand Down Expand Up @@ -61,6 +62,12 @@ let
machine.succeed(check_count("SELECT * FROM sth;", 5))
machine.fail(check_count("SELECT * FROM sth;", 4))
machine.succeed(check_count("SELECT xpath('/test/text()', doc) FROM xmltest;", 1))
machine.succeed(
check_count(
"SELECT * FROM pg_available_extensions WHERE name = 'hstore' AND installed_version is not null",
1,
)
)

# Check backup service
machine.succeed("systemctl start ${backupService}.service")
Expand Down