link:./examples.clj[role=include]
This guide contains simple steps showing how to transact data and run a simple query. However, there are a few topics you might benefit from learning about before you get too far with attempting to use Crux:
EDN – the extensible data notation format used throughout the Crux APIs, see Essential EDN for Crux.
The Datalog query language – Crux supports an EDN-flavoured version of Datalog. The Queries section within this documentation provides a good overview. You can also find an interactive tutorial for EDN-flavoured Datalog here.
Clojure – whilst a complete Java API is provided, a basic understanding of Clojure is recommended – Clojure is a succinct and pragmatic data-oriented language with strong support for immutability and parallelism. See Clojure.org.
If you want to start interacting with Crux in your environment then it is advised you run Crux in a standalone configuration.
Alternatively, if you simply want to experiment with Crux using a demo Docker container from Docker Hub (no JVM/JDK/Clojure install required, only Docker!) then please see the standalone web service example. You can also use this self-contained demonstration image to experiment with the REST API.
link:./examples.clj[role=include]
link:./examples.clj[role=include]
You should get:
link:./examples.clj[role=include]
An entity query would be:
link:./examples.clj[role=include]
You should get:
link:./examples.clj[role=include]
Now you know the basics of how to interact with Crux you may want to dive into a REPL-based tutorial (or use the interactive no-install browser-based Nextjournal edition!). Otherwise, let’s take a look at the kinds of things you are able to do with Queries.
Can you improve this documentation? These fine people already did:
Jeremy Taylor, Antonelli712 & Ivan FedorovEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close