SurrealEx (surrealdb_ex v0.0.2)

Welcome to the Elixir driver for SurrealDB! This library allows you to connect to SurrealDB, a highly-scalable, distributed NoSQL database designed for modern applications. With the Elixir driver, you can seamlessly integrate SurrealDB into your Elixir projects and enjoy the benefits of a robust, cloud-native database.

The Elixir driver for SurrealDB provides a simple, yet powerful API for working with SurrealDB. It leverages the Erlang/Elixir ecosystem to provide a performant and fault-tolerant connection to SurrealDB, and supports a wide range of operations such as querying, inserting, updating, and deleting data.

This documentation provides a comprehensive guide to using the Elixir driver for SurrealDB. It covers everything from installation and setup, to advanced usage scenarios and troubleshooting tips. Whether you are a seasoned Elixir developer or new to the language, this documentation will help you get up and running with SurrealDB in no time.

We hope you enjoy using the Elixir driver for SurrealDB and welcome your feedback and contributions. Happy coding!

Summary

Types

config()

Functions

authenticate(pid, token)

See SurrealEx.Socket.authenticate/2.

authenticate(pid, token, task)

See SurrealEx.Socket.authenticate/3.

authenticate(pid, token, task, opts)

See SurrealEx.Socket.authenticate/4.

change(pid, table, payload)

See SurrealEx.Socket.change/3.

change(pid, table, payload, task)

See SurrealEx.Socket.change/4.

change(pid, table, payload, task, opts)

See SurrealEx.Socket.change/5.

child_spec(opts \\ [])

See SurrealEx.Socket.child_spec/1.

create(pid, table, payload)

See SurrealEx.Socket.create/3.

create(pid, table, payload, task)

See SurrealEx.Socket.create/4.

create(pid, table, payload, task, opts)

See SurrealEx.Socket.create/5.

delete(pid, table)

See SurrealEx.Socket.delete/2.

delete(pid, table, task)

See SurrealEx.Socket.delete/3.

delete(pid, table, task, opts)

See SurrealEx.Socket.delete/4.

info(pid)

See SurrealEx.Socket.info/1.

info(pid, task)

See SurrealEx.Socket.info/2.

info(pid, task, opts)

See SurrealEx.Socket.info/3.

invalidate(pid)

See SurrealEx.Socket.invalidate/1.

invalidate(pid, task)

See SurrealEx.Socket.invalidate/2.

invalidate(pid, task, opts)

See SurrealEx.Socket.invalidate/3.

kill(pid, query)

See SurrealEx.Socket.kill/2.

kill(pid, query, task)

See SurrealEx.Socket.kill/3.

kill(pid, query, task, opts)

See SurrealEx.Socket.kill/4.

let(pid, key, value)

See SurrealEx.Socket.let/3.

let(pid, key, value, task)

See SurrealEx.Socket.let/4.

let(pid, key, value, task, opts)

See SurrealEx.Socket.let/5.

live(pid, table)

See SurrealEx.Socket.live/2.

live(pid, table, task)

See SurrealEx.Socket.live/3.

live(pid, table, task, opts)

See SurrealEx.Socket.live/4.

modify(pid, table, payload)

See SurrealEx.Socket.modify/3.

modify(pid, table, payload, task)

See SurrealEx.Socket.modify/4.

modify(pid, table, payload, task, opts)

See SurrealEx.Socket.modify/5.

ping(pid)

See SurrealEx.Socket.ping/1.

ping(pid, task)

See SurrealEx.Socket.ping/2.

ping(pid, task, opts)

See SurrealEx.Socket.ping/3.

query(pid, query, payload)

See SurrealEx.Socket.query/3.

query(pid, query, payload, task)

See SurrealEx.Socket.query/4.

query(pid, query, payload, task, opts)

See SurrealEx.Socket.query/5.

select(pid, query)

See SurrealEx.Socket.select/2.

select(pid, query, task)

See SurrealEx.Socket.select/3.

select(pid, query, task, opts)

See SurrealEx.Socket.select/4.

signin(pid, payload)

See SurrealEx.Socket.signin/2.

signin(pid, payload, task)

See SurrealEx.Socket.signin/3.

signin(pid, payload, task, opts)

See SurrealEx.Socket.signin/4.

signup(pid, payload)

See SurrealEx.Socket.signup/2.

signup(pid, payload, task)

See SurrealEx.Socket.signup/3.

signup(pid, payload, task, opts)

See SurrealEx.Socket.signup/4.

start_link()

See SurrealEx.Socket.start_link/0.

start_link(opts)

See SurrealEx.Socket.start_link/1.

stop(pid)

See SurrealEx.Socket.stop/1.

update(pid, table, payload)

See SurrealEx.Socket.update/3.

update(pid, table, payload, task)

See SurrealEx.Socket.update/4.

update(pid, table, payload, task, opts)

See SurrealEx.Socket.update/5.

use(pid, namespace, database)

See SurrealEx.Socket.use/3.

use(pid, namespace, database, task)

See SurrealEx.Socket.use/4.

use(pid, namespace, database, task, opts)

See SurrealEx.Socket.use/5.