Ruby Driver Examples

The Ruby driver is an official driver maintained by MongoDB. It is written in Ruby, and is currently compatible with the following versions of MongoDB:

Ruby Driver	MongoDB 2.4	MongoDB 2.6	MongoDB 3.0
2.0	✓	✓	✓
1.12	✓	✓	✓

The current version of the Ruby driver supports the following versions of Ruby:

Ruby Driver	Ruby 1.8.7	Ruby 1.9	Ruby 2.0	Ruby 2.1	JRuby
2.0		✓	✓	✓	✓
1.9	✓	✓	✓	✓	✓

Installation

The Ruby driver is bundled as a gem, and can be installed like so:

$ gem install mongo

Example document

Here’s the example document we’ll be using:

{
  start: '2015-09-02T22:46:30.782Z',
  end: '2016-09-02T22:46:30.782Z',
  location: 'Texas',
  official_game: false,
  winner: 'Javi',
  players: [
    {
      name: 'Javi',
      decks: [
        'Dinosaurs',
        'Plants'
      ],
      points: 24,
      place: 1
    },
    {
      name: 'Seth',
      decks: [
        'Spies',
        'Zombies'
      ],
      points: 20,
      place: 2
    },
    {
      name: 'Dave',
      decks: [
        'Steampunk',
        'Wizard'
      ],
      points: 20,
      place: 2
    },
    {
      name: 'Castro',
      decks: [
        'Shapeshifters',
        'Ninjas'
      ],
      points: 18,
      place: 4
    }
  ]
}

Connecting

Warning

When connecting using the MongoDB URI, we highly recommend avoiding usernames or passwords with an @ symbol inside. This can break the URI parsing and cause failures when trying to connect.

Connecting to a replica set:

The client has auto-discovery that will find all members of the replica set if not all are provided.

#!/usr/bin/env ruby
require 'mongo'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['iad-c17-0.objectrocket.com:12345, iad-c17-1.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE_NAME',
  replica_set: '3d62adc37bad4f628cf5e8db921ce445',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD'
}

begin
  client = Mongo::Client.new(client_host, client_options)
  puts('Client Connection: ')
  puts(client.cluster.inspect)
  puts
  puts('Collection Names: ')
  puts(client.database.collection_names)
  puts('Connected!')
  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

Client Connection:
#<Mongo::Cluster:0x70194211277920 servers=[#<Mongo::Server:0x70194203419280 address=iad-c17-0.objectrocket.com:12345>, #<Mongo::Server:0x70194203425760 address=iad-c17-1.objectrocket.com:49022>] topology=Replica Set>

Collection Names:
objectrocket.init
collection_1
collection_2
Connected!

Connecting to a sharded instance with a write concern of 1:

#!/usr/bin/env ruby
require 'mongo'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['syd-mongos0.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD',
  write: { w: 1 }
}

begin
  client = Mongo::Client.new(client_host, client_options)
  puts('Client Connection: ')
  puts(client.cluster.inspect)
  puts
  puts('Collection Names: ')
  puts(client.database.collection_names)
  puts('Connected!')
  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

Client Connection:
#<Mongo::Cluster:0x70257105430280 servers=[#<Mongo::Server:0x70257105429580 address=syd-mongos0.objectrocket.com:12345>] topology=Sharded>

Collection Names:
objectrocket.init
collection_1
collection_2
Connected!

Connecting to a sharded instance using SSL:

Make sure to change the port number when using an SSL connection.

#!/usr/bin/env ruby
require 'mongo'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['syd-mongos0.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD',
  ssl: true
}

begin
  client = Mongo::Client.new(client_host, client_options)
  puts('Client Connection: ')
  puts(client.cluster.inspect)
  puts
  puts('Collection Names: ')
  puts(client.database.collection_names)
  puts('Connected!')
  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

 Client Connection:
#<Mongo::Cluster:0x70323940844040 servers=[#<Mongo::Server:0x70323945742140 address=syd-mongos0.objectrocket.com:12345>] topology=Sharded>

Collection Names:
objectrocket.init
collection_1
collection_2
Connected!

Creating a document

Creating and inserting a document:

#!/usr/bin/env ruby
require 'mongo'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['iad-c17-1.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD',
}

