├── java
    ├── .mvn
    │   └── jvm.config
    ├── src
    │   └── main
    │   │   ├── resources
    │   │       └── logback.xml
    │   │   └── java
    │   │       └── xtdbinabox
    │   │           └── Box.java
    ├── config.json
    ├── Makefile
    └── pom.xml
├── .gitignore
├── README.md
├── clj
    ├── resources
    │   └── logback.xml
    ├── src
    │   └── xtdb_in_a_box
    │   │   └── db.clj
    └── project.clj
└── LICENSE


/java/.mvn/jvm.config:
--------------------------------------------------------------------------------
1 | -Dclojure.tools.logging.factory=clojure.tools.logging.impl/slf4j-factory
2 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | clj/**/pom.xml
 2 | clj/**/pom.xml.asc
 3 | *.jar
 4 | *.class
 5 | /lib/
 6 | /classes/
 7 | /target/
 8 | /checkouts/
 9 | .lein-deps-sum
10 | .lein-repl-history
11 | .lein-plugins/
12 | .lein-failures
13 | .nrepl-port
14 | .cpcache/
15 | .lsp/
16 | clj/data/
17 | clj/target/
18 | java/data/
19 | java/target/
20 | java/.classpath
21 | java/.project
22 | .settings/
23 | .vscode/
24 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # xtdb-in-a-box
 2 | 
 3 | The simplest production-ready Xtdb setup.
 4 | 
 5 | Please read the [XTDB Quickstart](https://docs.xtdb.com/guides/quickstart/).
 6 | 
 7 | ## Clojure
 8 | 
 9 | The `/clj` directory contains a minimal Clojure project. Run it from a REPL.
10 | 
11 | ## Java
12 | 
13 | The `/java` directory contains a minimal Java project. Run it with:
14 | 
15 | ```shell
16 | make && make run
17 | ```
18 | 
19 | ## License
20 | 
21 | Copyright © 2021 JUXT Ltd.
22 | 
23 | Distributed under the MIT License.
24 | 


--------------------------------------------------------------------------------
/clj/resources/logback.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <configuration>
 3 |   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 4 |     <encoder>
 5 |       <!-- this pattern is easy to read: -->
 6 |       <pattern>%-5level %logger{36} - %msg%n</pattern>
 7 |       <!-- this pattern is more realistic, if you want it:
 8 |            <pattern>%d{ISO8601,UTC} [%thread] %-5level %logger{36} - %msg%n</pattern>
 9 |       -->
10 |     </encoder>
11 |   </appender>
12 | 
13 |   <root level="INFO">
14 |     <appender-ref ref="STDOUT"/>
15 |   </root>
16 | </configuration>
17 | 


--------------------------------------------------------------------------------
/java/src/main/resources/logback.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <configuration>
 3 |   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 4 |     <encoder>
 5 |       <!-- this pattern is easy to read: -->
 6 |       <pattern>%-5level %logger{36} - %msg%n</pattern>
 7 |       <!-- this pattern is more realistic, if you want it:
 8 |            <pattern>%d{ISO8601,UTC} [%thread] %-5level %logger{36} - %msg%n</pattern>
 9 |       -->
10 |     </encoder>
11 |   </appender>
12 | 
13 |   <root level="INFO">
14 |     <appender-ref ref="STDOUT"/>
15 |   </root>
16 | </configuration>
17 | 


--------------------------------------------------------------------------------
/java/config.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "xtdb/index-store": {
 3 |     "kv-store": {
 4 |       "xtdb/module": "xtdb.rocksdb/->kv-store",
 5 |       "db-dir": "data/index-store"
 6 |     }
 7 |   },
 8 |   "xtdb/document-store": {
 9 |     "kv-store": {
10 |       "xtdb/module": "xtdb.rocksdb/->kv-store",
11 |       "db-dir": "data/doc-store"
12 |     }
13 |   },
14 |   "xtdb/tx-log": {
15 |     "kv-store": {
16 |       "xtdb/module": "xtdb.rocksdb/->kv-store",
17 |       "db-dir": "data/tx-log"
18 |     }
19 |   },
20 |   "xtdb.lucene/lucene-store": {
21 |     "db-dir": "data/dev/lucene-dir"
22 |   },
23 |   "xtdb.http-server/server": {
24 |     "port": 9999
25 |   }
26 | }
27 | 


--------------------------------------------------------------------------------
/java/Makefile:
--------------------------------------------------------------------------------
 1 | 
 2 | build:
 3 | 	mvn dependency:copy-dependencies
 4 | 	mvn package # alternatively: `mvn clean compile assembly:single`
 5 | 
 6 | # MacOS + JDK16/17 workarounds:
 7 | # (1) `XTDB_ENABLE_BYTEUTILS_SHA1` is required to change the SHA1 algorithm used.
 8 | # (2) `--add-opens java.base/java.util.concurrent=ALL-UNNAMED` is required to avoid
 9 | #     https://github.com/xtdb/xtdb/issues/1462
