(require '[chrondb.core :as chrondb])
;; Create a database
(def db (chrondb/create-chrondb))
;; Create documents
(chrondb/save db "user:1" {:name "Alice" :email "alice@example.com"})
(chrondb/save db "user:2" {:name "Bob" :email "bob@example.com"})
;; Retrieve a document
(def user (chrondb/get db "user:1"))
(println user) ;; {:name "Alice" :email "alice@example.com"}
;; Update a document
(chrondb/save db "user:1" (assoc user :age 30))
;; Search for documents
(def results (chrondb/search db "name:Alice"))
(println results)
;; Get document history
(def history (chrondb/history db "user:1"))
(println history)
;; Try branching
(def test-db (chrondb/create-branch db "test"))
(chrondb/save test-db "user:1" {:name "Alice (test)" :email "alice@test.com"})
;; Compare main and test branch
(println (chrondb/get db "user:1")) ;; Original version
(println (chrondb/get test-db "user:1")) ;; Test version
If you have ChronDB running with the REST API enabled, you can interact with it using HTTP:
# Create a document
curl -X POST http://localhost:3000/api/v1/documents/user:3 \
-H "Content-Type: application/json" \
-d '{"name": "Charlie", "email": "charlie@example.com"}'
# Retrieve a document
curl http://localhost:3000/api/v1/documents/user:3
# Update a document
curl -X POST http://localhost:3000/api/v1/documents/user:3 \
-H "Content-Type: application/json" \
-d '{"name": "Charlie", "email": "charlie@example.com", "age": 25}'
# Search for documents
curl http://localhost:3000/api/v1/search?q=name:Charlie
# Get document history
curl http://localhost:3000/api/v1/documents/user:3/history
For more comprehensive REST API examples, including JavaScript clients, see REST API Documentation.
Using the Redis Protocol
If you have Redis CLI installed, you can interact with ChronDB using Redis commands:
# Connect to ChronDB via Redis protocol
redis-cli -h localhost -p 6379
# Create a document
SET user:4 '{"name":"Dave","email":"dave@example.com"}'
# Retrieve a document
GET user:4
# Update a document
SET user:4 '{"name":"Dave","email":"dave@example.com","age":35}'
# Get document history (ChronDB-specific command)
CHRONDB.HISTORY user:4
If you have psql installed, you can interact with ChronDB using SQL:
# Connect to ChronDB via PostgreSQL protocol
psql -h localhost -p 5432 -U chrondb -d chrondb
# Create a document (as a row in a table)
INSERT INTO user (id, name, email) VALUES ('5', 'Eve', 'eve@example.com');
# Retrieve a document
SELECT * FROM user WHERE id = '5';
# Update a document
UPDATE user SET email = 'eve.smith@example.com' WHERE id = '5';
# Get document history (ChronDB-specific function)
SELECT * FROM chrondb_history('user', '5');
Once you're familiar with basic operations, try these key features:
Version Control
;; Get a document as it existed at a point in time
(def old-version (chrondb/get-at db "user:1" "2023-01-01T00:00:00Z"))
;; Compare versions
(def diff (chrondb/diff db "user:1"
"2023-01-01T00:00:00Z"
"2023-06-01T00:00:00Z"))
;; Create a development branch
(def dev-db (chrondb/create-branch db "dev"))
;; Make changes in the dev branch
(chrondb/save dev-db "user:1" {:name "Alice (Updated)" :email "alice@example.com"})
;; Merge changes back to main
(def merged-db (chrondb/merge-branch db "dev" "main"))
Transactions
;; Execute multiple operations atomically
(chrondb/with-transaction [db]
(chrondb/save db "order:1" {:items [{:id "item1" :qty 2}] :total 50.0})
(chrondb/save db "inventory:item1" {:stock 18}) ;; Reducing stock
(chrondb/save db "user:1" (update (chrondb/get db "user:1") :orders conj "order:1")))
