Surrealix

Lightweight, correct and up-to-date Elixir SDK for SurrealDB.

The API is 100% code-generated (https://github.com/maxohq/surrealix/blob/main/gen/src/api.ts) and implements the Websocket protocol as documented here - WebSocket (text protocol).

Elixir documentation shows raw examples from the SurrealDB docs, so that it's very clear what happens behind the covers. There are no futher abstractions, so you can keep referring the official docs while you develop your application.

Why use Surrealix?

• up-to-date on the Websocket API for SurrealDB (https://github.com/maxohq/surrealix/blob/main/gen/src/api.ts)
• minimal abstraction over WebSocket (text protocol) for SurrealDB
• first-class support for live-query callbacks (currently the ONLY Elixir SDK)
• :telemetry events for request handling
• extensive and very maintainble (thanks to mneme) E2E tests against SurrealDB server (https://github.com/maxohq/surrealix/tree/main/lib/surrealdb)

Usage

# {:ok, pid} = Surrealix.start_link(namespace: "test", database: "test", debug: [:trace]) ## for debugging!
{:ok, pid} = Surrealix.start_link(namespace: "test", database: "test")
Surrealix.signin(pid, %{user: "root", pass: "root"})
Surrealix.use(pid, "test", "test")
Surrealix.query(pid, "SELECT * FROM person;")
Surrealix.query(pid, "SELECT * FROM type::table($table);", %{table: "person"})

## Example with live query callbacks
Surrealix.live_query(pid, "LIVE SELECT * FROM user;", fn event, data, config ->
  IO.inspect({event, data, config}, label: "callback")
end)

# inspect currently registered live queries
Surrealix.all_live_queries(pid)

Configuration

## in config.exs / runtime.exs file
# default 5000
config :surrealix, timeout: :infinity
config :surrealix, :conn,
  hostname: "0.0.0.0",
  port: 8000

Installation

If available in Hex, the package can be installed by adding surrealix to your list of dependencies in mix.exs:

def deps do
  [
    {:surrealix, "~> 0.1"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/surrealix.

Aknowledgements

Code foundation was taken from https://github.com/joojscript/surrealdb_ex. Since this package has not received any commits in the last 7 months (2023-10-31) and the issues are left uncommented, I have assumed that the maintainer is not interested in any contributions.

Ref

• Websockex callbacks (Elixir)
• Websocket Text Protocol
• JS SDK for websockets
• Source code for the Websocket Text Protocol docs
• SurrealDB SQL statements
• SurrealDB functions

Todo

• handle live query updates properly
• debug modus with verbose logging
• integration tests
• handle disconnects gracefully
• benchmarks

Support

License

The lib is available as open source under the terms of the MIT License.