https://github.com/ri-nat/mylk

💎 Ruby client for SurrealDB
https://github.com/ri-nat/mylk

Last synced: about 1 month ago
JSON representation

💎 Ruby client for SurrealDB

• Host: GitHub
• URL: https://github.com/ri-nat/mylk
• Owner: ri-nat
• License: mit
• Created: 2023-02-20T13:57:21.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T00:43:58.000Z (5 months ago)
• Last Synced: 2024-10-06T12:36:47.177Z (3 months ago)
• Language: Ruby
• Homepage:
• Size: 28.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-surreal - mylk - Client library for [Ruby](https://www.ruby-lang.org/en/) with support for HTTP and WebSocket connections. (Client libraries)

README

        
# Mylk — The SurrealDB Ruby client

[![Tests](https://github.com/ri-nat/mylk/actions/workflows/main.yml/badge.svg)](https://github.com/ri-nat/mylk/actions/workflows/main.yml)

## Installation

Add gem to the application's Gemfile:

```bash

gem "mylk"

```

Install it:

```bash

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

```ruby

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

```ruby

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

```text

surreal://:@://

```

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at .

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).