diff options
author | Jörg Thalheim <joerg@thalheim.io> | 2019-01-19 10:33:20 +0000 |
---|---|---|
committer | Jörg Thalheim <joerg@thalheim.io> | 2019-01-19 11:41:06 +0000 |
commit | 1af4f366ca0bb3860a18b8435dad8a23d5ea7b62 (patch) | |
tree | 0ed235b12f853e4f78017a31056b41165d56e872 /nixos/modules/services/backup/postgresql-backup.nix | |
parent | 9a601e228d7e71c1f6b76a00d136e85b90c5f9fd (diff) | |
download | nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.tar nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.tar.gz nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.tar.bz2 nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.tar.lz nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.tar.xz nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.tar.zst nixpkgs-1af4f366ca0bb3860a18b8435dad8a23d5ea7b62.zip |
nixos/postgresqlBackup: add backupAll option
For large setups it is useful to list all databases explicit (for example if temporary databases are also present) and store them in extra files. For smaller setups it is more convenient to just backup all databases at once, because it is easy to forget to update configuration when adding/renaming databases. pg_dumpall also has the advantage that it backups users/passwords. As a result the module becomes easier to use because it is sufficient in the default case to just set one option (services.postgresqlBackup.enable).
Diffstat (limited to 'nixos/modules/services/backup/postgresql-backup.nix')
-rw-r--r-- | nixos/modules/services/backup/postgresql-backup.nix | 51 |
1 files changed, 40 insertions, 11 deletions
diff --git a/nixos/modules/services/backup/postgresql-backup.nix b/nixos/modules/services/backup/postgresql-backup.nix index f9f9568faa5..11efa47ec5b 100644 --- a/nixos/modules/services/backup/postgresql-backup.nix +++ b/nixos/modules/services/backup/postgresql-backup.nix @@ -6,11 +6,11 @@ let cfg = config.services.postgresqlBackup; - postgresqlBackupService = db : + postgresqlBackupService = db: dumpCmd: { enable = true; - description = "Backup of database ${db}"; + description = "Backup of ${db} database(s)"; requires = [ "postgresql.service" ]; @@ -26,7 +26,7 @@ let ${pkgs.coreutils}/bin/mv ${cfg.location}/${db}.sql.gz ${cfg.location}/${db}.prev.sql.gz fi - ${config.services.postgresql.package}/bin/pg_dump ${cfg.pgdumpOptions} ${db} | \ + ${dumpCmd} | \ ${pkgs.gzip}/bin/gzip -c > ${cfg.location}/${db}.sql.gz ''; @@ -42,9 +42,7 @@ let in { options = { - services.postgresqlBackup = { - enable = mkOption { default = false; description = '' @@ -61,6 +59,19 @@ in { ''; }; + backupAll = mkOption { + default = cfg.databases == []; + defaultText = "services.postgresqlBackup.databases == []"; + type = lib.types.bool; + description = '' + Backup all databases using pg_dumpall. + This option is mutual exclusive to + <literal>services.postgresqlBackup.databases</literal>. + The resulting backup dump will have the name all.sql.gz. + This option is the default if no databases are specified. + ''; + }; + databases = mkOption { default = []; description = '' @@ -79,18 +90,36 @@ in { type = types.string; default = "-Cbo"; description = '' - Command line options for pg_dump. + Command line options for pg_dump. This options is not used + if <literal>config.services.postgresqlBackup.backupAll</literal> is enabled. + Note that config.services.postgresqlBackup.backupAll is also active, + when no databases where specified. ''; }; }; }; - config = mkIf config.services.postgresqlBackup.enable { - - systemd.services = listToAttrs (map (db : { + config = mkMerge [ + { + assertions = [{ + assertion = cfg.backupAll -> cfg.databases == []; + message = "config.services.postgresqlBackup.backupAll cannot be used together with config.services.postgresqlBackup.databases"; + }]; + } + (mkIf (cfg.enable && cfg.backupAll) { + systemd.services.postgresqlBackup = + postgresqlBackupService "all" "${config.services.postgresql.package}/bin/pg_dumpall"; + }) + (mkIf (cfg.enable && !cfg.backupAll) { + systemd.services = listToAttrs (map (db: + let + cmd = "${config.services.postgresql.package}/bin/pg_dump ${cfg.pgdumpOptions} ${db}"; + in { name = "postgresqlBackup-${db}"; - value = postgresqlBackupService db; } ) cfg.databases); - }; + value = postgresqlBackupService db cmd; + }) cfg.databases); + }) + ]; } |