Protocol Compatibility#

# Write through ClickHouse
curl -X POST http://127.0.0.1:8123/ -H "X-ClickHouse-Key: $TOKEN" \
  --data-binary "INSERT INTO Person FORMAT JSONEachRow" \
  --data-binary '{"id":"ch1","name":"from-clickhouse","company":"Acme"}'
 
# Read through HTTP SQL — same row, same type
curl -X POST http://127.0.0.1:9090/query -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"sql":"SELECT name FROM Person WHERE company = '\''Acme'\''","purpose":"analytics"}'

# Write through Bolt
from neo4j import GraphDatabase
d = GraphDatabase.driver("bolt://127.0.0.1:7687", auth=("neo4j", "$TOKEN"))
with d.session() as s:
    s.run("CREATE (n:Person {id:'neo1', name:'Alice'})")

# Read through psql — same row, same type
psql -h 127.0.0.1 -p 5433 -U relata -c "SELECT * FROM Person WHERE id = 'neo1'"

# Ingest Person + CallEvent via HTTP
curl -X POST http://127.0.0.1:9090/ingest?object_type=CallEvent -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/x-ndjson" \
  -d '{"id":"c1","caller":"+14155550100","callee":"+14155550101"}'
 
# Query via HTTP PATHS_BETWEEN (graph operator over the same data)
curl -X POST http://127.0.0.1:9090/query -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"sql":"PATHS_BETWEEN('\''+14155550100'\'','\''+14155550101'\'', MAX_HOPS => 3)","purpose":"analytics"}'

redis-cli -h 127.0.0.1 -p 6379 -a $TOKEN SET config:timeout "30"

SELECT value FROM KvEntry WHERE _pk = 'config:timeout';
-- → "30"

export RELATA_BEARER_TOKEN=<your-strong-token>
 
RELATA_S3_PORT=9191 \
RELATA_PG_PORT=5433 \
RELATA_CLICKHOUSE_PORT=8123 \
RELATA_NEO4J_PORT=7474 \
RELATA_REDIS_PORT=6379 \
RELATA_MONGO_PORT=27017 \
relata serve

import boto3
from botocore.config import Config
 
s3 = boto3.client(
    "s3",
    endpoint_url="http://127.0.0.1:9191",
    aws_access_key_id="change-me",
    aws_secret_access_key="unused",
    config=Config(signature_version="s3v4", s3={"addressing_style": "path"}),
)
 
s3.create_bucket(Bucket="cases")
s3.put_object(Bucket="cases", Key="exhibit-1.txt", Body=b"hello world")
body = s3.get_object(Bucket="cases", Key="exhibit-1.txt")["Body"].read()
print(body)

SELECT key, size, content_hash FROM S3Object WHERE bucket = 'cases';

psql -h 127.0.0.1 -p 5433 -U relata relata
# password = RELATA_BEARER_TOKEN

CREATE EXTENSION vector;
CREATE TABLE docs (id text PRIMARY KEY, embedding vector(3));
INSERT INTO docs VALUES ('a', '[1,0,0]'), ('b', '[0.9,0.1,0]');
 
-- Cosine KNN — auto-routed to Relata's HNSW index
SELECT id FROM docs ORDER BY embedding <=> '[0.9,0.1,0]' LIMIT 2;

# HTTP
curl -X POST "http://127.0.0.1:8123/?query=SELECT+1" \
  -H "X-ClickHouse-Key: change-me"
 
curl -X POST http://127.0.0.1:8123/ \
  -H "X-ClickHouse-Key: change-me" \
  --data-binary "SELECT name FROM Person FORMAT JSONEachRow"

from clickhouse_driver import Client
 
ch = Client(host="127.0.0.1", port=9000, password="change-me")
rows = ch.execute("SELECT name FROM Person LIMIT 5")
print(rows)

# Write
curl -X POST "http://127.0.0.1:8123/" \
  -H "X-ClickHouse-Key: change-me" \
  --data-binary "INSERT INTO Person FORMAT JSONEachRow" \
  --data-binary '{"id":"ch1","name":"from-clickhouse"}'
 
# Read back over HTTP SQL (cross-door)
curl -X POST http://127.0.0.1:9090/query \
  -H "Authorization: Bearer change-me" \
  -H "Content-Type: application/json" \
  -d '{"sql":"SELECT * FROM Person WHERE id = '\''ch1'\''","purpose":"analytics"}'

# HTTP Cypher
curl -X POST http://neo4j:change-me@127.0.0.1:7474/db/neo4j/tx/commit \
  -H "Content-Type: application/json" \
  -d '{"statements":[{"statement":"MATCH (n) RETURN n LIMIT 5"}]}'

from neo4j import GraphDatabase
 
driver = GraphDatabase.driver("bolt://127.0.0.1:7687", auth=("neo4j", "change-me"))
with driver.session() as s:
    print(s.run("MATCH (n) RETURN n LIMIT 5").data())

# Write via Bolt, read back over SQL (cross-door)
from neo4j import GraphDatabase
driver = GraphDatabase.driver("bolt://127.0.0.1:7687", auth=("neo4j", "change-me"))
with driver.session() as s:
    s.run("CREATE (n:Person {id:'neo1', name:'from-cypher'})")

-- Read the same node over HTTP SQL
SELECT * FROM Person WHERE id = 'neo1';

redis-cli -h 127.0.0.1 -p 6379 -a change-me SET foo bar
redis-cli -h 127.0.0.1 -p 6379 -a change-me GET foo

SELECT key, value FROM KvEntry WHERE key = 'foo';

const { MongoClient } = require("mongodb");
const c = new MongoClient("mongodb://localhost:27017", {
  auth: { username: "relata", password: "change-me" },
});
const db = c.db("cases");
await db.collection("exhibits").insertOne({ _id: "ex1", body: "hello" });
console.log(await db.collection("exhibits").findOne({ _id: "ex1" }));

SELECT * FROM MongoDocument WHERE collection = 'exhibits';

# Enable on the server
RELATA_FLIGHT_ENABLE=true relata serve

import pyarrow.flight as fl
client = fl.connect("grpc://localhost:8815")
reader = client.do_get(fl.FlightDescriptor.for_command(
    b"PURPOSE 'analytics' SELECT * FROM Person"))
for batch in reader:
    print(batch.data.num_rows, "rows")

# GET
curl "http://localhost:9090/sparql?query=SELECT+%3Fs+%3Fp+%3Fo+WHERE+%7B+%3Fs+%3Fp+%3Fo+%7D+LIMIT+10" \
  -H "Authorization: Bearer $RELATA_BEARER_TOKEN"
 
# POST
curl -X POST http://localhost:9090/sparql \
  -H "Content-Type: application/sparql-query" \
  -H "Authorization: Bearer $RELATA_BEARER_TOKEN" \
  -d "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10"