xtdb / 2x-playground

Developer Experience experimentation for 2.x
MIT License
6 stars 5 forks source link

= 2x-playground

This repository provides a wide range of examples which allow you to experiment with the XTDB's UX.


. ├── README.adoc ├── SQL.adoc │ │ # clients: ├── clojure ├── psql ├── python │ │ # servers: ├── xtdb-server-clj └── xtdb-server-docker

== Start a server

=== Option 1: Docker

[source,sh]

docker pull ghcr.io/xtdb/xtdb-ea docker run -ti --rm -p 5432:5432 -p 9832:9832 -p 3000:3000 ghcr.io/xtdb/xtdb-ea:latest

=== Option 2: JAR

TODO

=== Option 3: Clojure in-process

== XTDB SQL

The SQL dialect available in XTDB tries very hard to adhere to the SQL Specification. There are small deviations from the spec where absolutely required. Read more in https://github.com/xtdb/2x-playground/blob/main/SQL.adoc[`SQL.adoc`].

== psql

Install psql (Postgres) if you don't have it already. Some package managers offer the Postgres client in isolation (ubuntu has postgresql-client) but this is surprisingly uncommon.

[source,sh]

sudo apt-get install -y postgresql sudo pacman -S postgresql brew install postgresql

etc.


== Python

== Clojure

The Clojure examples consume XTDB directly, running a client and server in the same process for convenience. This means you do not need to start an external XTDB server. (Though you still can, of course.) The client code still speaks to XTDB over the pgwire protocol using JDBC.

./clojure/README.adoc