example_doc = {
  start: '2015-09-02T22:46:30.782Z',
  end: '2016-09-02T22:46:30.782Z',
  location: 'Texas',
  official_game: false,
  winner: 'Javi',
  players: [
    {
      name: 'Javi',
      decks: [
        'Dinosaurs',
        'Plants'
      ],
      points: 24,
      place: 1
    },
    {
      name: 'Seth',
      decks: [
        'Spies',
        'Zombies'
      ],
      points: 20,
      place: 2
    },
    {
      name: 'Dave',
      decks: [
        'Steampunk',
        'Wizard'
      ],
      points: 20,
      place: 2
    },
    {
      name: 'Castro',
      decks: [
        'Shapeshifters',
        'Ninjas'
      ],
      points: 18,
      place: 4
    }
  ]
}

begin
  client = Mongo::Client.new(client_host, client_options)

  # Insert our example_doc
  result = client[:YOUR_COLLECTION_NAME].insert_one(example_doc)

  puts("There was #{result.returned_count} document inserted")
  puts("The _id of the new document is: #{result.inserted_id}")

  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

There was 1 document inserted
The _id of the new document is: 55e8a17b4d61639133000000

Reading documents

Finding documents with a specific field:

#!/usr/bin/env ruby
require 'mongo'
require 'neatjson'
require 'json'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['iad-c17-1.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD'
}

begin
  client = Mongo::Client.new(client_host, client_options)

  # Find the documents that match our query below
  result = client[:YOUR_COLLECTION_NAME].find(winner: 'Javi')

  # Iterate through each of the results
  result.each do |document|
    puts JSON.neat_generate(document)
  end

  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

{
  "start":"2015-09-02T22:46:30.782Z",
  "end":"2016-09-02T22:46:30.782Z",
  "location":"Texas",
  "official_game":false,
  "winner":"Javi",
  "players":[
    {"name":"Javi","decks":["Dinosaurs","Plants"],"points":24,"place":1},
    {"name":"Seth","decks":["Spies","Zombies"],"points":20,"place":2},
    {"name":"Dave","decks":["Steampunk","Wizard"],"points":20,"place":2},
    {"name":"Castro","decks":["Shapeshifters","Ninjas"],"points":18,"place":4}
  ],
  "_id":{  "$oid":"55e8a02f4d616390ce000000"}
}

Updating a document

Updating a document:

#!/usr/bin/env ruby
require 'mongo'
require 'neatjson'
require 'json'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['iad-c17-1.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD',
}

begin
  client = Mongo::Client.new(client_host, client_options)
  # Update the document that matches our query below
  result = client[:YOUR_COLLECTION_NAME].find(winner: 'Javi').update_one('$set' => { winner: 'Seth' })

  # Iterate through each of the results
  result.each do |document|
    puts JSON.neat_generate(document)
  end

  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

{
  "ok":1,
  "nModified":1,
  "n":1,
  "lastOp":{  "t":1441313472,  "i":1},
  "electionId":{  "$oid":"55e73f85fcfd98f64182f341"}
}

Deleting a document

Deleting a document:

#!/usr/bin/env ruby
require 'mongo'
require 'neatjson'
require 'json'

# Turn off debug-mode
Mongo::Logger.logger.level = Logger::WARN

client_host = ['iad-c17-1.objectrocket.com:12345']
client_options = {
  database: 'YOUR_DATABASE',
  user: 'YOUR_USERNAME',
  password: 'YOUR_PASSWORD',
}

begin
  client = Mongo::Client.new(client_host, client_options)

  # Delete the document that matches our query below
  result = client[:YOUR_COLLECTION_NAME].find(winner: 'Seth').delete_one

  # Iterate through each of the results
  result.each do |document|
    puts JSON.neat_generate(document)
  end

  client.close
rescue StandardError => err
  puts('Error: ')
  puts(err)
end

Output from above:

{
  "ok":1,
  "n":1,
  "lastOp":{  "t":1441313712,  "i":1},
  "electionId":{  "$oid":"55e73f85fcfd98f64182f341"}
}

Additional reading

If you need more help with the Ruby driver, links to official documentation are below:

• Ruby Driver API Documentation
• MongoDB Ruby Driver Tutorial
• Ruby Driver Documentation
• Ruby Driver Github

As always, if you have any questions, please don’t hesitate to reach out to our support team!