Client API

Talk to Scalaxy from Lisp, curl, or your own language over the wire protocol.

Lisp client

(require :asdf)
(asdf:load-asd "/path/to/scalaxy/scalaxy.asd")
(asdf:load-system "scalaxy")

(defvar *db* (scalaxy:connect :host "127.0.0.1" :port 7200))

(scalaxy:put *db* "user:1" "Alice")                ; => T
(scalaxy:get *db* "user:1")                        ; octet vector
(scalaxy:octets-to-string (scalaxy:get *db* "user:1"))
;; => "Alice"

(scalaxy:scan *db* "user:")                        ; ((key . value) ...)
(scalaxy:delete *db* "user:1")                     ; => T

Values are octet vectors, so any binary payload stores as-is. The client speaks the wire protocol directly over TCP; it does not require HTTP.

Graph queries run through the same client:

(scalaxy:cypher *db* "MATCH (a:Person)-[:KNOWS]->(b:Person) RETURN a.name AS from, b.name AS to")
;; => #<hash-table: "columns" (#<... "from" "to">) "rows" (...) "count" N>

cypher returns the decoded JSON result table (columns, rows, count) and accepts :params for parameterized queries. On a cluster node it routes through the gateway like any other operation.

curl

Use the REST API (reference) from scripts:

curl -X PUT http://localhost:8080/api/keys/flag -d '{"value":"on"}'
curl http://localhost:8080/api/keys/flag
curl "http://localhost:8080/api/keys?prefix=flag"
curl -X DELETE http://localhost:8080/api/keys/flag

Other languages

The wire protocol is a length-prefixed binary format over TCP. Any language with TCP sockets can implement a client in a few hundred lines; the opcode table gives the exact layout.

Cluster-aware routing

When a node runs with SCALAXY_PEERS set, REST and console operations route to ring owners automatically. For raw TCP clients, connect to any node and use the ring hashing rules to target the owner, or use the REST API as a gateway.