Adding TypeDB #125350
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,130 @@ | ||||||
| { stdenv, lib, openjdk, which, system, fetchzip, fetchurl, server-data ? "~/.typedb_home", server-port ? "1729", server-logs ? "~/.typedb_home/logs" }: | ||||||
| let | ||||||
| typedbVersion = "2.1.1"; | ||||||
| systems = { | ||||||
| x86_64-linux = { | ||||||
| src = fetchurl { | ||||||
| url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-linux-2.1.1.tar.gz"; | ||||||
| sha256 = "00wvkiahmrys32ckp6r59bbrzfd7jzsphniyjdj4p9bh7k339gn2"; | ||||||
| }; | ||||||
| dir = "typedb-all-linux-${typedbVersion}"; | ||||||
| }; | ||||||
| x86_64-darwin = { | ||||||
| src = fetchzip { | ||||||
| url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-mac-2.1.1.zip"; | ||||||
| sha256 = "16hlfy6kh2rnvcralz206q13mghb0rv8wazpg6q3h324p5rdys54"; | ||||||
| }; | ||||||
| dir = "typedb-all-mac-${typedbVersion}"; | ||||||
| }; | ||||||
| x86_64-windows = { | ||||||
| src = fetchzip { | ||||||
| url = "https://github.com/vaticle/typedb/releases/download/2.1.1/typedb-all-windows-2.1.1.zip"; | ||||||
| sha256 = "0vd66gfshkg697z07nhy957mwqzlli4r4pmn67hx58n9mkg024kq"; | ||||||
| }; | ||||||
| dir = "typedb-all-windows-${typedbVersion}"; | ||||||
| }; | ||||||
| }; | ||||||
|
|
||||||
| currentSystem = systems.${system} or (throw "unsupported system ${system}"); | ||||||
| typedbDir = currentSystem.dir; | ||||||
| srcFolder = currentSystem.src; | ||||||
| javaPatch = '' | ||||||
| 20c20 | ||||||
| < JAVA_BIN=java | ||||||
| --- | ||||||
| > JAVA_BIN=${openjdk}/bin/java | ||||||
| 32c32 | ||||||
| < which "$'' + "{JAVA_BIN}\" > /dev/null\n" + | ||||||
| "---\n" + | ||||||
| "> ${which}/bin/which \"$" + "{JAVA_BIN}\" > /dev/null"; | ||||||
|
|
||||||
| typedb-properties-patch = '' | ||||||
| 19c19 | ||||||
| < server.data=server/data/ | ||||||
| --- | ||||||
| > server.data=${server-data} | ||||||
| 22c22 | ||||||
| < server.logs=server/logs/ | ||||||
| --- | ||||||
| > server.logs=${server-logs} | ||||||
| 24c24 | ||||||
| < server.port=1729 | ||||||
| --- | ||||||
| > server.port=${server-port} | ||||||
| ''; | ||||||
| typedb-wrapper-patch = '' | ||||||
| 3c3 | ||||||
| < TYPEDB_SERVER_DATA="__SERVER_DATA__" | ||||||
| --- | ||||||
| > TYPEDB_SERVER_DATA="${server-data}" | ||||||
| 8c8 | ||||||
| < TYPEDB_SERVER_LOGS="__SERVER_LOGS__" | ||||||
| --- | ||||||
| > TYPEDB_SERVER_LOGS="${server-logs}" | ||||||
| 13c13 | ||||||
| < TYPEDB_SERVER_PORT="__SERVER_PORT__" | ||||||
| --- | ||||||
| > TYPEDB_SERVER_PORT="${server-port}" | ||||||
| ''; | ||||||
| typedbWrapper = ./typedbWrapper.sh; | ||||||
|
|
||||||
| in | ||||||
| stdenv.mkDerivation rec { | ||||||
| pname = "typedb"; | ||||||
| version = typedbVersion; | ||||||
|
|
||||||
| src = srcFolder; | ||||||
|
|
||||||
| dontBuild = true; | ||||||
|
|
||||||
| /* | ||||||
| in preparation for the coming change of properties file parsing | ||||||
| allowing for environment variable reading : | ||||||
| > echo "${typedb-properties-patch}" > typedb-properties.patch | ||||||
| > patch ./server/conf/typedb.properties typedb-properties.patch | ||||||
| */ | ||||||
| installPhase = '' | ||||||
| #patch before install | ||||||
| echo '${javaPatch}' > typedb_java.patch | ||||||
| echo '${typedb-wrapper-patch}' > typedb_wrapper.patch | ||||||
| patch ./typedb typedb_java.patch | ||||||
|
|
||||||
| mkdir $out | ||||||
| cp -r ./* $out | ||||||
| mkdir $out/bin | ||||||
|
|
||||||
| cat ${typedbWrapper} > $out/bin/typedb | ||||||
| echo "$out/typedb server --data=\$TYPEDB_SERVER_DATA --logs=\$TYPEDB_SERVER_LOGS --port=\$TYPEDB_SERVER_PORT \"\$@\"" >> $out/bin/typedb | ||||||
| patch $out/bin/typedb typedb_wrapper.patch | ||||||
|
|
||||||
| chmod u+x $out/bin/typedb | ||||||
| rm typedb_java.patch | ||||||
| rm typedb_wrapper.patch | ||||||
| ''; | ||||||
|
|
||||||
| doInstallCheck = true; | ||||||
| installCheckPhase = '' | ||||||
| mkdir "$out/server_data" | ||||||
| mkdir "$out/server_log" | ||||||
haskie-lambda marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| echo "testing server" | ||||||
| TYPEDB_SERVER_DATA=$out/server_data TYPEDB_SERVER_LOGS=$out/server_log $out/bin/typedb --help > /dev/null | ||||||
| echo "testing client" | ||||||
| TYPEDB_SERVER_DATA=$out/server_data TYPEDB_SERVER_LOGS=$out/server_log $out/bin/typedb client --help > /dev/null | ||||||
| rm -r $out/server_data | ||||||
| rm -r $out/server_log | ||||||
| ''; | ||||||
| doCheck = true; | ||||||
|
|
||||||
| meta = with lib; { | ||||||
| description = "A distributed knowledge graph, a logical database to organise large and complex networks of data as one body of knowledge"; | ||||||
| longDescription = '' | ||||||
| TypeDB is a distributed knowledge graph: a logical database to organise large and complex networks of data as one body of knowledge. | ||||||
| TypeDB provides the knowledge engineering tools for developers to easily leverage the power of Knowledge Representation and Automated | ||||||
| Reasoning when building complex systems. Ultimately, TypeDB serves as the knowledge-base foundation for intelligent systems. | ||||||
| ''; | ||||||
| homepage = "https://www.grakn.ai/"; | ||||||
| license = licenses.gpl3Plus; | ||||||
| platforms = lib.attrNames systems; | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| maintainers = [ maintainers.haskie ]; | ||||||
| }; | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| if [ -z "$TYPEDB_SERVER_DATA" ]; then | ||
| TYPEDB_SERVER_DATA="__SERVER_DATA__" | ||
| mkdir $TYPEDB_SERVER_DATA | ||
| fi; | ||
| if [ -z "$TYPEDB_SERVER_LOGS" ]; then | ||
| TYPEDB_SERVER_LOGS="__SERVER_LOGS__" | ||
| mkdir $TYPEDB_SERVER_LOGS | ||
| fi; | ||
| if [ -z "$TYPEDB_SERVER_PORT" ]; then | ||
| TYPEDB_SERVER_PORT="__SERVER_PORT__" | ||
| fi; | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While it's already much better, this is still a bit awkward. Ideally changes in configuration would not require a rebuild.
If we're lucky, we might still be able to use an environment variable instead of hardcoding it into the store path, although that's not the default property file behavior.
Somewhat relevant discussion https://stackoverflow.com/questions/2263929/regarding-application-properties-file-and-environment-variable. If it's built on apache commons, we're lucky.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to specify properties or property files at runtime?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
according to the typedb team not;
only at startup as a cli option or in the config file;
I decided to add a wrapper script again that makes it possible to change the three configuration options via environment variables.
at least until I am able to change the implementation of the property file reader in the typedb.
I am still debugging it, but at least it builds and the tests run fine now;
there are still some issues though...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The config file is not really a config file if it's packaged immutably with the software, so cli options are probably the easiest option. Do you plan to write a NixOS service as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
didn't think about this before;
but I could actually do that, have to read up on that though ^^