From 5b6b349038c594d85f31d508cd646069ba9a8fac Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Wed, 29 Jun 2022 10:25:49 +0200 Subject: [PATCH 1/4] Remove relative binary and assume terminusdb is in PATH Most commonly this would be the csae, especially with the Snap install. People that complile themselves will know how to call a binary in a directory with ./ already --- readme/terminusx-db/reference-guides/schema.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/readme/terminusx-db/reference-guides/schema.md b/readme/terminusx-db/reference-guides/schema.md index db02b03e..88c327aa 100644 --- a/readme/terminusx-db/reference-guides/schema.md +++ b/readme/terminusx-db/reference-guides/schema.md @@ -956,7 +956,7 @@ arbitrary JSON document. Using the CLI we can write: ```json -echo '{ "size" : 12.0, "name" : "Bob" }' | ./terminusdb doc insert admin/example -j +echo '{ "size" : 12.0, "name" : "Bob" }' | terminusdb doc insert admin/example -j Document inserted ["terminusdb:///json/JSONDocument/9cb4de0ff0b46b6035149a6b763e087d6c59cba2b417de3eedfd26063bee6bdf"] ``` @@ -1146,42 +1146,42 @@ with an Events data product. Create the HR data product: ```shell -./terminusdb db create admin/hr +terminusdb db create admin/hr ``` Add the HR schema: ```shell -echo '{ "@type" : "Class", "@id" : "Person", "@key" : { "@type" : "Lexical", "@fields" : ["name"]}, "name" : "xsd:string" }' | ./terminusdb doc insert admin/hr --graph_type=schema +echo '{ "@type" : "Class", "@id" : "Person", "@key" : { "@type" : "Lexical", "@fields" : ["name"]}, "name" : "xsd:string" }' | terminusdb doc insert admin/hr --graph_type=schema ``` Create the Events data product: ```shell -./terminusdb db create admin/events +terminusdb db create admin/events ``` Add events, and a foreign type designation: ```shell -echo '{ "@type" : "Foreign", "@id" : "Person"}{ "@type" : "Class", "@id" : "Event", "date" : "xsd:date", "person" : "Person" }' | ./terminusdb doc insert admin/events --graph_type=schema +echo '{ "@type" : "Foreign", "@id" : "Person"}{ "@type" : "Class", "@id" : "Event", "date" : "xsd:date", "person" : "Person" }' | terminusdb doc insert admin/events --graph_type=schema ``` Add a person to HR: ```shell -echo '{ "@type" : "Person", "name" : "Gavin" }' | ./terminusdb doc insert admin/hr +echo '{ "@type" : "Person", "name" : "Gavin" }' | terminusdb doc insert admin/hr ``` Add an event referring to the person: ```shell -echo '{ "@type" : "Event", "date" : "2022-10-05", "person" : "terminusdb:///data/Person/Gavin"}' | ./terminusdb doc insert admin/events +echo '{ "@type" : "Event", "date" : "2022-10-05", "person" : "terminusdb:///data/Person/Gavin"}' | terminusdb doc insert admin/events ``` Recover the event: ```shell -./terminusdb doc get admin/events --id='Event/9b3c5b174cb1f157dcdcedb692ed57f82ba31193fb81652dc602915732ae94e1' +terminusdb doc get admin/events --id='Event/9b3c5b174cb1f157dcdcedb692ed57f82ba31193fb81652dc602915732ae94e1' ``` ### Cardinality From 99148fd2ae0bf24b26f0d62c096d548ffb7c4ca3 Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Wed, 29 Jun 2022 10:37:34 +0200 Subject: [PATCH 2/4] Add install from snap entry --- readme/terminusdb/install/install-from-snap.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 readme/terminusdb/install/install-from-snap.md diff --git a/readme/terminusdb/install/install-from-snap.md b/readme/terminusdb/install/install-from-snap.md new file mode 100644 index 00000000..07ba7db8 --- /dev/null +++ b/readme/terminusdb/install/install-from-snap.md @@ -0,0 +1,10 @@ +# Install from Snap + +Detailed instructions on the installation can be found at the Snap page: https://snapcraft.io/terminusdb + +This is the easiest way to try TerminusDB as a developer on various Linux distributions. + +## Limitations + +The Snap does not contain a daemon. It is therefore recommended for developers trying TerminusDB. Server administrators are beter +off with either using terminusdb-bootstrap or configuring their own Docker deployment. From 837c592f074810440cf041f0b3b4d5c3b9b0e5ce Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Wed, 29 Jun 2022 10:45:20 +0200 Subject: [PATCH 3/4] Fix wrong language --- readme/terminusx-db/reference-guides/schema.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme/terminusx-db/reference-guides/schema.md b/readme/terminusx-db/reference-guides/schema.md index 88c327aa..3cc327c8 100644 --- a/readme/terminusx-db/reference-guides/schema.md +++ b/readme/terminusx-db/reference-guides/schema.md @@ -955,7 +955,7 @@ arbitrary JSON document. Using the CLI we can write: -```json +```shell echo '{ "size" : 12.0, "name" : "Bob" }' | terminusdb doc insert admin/example -j Document inserted ["terminusdb:///json/JSONDocument/9cb4de0ff0b46b6035149a6b763e087d6c59cba2b417de3eedfd26063bee6bdf"] ``` From f924ea3dff2d0f8b9a46c60d60c10f5d3e107276 Mon Sep 17 00:00:00 2001 From: Robin de Rooij Date: Wed, 29 Jun 2022 11:37:24 +0200 Subject: [PATCH 4/4] Add to TOC --- summary.md | 1 + 1 file changed, 1 insertion(+) diff --git a/summary.md b/summary.md index d092797d..dec0f17c 100644 --- a/summary.md +++ b/summary.md @@ -18,6 +18,7 @@ * [Introduction to TerminusDB](readme/terminusdb/overview/introduction.md) * [Get Started](readme/terminusdb/overview/get-started.md) * [Install Options](readme/terminusdb/install/README.md) + * [Install from Snap](readme/terminusdb/install/install-from-snap.md) * [Install from Source Code](readme/terminusdb/install/install-from-source-code.md) * [Install as a Docker Container](readme/terminusdb/install/install-as-docker-container.md) * [TerminusX and DB](readme/terminusx-db/README.md)