Mylk — The SurrealDB Ruby client

Installation

Add gem to the application's Gemfile:

gem "mylk"

Install it:

bundle install

Usage

Both the HTTP and WebSocket clients provide the same interface for executing commands. The only difference is the underlying transport mechanism.

If you are building concurrent (multi-threaded) applications, it is recommended to use the WebSocket client due to its superior performance. However, the HTTP client is still thread-safe and can also be used if you prefer.

WebSocket Client

require "mylk/websocket"

client = Mylk::WebSocket.new("surrealdb://root:root@localhost:8000/test/test").tap(&:connect)
response = client.execute("INFO FOR DB")

response.success? # => true
response.time # => "265.625µs"
response.result # => {"dl"=>{}, "dt"=>{}, "pa"=>{}, "sc"=>{}, "tb"=>{}}

HTTP Client

require "mylk/http"

client = Mylk::HTTP.new("surrealdb://root:root@localhost:8000/test/test").tap(&:connect)
response = client.execute("INFO FOR DB")

response.success? # => true
response.time # => "265.625µs"
response.result # => {"dl"=>{}, "dt"=>{}, "pa"=>{}, "sc"=>{}, "tb"=>{}}

Database connection string format

surreal://<username>:<password>@<host>:<port>/<namespace>/<database>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ri-nat/mylk.

License

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

ri-nat / mylk