nuodb

== NuoDB Ruby Interface

{}[http://travis-ci.org/nuodb/ruby-nuodb] {}[https://gemnasium.com/nuodb/ruby-nuodb] {}[https://codeclimate.com/github/nuodb/ruby-nuodb]

== Description

This is the official Ruby Gem for {NuoDB}[http://www.nuodb.com/]. It wraps the NuoDB C++ API, providing a natural API for Ruby.

To use NuoDB with Rails you will also want the {ActiveRecord NuoDB Adapter}[https://github.com/nuodb/ruby-activerecord-nuodb-adapter]

Note: At this time the Ruby/NuoDB Interface does not support Windows.

== Getting Started

1. If you haven't already, {Download and Install NuoDB}[http://nuodb.com/download-nuodb/]

2. Install the gem

   gem install nuodb
   

3. Use NuoDB in Ruby

   require "nuodb"
   
   conn = NuoDB::Connection.new(:database => 'test@localhost', :username => 'dba', :password => 'goalie', :schema => 'hockey')
   stmt = conn.statement
   stmt.execute("SELECT * FROM hockey")
   stmt.results.each do |res|
       puts res.inspect
   end
   

== More Information

• {Ruby/NuoDB Interface Rdoc}[http://nuodb.github.io/ruby-nuodb/site/]
• {NuoDB Community Forum}[http://www.nuodb.com/community/forum.php]
• {NuoDB Online Documentation}[http://doc.nuodb.com/display/doc/NuoDB+Online+Documentation]

== Contributing

See {Contribution}[http://nuodb.github.io/ruby-nuodb/site/files/rdoc/GETTING_STARTED_rdoc.html] for information about contributing to the NuoDB Ruby Adapter.