Skip to content

Documentation and Resources

The complete XTDB reference documentation. Here you will find APIs for developers and tools for ops. Customize your XTDB installation with modules.

Note

This is the documentation for version 1.x - the current stable, production-ready release of XTDB.

For documentation on the 2.x early access, head here.


Language Reference

View all →

Learn to interact with XTDB using Datalog, SQL, or both.

Datalog Transactions

Add records using Datalog

Datalog Queries

Advanced graph query using Datalog

SQL

Create schemas and query them using SQL


Clients

View all →

When you use an in-process instance of XTDB, you can talk to it using either Clojure or Java APIs.

Clojure

Transact, query, and configure your XTDB node with Clojure.

Java

Transact, query, and configure your XTDB node with Java.

HTTP

Transact, query, and configure your XTDB node with HTTP.


Administration

View all →

Resources for sysadmins and DevOps.

Installing

Install XTDB as a library, a standalone server, or Docker container.

Configuring

Customize XTDB modules, tune the query engine, and upgrade indexes.

Building

Build a custom XTDB image with only the modules you require.

Monitoring

Observe your metrics on live XTDB instances with Prometheus, AWS Cloudwatch, JMX, or plaintext.

Checkpointing

Save checkpoints of query indices on a regular basis so you can start new nodes quickly.


Extensions

View all →

Customize your XTDB install with powerful extension modules.


Storage

View all →

XTDB supports a wide array of pluggable underlying storage. Learn more about each module below.