Examples

This document provides links to detailed examples for using the various ChronDB interfaces.

ChronDB supports multiple access protocols, allowing you to choose the interface that best suits your needs:

Clojure API

The native Clojure API offers the most direct way to interact with ChronDB, providing access to all features including CRUD operations, searching, version control, and branching.

;; Basic example
(require '[chrondb.core :as chrondb])
(def db (chrondb/create-chrondb))
(chrondb/save db "user:1" {:name "Alice" :email "[e-mail]"})

View complete Clojure API examples →

REST API

The REST API allows you to interact with ChronDB using HTTP requests, making it easy to integrate with any programming language or environment that can make HTTP requests.

# Create a document using curl
curl -X POST http://localhost:3000/api/v1/documents/user:1 \
  -H "Content-Type: application/json" \
  -d '{"name": "John Doe", "email": "[e-mail]"}'

View complete REST API examples →

Redis Protocol

ChronDB implements a subset of the Redis protocol, allowing you to connect using standard Redis clients.

# Using redis-cli
redis-cli -h localhost -p 6379
> SET user:1 '{"name":"John Doe","email":"[e-mail]"}'

View complete Redis protocol examples →

PostgreSQL Protocol

ChronDB implements a subset of the PostgreSQL protocol, allowing you to connect using standard PostgreSQL clients and leverage SQL query capabilities.

-- Create a document using psql
INSERT INTO user (id, name, email)
VALUES ('1', 'John Doe', '[e-mail]');

View complete PostgreSQL protocol examples →

---

Choose the interface that best suits your needs and refer to the specific documentation for detailed examples and use cases.