Skip to content

feat: multiple versions for the timescaledb-apache extension #1641

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.

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

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
65 changes: 0 additions & 65 deletions nix/ext/timescaledb-2.9.1.nix

This file was deleted.

109 changes: 80 additions & 29 deletions nix/ext/timescaledb.nix
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
libkrb5,
}:

stdenv.mkDerivation rec {
pname = "timescaledb-apache";
version = "2.16.1";
let
pname = "timescaledb";
build = version: hash: revision:
stdenv.mkDerivation rec {
inherit pname version;

nativeBuildInputs = [ cmake ];
buildInputs = [
Expand All @@ -19,12 +21,12 @@ stdenv.mkDerivation rec {
libkrb5
];

src = fetchFromGitHub {
owner = "timescale";
repo = "timescaledb";
rev = version;
hash = "sha256-sLxWdBmih9mgiO51zLLxn9uwJVYc5JVHJjSWoADoJ+w=";
};
src = fetchFromGitHub {
owner = "timescale";
repo = "timescaledb";
rev = version;
inherit hash;
};

cmakeFlags = [
"-DSEND_TELEMETRY_DEFAULT=OFF"
Expand All @@ -33,26 +35,75 @@ stdenv.mkDerivation rec {
"-DAPACHE_ONLY=1"
] ++ lib.optionals stdenv.isDarwin [ "-DLINTER=OFF" ];

# Fix the install phase which tries to install into the pgsql extension dir,
# and cannot be manually overridden. This is rather fragile but works OK.
postPatch = ''
for x in CMakeLists.txt sql/CMakeLists.txt; do
substituteInPlace "$x" \
--replace 'DESTINATION "''${PG_SHAREDIR}/extension"' "DESTINATION \"$out/share/postgresql/extension\""
done

for x in src/CMakeLists.txt src/loader/CMakeLists.txt tsl/src/CMakeLists.txt; do
substituteInPlace "$x" \
--replace 'DESTINATION ''${PG_PKGLIBDIR}' "DESTINATION \"$out/lib\""
done
'';
postPatch = ''
for x in CMakeLists.txt sql/CMakeLists.txt; do
if [ -f "$x" ]; then
substituteInPlace "$x" \
--replace 'DESTINATION "''${PG_SHAREDIR}/extension"' "DESTINATION \"$out/share/postgresql/extension\""
fi
done

for x in src/CMakeLists.txt src/loader/CMakeLists.txt tsl/src/CMakeLists.txt; do
if [ -f "$x" ]; then
substituteInPlace "$x" \
--replace 'DESTINATION ''${PG_PKGLIBDIR}' "DESTINATION \"$out/lib\""
fi
done
'';

postInstall = ''
if [ -f $out/lib/timescaledb.so ]; then
mv $out/lib/timescaledb.so $out/lib/timescaledb-${version}.so
fi
if [ -f $out/share/postgresql/extension/timescaledb.control ]; then
mv $out/share/postgresql/extension/timescaledb.control $out/share/postgresql/extension/timescaledb--${version}.control
fi
'';

meta = with lib; {
description = "Scales PostgreSQL for time-series data via automatic partitioning across time and space";
homepage = "https://www.timescale.com/";
changelog = "https://github.com/timescale/timescaledb/blob/${version}/CHANGELOG.md";
platforms = postgresql.meta.platforms;
license = licenses.asl20;
broken = versionOlder postgresql.version "13";
meta = with lib; {
description =
"Scales PostgreSQL for time-series data via automatic partitioning across time and space";
homepage = "https://www.timescale.com/";
changelog =
"https://github.com/timescale/timescaledb/blob/${version}/CHANGELOG.md";
license = licenses.postgresql;
inherit (postgresql.meta) platforms;
};
};

allVersions =
(builtins.fromJSON (builtins.readFile ./versions.json)).timescaledb;
supportedVersions = lib.filterAttrs (_: value:
builtins.elem (lib.versions.major postgresql.version) value.postgresql)
allVersions;
versions = lib.naturalSort (lib.attrNames supportedVersions);
latestVersion = lib.last versions;
numberOfVersions = builtins.length versions;
packages = builtins.attrValues
(lib.mapAttrs (name: value: build name value.hash (value.revision or name))
supportedVersions);
in pkgs.buildEnv {
name = pname;
paths = packages;
postBuild = ''
{
echo "default_version = '${latestVersion}'"
cat $out/share/postgresql/extension/${pname}--${latestVersion}.control
} > $out/share/postgresql/extension/${pname}.control
ln -sfn ${pname}-${latestVersion}${postgresql.dlSuffix} $out/lib/${pname}${postgresql.dlSuffix}

# checks
(set -x
test "$(ls -A $out/lib/${pname}*${postgresql.dlSuffix} | wc -l)" = "${
toString (numberOfVersions + 1)
}"
)
'';
pathsToLink = [ "/lib" "/share/postgresql/extension" ];
passthru = {
inherit versions numberOfVersions;
pname = "${pname}-all";
version = "multi-" + lib.concatStringsSep "-"
(map (v: lib.replaceStrings [ "." ] [ "-" ] v) versions);
};
}
14 changes: 14 additions & 0 deletions nix/ext/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,19 @@
"pgrx": "0.14.3",
"rust": "1.87.0"
}
},
"timescaledb": {
"2.9.1": {
"postgresql": [
"15"
],
"hash": "sha256-fvVSxDiGZAewyuQ2vZDb0I6tmlDXl6trjZp8+qDBtb8="
},
"2.16.1": {
"postgresql": [
"15"
],
"hash": "sha256-sLxWdBmih9mgiO51zLLxn9uwJVYc5JVHJjSWoADoJ+w="
}
}
}
83 changes: 83 additions & 0 deletions nix/tests/timescaledb.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{ self, pkgs }:
let
inherit (pkgs) lib;
installedExtension = postgresMajorVersion:
self.packages.${pkgs.system}."psql_${postgresMajorVersion}/exts/timescaledb-all";
versions = (installedExtension "15").versions;
firstVersion = lib.head versions;
latestVersion = lib.last versions;
postgresqlWithExtension = postgresql:
let
majorVersion = lib.versions.major postgresql.version;
pkg = pkgs.buildEnv {
name = "postgresql-${majorVersion}-timescaledb";
paths = [ postgresql postgresql.lib (installedExtension majorVersion) ];
passthru = {
inherit (postgresql) version psqlSchema;
lib = pkg;
withPackages = _: pkg;
};
nativeBuildInputs = [ pkgs.makeWrapper ];
pathsToLink = [ "/" "/bin" "/lib" ];
postBuild = ''
wrapProgram $out/bin/postgres --set NIX_PGLIBDIR $out/lib
wrapProgram $out/bin/pg_ctl --set NIX_PGLIBDIR $out/lib
wrapProgram $out/bin/pg_upgrade --set NIX_PGLIBDIR $out/lib
'';
};
in pkg;
in self.inputs.nixpkgs.lib.nixos.runTest {
name = "timescaledb";
hostPkgs = pkgs;
nodes.server = { config, ... }: {
virtualisation = {
forwardPorts = [{
from = "host";
host.port = 13022;
guest.port = 22;
}];
};
services.openssh = { enable = true; };
users.users.root.openssh.authorizedKeys.keys = [
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIArkmq6Th79Z4klW6Urgi4phN8yq769/l/10jlE00tU9"
];

services.postgresql = {
enable = true;
package =
postgresqlWithExtension self.packages.${pkgs.system}.postgresql_15;
settings = { shared_preload_libraries = "timescaledb"; };
};

specialisation.postgresql15.configuration = {
services.postgresql = {
package = lib.mkForce
(postgresqlWithExtension self.packages.${pkgs.system}.postgresql_15);
};
};
};
testScript = { nodes, ... }: ''
def run_sql(query):
return server.succeed(f"""sudo -u postgres psql -t -A -F\",\" -c \"{query}\" """).strip()

def check_upgrade_path():
with subtest("Check timescaledb upgrade path"):
server.succeed("sudo -u postgres psql -c 'DROP EXTENSION IF EXISTS timescaledb;'")
run_sql(r"""CREATE EXTENSION timescaledb WITH VERSION \"${firstVersion}\";""")
installed_version = run_sql(r"""SELECT extversion FROM pg_extension WHERE extname = 'timescaledb';""")
assert installed_version == "${firstVersion}", f"Expected timescaledb version ${firstVersion}, but found {installed_version}"
for version in [${
lib.concatStringsSep ", " (map (s: ''"${s}"'') versions)
}][1:]:
run_sql(f"""ALTER EXTENSION timescaledb UPDATE TO '{version}';""")
installed_version = run_sql(r"""SELECT extversion FROM pg_extension WHERE extname = 'timescaledb';""")
assert installed_version == version, f"Expected timescaledb version {version}, but found {installed_version}"

start_all()

server.wait_for_unit("multi-user.target")
server.wait_for_unit("postgresql.service")

check_upgrade_path()
'';
}
Loading