10 | run:
11 | 	XTDB_ENABLE_BYTEUTILS_SHA1=true \
12 | 	java -cp target/xtdbinabox-0.0.2-jar-with-dependencies.jar \
13 | 	-Dclojure.tools.logging.factory=clojure.tools.logging.impl/slf4j-factory \
14 | 	--add-opens java.base/java.util.concurrent=ALL-UNNAMED \
15 | 	xtdbinabox.Box
16 | 
17 | sanity:
18 | 	java --version
19 | 	mvn --version
20 | 


--------------------------------------------------------------------------------
/clj/src/xtdb_in_a_box/db.clj:
--------------------------------------------------------------------------------
 1 | (ns xtdb-in-a-box.db
 2 |   (:require [clojure.java.io :as io]
 3 |             [xtdb.api :as xt]))
 4 | 
 5 | (println (System/getenv "XTDB_ENABLE_BYTEUTILS_SHA1"))
 6 | 
 7 | (defn start-xtdb! []
 8 |   (letfn [(kv-store [dir]
 9 |             {:kv-store {:xtdb/module 'xtdb.rocksdb/->kv-store
10 | 	                      :db-dir      (io/file dir)
11 |                         :sync?       true}})]
12 |     (xt/start-node
13 |      {:xtdb/tx-log              (kv-store "data/dev/tx-log")
14 | 	    :xtdb/document-store      (kv-store "data/dev/doc-store")
15 |       :xtdb/index-store         (kv-store "data/dev/index-store")
16 |       ;; optional:
17 |       :xtdb.lucene/lucene-store {:db-dir "data/dev/lucene-dir"}
18 |       :xtdb.http-server/server  {:port 9999}})))
19 | 
20 | (def xtdb-node (start-xtdb!))
21 | 
22 | (defn stop-xtdb! []
23 |   (.close xtdb-node))
24 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Steven Deobald
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/clj/project.clj:
--------------------------------------------------------------------------------
 1 | (defproject xtdb-in-a-box "0.0.2"
 2 |   :description "XTDB in a Box"
 3 | 
 4 |   :dependencies [[org.clojure/clojure "1.10.1"]
 5 | 
 6 |                  ;; required:
 7 |                  [com.xtdb/xtdb-core "1.23.2"]
 8 |                  [com.xtdb/xtdb-rocksdb "1.23.2"]
 9 | 
10 |                  ;; logging:
11 |                  [org.clojure/tools.logging "1.1.0"]
12 |                  [ch.qos.logback/logback-classic "1.2.3"]
13 |                  [ch.qos.logback/logback-core "1.2.3"]
14 |                  [org.slf4j/slf4j-api "1.7.30"]
15 | 
16 |                  ;; optional:
17 |                  [com.xtdb/xtdb-lucene "1.23.2"]
18 |                  [com.xtdb/xtdb-http-server "1.23.2"]]
19 | 
20 |   :repl-options {:init-ns xtdb-in-a-box.db}
21 | 
22 |   ;; XTDB SHA1 workaround for JDK 17 on MacOS:
23 |   :plugins [[lein-with-env-vars "0.2.0"]]
24 | 
25 |   ;; logging:
26 |   :jvm-opts ["-Dclojure.tools.logging.factory=clojure.tools.logging.impl/slf4j-factory"
27 |              ;; the following option is required for JDK 16 and 17:
28 |              ;; https://github.com/xtdb/xtdb/issues/1462
29 |              "--add-opens=java.base/java.util.concurrent=ALL-UNNAMED"]
30 | 
31 |   ;; the following implements the XTDB SHA1 workaround for JDK 17 on MacOS:
32 |   :hooks [leiningen.with-env-vars/auto-inject]
33 |   :env-vars {:XTDB_ENABLE_BYTEUTILS_SHA1 "true"})
34 | 


--------------------------------------------------------------------------------
/java/src/main/java/xtdbinabox/Box.java:
--------------------------------------------------------------------------------
 1 | package xtdbinabox;
 2 | 
 3 | import java.io.File;
 4 | import java.io.IOException;
 5 | import java.util.Collection;
 6 | import java.util.HashMap;
 7 | import java.util.List;
 8 | 
 9 | import xtdb.api.IXtdb;
