CrateDB Ruby Client

.. image

badge.fury.io/rb/crate_ruby.svg

:target: http://badge.fury.io/rb/crate_ruby
:alt: Gem Version

.. image

travis-ci.org/crate/crate_ruby.svg?branch=master

:target: https://travis-ci.org/crate/crate_ruby
:alt: Build Status

.. image

:target: https://codeclimate.com/github/crate/crate_ruby
:alt: Code Climate

|

A Ruby client library for CrateDB_.

Prerequisites

You will need Ruby 2.0 or greater.

Installation

The CrateDB Ruby client is available as a Ruby gem_.

Add this line to your application’s “Gemfile“

gem ‘crate_ruby’

Or, install it manually, like so

$ gem install crate_ruby

Examples

Set up the client like so

require ‘crate_ruby’

client = CrateRuby::Client.new

Execute SQL queries like so

result = client.execute(“Select * from posts”)

=> #<CrateRuby::ResultSet:0x00000002a9c5e8 @rowcount=1, @duration=5>

result.each do |row|

puts row.inspect

end

=> [1, "test", 5]

result.cols

=> ["id", "my_column", "my_integer_col"]

Perform parameter substitution like so

client.execute(

"INSERT INTO posts (id, title, tags) VALUES (\$1, \$2, \$3)",
[1, "My life with crate", ['awesome', 'cool']])

Manipulate BLOBs like so

digest = Digest::SHA1.file(file_path).hexdigest

# upload f = File.read(file_path) client.blob_put(table_name, digest, f)

# download data = client.blob_get(table_name, digest) open(file_path, “wb”) do |file|

file.write(data)

end

# deletion client.blob_delete(table_name, digest)

Schema support

A default schema can be set by passing in the schema name::

CrateRuby::Client.new(['localhost:44200'], schema: 'my_schema')

Authentication

Authentication credentials can be passed to the client if needed::

CrateRuby::Client.new(['localhost:44200'], username: 'foo', password: 'supersecret')

Version matrix

--------------————+ | Crate Ruby | CrateDB | ==========================+ | < 0.9 | < 0.57 | --------------————+ | 0.9 | >= 0.57 | --------------————+

Contributing

This project is primarily maintained by Crate.io_, but we welcome community contributions!

See the ‘developer docs`_ and the `contribution docs`_ for more information.

Help

Looking for more help?

• Check ‘StackOverflow`_ for common problems

• Chat with us on ‘Slack`_

• Get ‘paid support`_

.. _contribution docs: CONTRIBUTING.rst .. _Crate.io: crate.io .. _CrateDB: github.com/crate/crate .. _developer docs: DEVELOP.rst .. _gem: rubygems.org/ .. _paid support: crate.io/pricing/ .. _Slack: crate.io/docs/support/slackin/ .. _StackOverflow: stackoverflow.com/tags/crate