10 | import xtdb.api.IXtdbDatasource;
11 | import xtdb.api.ICursor;
12 | import xtdb.api.XtdbDocument;
13 | import xtdb.api.TransactionInstant;
14 | import xtdb.api.tx.Transaction;
15 | 
16 | class Box {
17 |     public static void main(String[] args) {
18 |         try (IXtdb node = IXtdb.startNode(new File("config.json"))) {
19 |             System.out.println("Xtdb Started.");
20 | 
21 |             // submitTx example:
22 |             HashMap<String, Object> data = new HashMap<>();
23 |             data.put("user/name", "zig");
24 |             XtdbDocument document = XtdbDocument.create("hi2u", data);
25 |             TransactionInstant transaction = node.submitTx(Transaction.buildTx(tx -> {
26 |                 tx.put(document);
27 |             }));
28 |             System.out.println(data.toString());
29 | 
30 |             // query example:
31 |             node.awaitTx(transaction, null);
32 |             String query = "{:find [e] :where [[e :user/name \"zig\"]]}";
33 |             IXtdbDatasource db = node.db();
34 |             Collection<List<?>> results = db.query(query);
35 |             for (List l : results) {
36 |                 System.out.println(l.toString());
37 |             }
38 |             db.close();
39 |             node.close();
40 |         }
41 |         catch (IOException e) {
42 |             // ...
43 |         }
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/java/pom.xml:
--------------------------------------------------------------------------------
  1 | <project>
  2 |   <modelVersion>4.0.0</modelVersion>
  3 | 
  4 |   <groupId>com.xtdb</groupId>
  5 |   <artifactId>xtdbinabox</artifactId>
  6 |   <version>0.0.2</version>
  7 | 
  8 |   <properties>
  9 |     <maven.compiler.source>11</maven.compiler.source>
 10 |     <maven.compiler.target>11</maven.compiler.target>
 11 |   </properties>
 12 | 
 13 |   <dependencies>
 14 |     <dependency>
 15 |       <groupId>com.xtdb</groupId>
 16 |       <artifactId>xtdb-core</artifactId>
 17 |       <version>1.23.2</version>
 18 |     </dependency>
 19 |     <dependency>
 20 |       <groupId>com.xtdb</groupId>
 21 |       <artifactId>xtdb-rocksdb</artifactId>
 22 |       <version>1.23.2</version>
 23 |     </dependency>
 24 | 
 25 |     <!-- logging: -->
 26 |     <dependency>
 27 |       <groupId>org.clojure</groupId>
 28 |       <artifactId>tools.logging</artifactId>
 29 |       <version>1.1.0</version>
 30 |     </dependency>
 31 |     <dependency>
 32 |       <groupId>ch.qos.logback</groupId>
 33 |       <artifactId>logback-classic</artifactId>
 34 |       <version>1.2.3</version>
 35 |     </dependency>
 36 |     <dependency>
 37 |       <groupId>ch.qos.logback</groupId>
 38 |       <artifactId>logback-core</artifactId>
 39 |       <version>1.2.3</version>
 40 |     </dependency>
 41 |     <dependency>
 42 |       <groupId>org.slf4j</groupId>
 43 |       <artifactId>slf4j-api</artifactId>
 44 |       <version>1.7.30</version>
 45 |     </dependency>
 46 | 
 47 |     <!-- optional: -->
 48 |     <dependency>
 49 |       <groupId>com.xtdb</groupId>
 50 |       <artifactId>xtdb-lucene</artifactId>
 51 |       <version>1.23.2</version>
 52 |     </dependency>
 53 |     <dependency>
 54 |       <groupId>com.xtdb</groupId>
 55 |       <artifactId>xtdb-http-server</artifactId>
 56 |       <version>1.23.2</version>
 57 |     </dependency>
 58 |   </dependencies>
 59 | 
 60 |   <repositories>
 61 |     <repository>
 62 |       <id>clojars</id>
 63 |       <url>http://clojars.org/repo/</url>
 64 |     </repository>
 65 |   </repositories>
 66 | 
 67 |   <build>
 68 |     <pluginManagement>
 69 |       <plugins>
 70 |         <plugin>
 71 |           <groupId>org.apache.maven.plugins</groupId>
 72 |           <artifactId>maven-compiler-plugin</artifactId>
 73 |           <version>3.8.1</version>
 74 |         </plugin>
 75 |       </plugins>
 76 |     </pluginManagement>
 77 | 
 78 |     <plugins>
 79 |       <plugin>
 80 |         <artifactId>maven-assembly-plugin</artifactId>
 81 |         <configuration>
 82 |           <archive>
 83 |             <manifest>
 84 |               <mainClass>xtdbinabox.Box</mainClass>
 85 |             </manifest>
 86 |           </archive>
 87 |           <descriptorRefs>
 88 |             <descriptorRef>jar-with-dependencies</descriptorRef>
 89 |           </descriptorRefs>
 90 |         </configuration>
 91 |         <executions>
 92 |           <execution>
 93 |             <id>make-assembly</id> <!-- this is used for inheritance merges -->
 94 |             <phase>package</phase> <!-- bind to the packaging phase -->
 95 |             <goals>
 96 |               <goal>single</goal>
 97 |             </goals>
 98 |           </execution>
 99 |         </executions>
100 |       </plugin>
101 | 
102 |     </plugins>
103 |   </build>
104 | </project>
105 | 


--------------------------------------------------------------------------------