mongo-ruby-driver/README.md

340 lines
11 KiB
Markdown
Raw Normal View History

# Documentation
This API documentation is available online at [http://api.mongodb.org/ruby](http://api.mongodb.org/ruby)
for all releases of the MongoDB Ruby driver. Please reference the exact version of the documentation
that matches the release of the Ruby driver that you are using. Note that the
[Ruby Language Center for MongoDB](http://www.mongodb.org/display/DOCS/Ruby+Language+Center)
has a link to API Documentation for the current release.
If you have the source, you can generate the matching documentation by typing
$ rake ydoc
Then open the file +ydoc/index.html+.
# Introduction
2008-12-02 01:20:00 +00:00
This is the 10gen-supported Ruby driver for [MongoDB](http://www.mongodb.org).
2010-11-03 21:50:08 +00:00
This documentation includes other articles of interest, include:
2010-11-29 22:14:27 +00:00
1. [A tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html).
2. [Replica Sets in Ruby](http://api.mongodb.org/ruby/current/file.REPLICA_SETS.html).
3. [Write Concern in Ruby](http://api.mongodb.org/ruby/current/file.WRITE_CONCERN.html).
2011-09-06 20:33:36 +00:00
4. [Tailable Cursors in Ruby](http://api.mongodb.org/ruby/current/file.TAILABLE_CURSORS.html).
5. [Read Preference in Ruby](http://api.mongodb.org/ruby/current/file.READ_PREFERENCE.html).
6. [GridFS in Ruby](http://api.mongodb.org/ruby/current/file.GridFS.html).
7. [Frequently Asked Questions](http://api.mongodb.org/ruby/current/file.FAQ.html).
8. [History](http://api.mongodb.org/ruby/current/file.HISTORY.html).
9. [Release plan](http://api.mongodb.org/ruby/current/file.RELEASES.html).
10. [Credits](http://api.mongodb.org/ruby/current/file.CREDITS.html).
2010-11-29 22:04:39 +00:00
Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html)
for much more:
2010-11-02 18:26:31 +00:00
require 'rubygems'
require 'mongo'
@conn = Mongo::Connection.new
@db = @conn['sample-db']
@coll = @db['test']
2009-01-29 16:23:50 +00:00
@coll.remove
3.times do |i|
@coll.insert({'a' => i+1})
end
puts "There are #{@coll.count} records. Here they are:"
@coll.find.each { |doc| puts doc.inspect }
2010-11-02 18:26:31 +00:00
# Installation
### Ruby Versions
2010-06-16 03:05:46 +00:00
2012-02-22 18:54:53 +00:00
The driver works and is consistently tested on Ruby 1.8.7 and 1.9.3 as well as JRuby 1.6.6.
2010-06-16 03:05:46 +00:00
Note that if you're on 1.8.7, be sure that you're using a patchlevel >= 249. There
are some IO bugs in earlier versions.
### Gems
2010-06-16 03:05:46 +00:00
The driver's gems are hosted at [Rubygems.org](http://rubygems.org). Make sure you're
2010-03-04 16:32:59 +00:00
using the latest version of rubygems:
$ gem update --system
2010-03-04 16:32:59 +00:00
Then you can install the mongo gem as follows:
$ gem install mongo
2009-01-23 13:53:48 +00:00
2010-10-07 21:55:36 +00:00
The driver also requires the bson gem:
2010-04-07 23:25:09 +00:00
$ gem install bson
2010-04-07 23:25:09 +00:00
And for a significant performance boost, you'll want to install the C extensions:
2009-11-16 21:10:12 +00:00
$ gem install bson_ext
2009-11-16 21:10:12 +00:00
2010-10-07 21:55:36 +00:00
Note that bson_ext isn't used with JRuby. Instead, some native Java extensions are bundled with the bson gem.
If you ever need to modify these extensions, you can recompile with the following rake task:
2010-10-07 21:55:36 +00:00
$ rake build:java
2010-10-07 21:55:36 +00:00
### From the GitHub source
2009-01-23 13:53:48 +00:00
2009-01-15 21:05:56 +00:00
The source code is available at http://github.com/mongodb/mongo-ruby-driver.
You can either clone the git repository or download a tarball or zip file.
Once you have the source, you can use it from wherever you downloaded it or
you can install it as a gem from the source by typing
$ rake gem:install
2009-11-16 21:45:37 +00:00
To install the C extensions from source, type this instead:
$ rake gem:install_extensions
That's all there is to it!
# Examples
2008-12-02 01:20:00 +00:00
For extensive examples, see the [MongoDB Ruby Tutorial](http://www.mongodb.org/display/DOCS/Ruby+Tutorial).
2009-11-24 22:39:44 +00:00
2010-11-03 17:00:34 +00:00
Bundled with the driver are many examples, located in the "docs/examples" subdirectory. Samples include using
2009-11-24 22:39:44 +00:00
the driver and using the GridFS class GridStore. MongoDB must be running for
2009-02-03 17:16:33 +00:00
these examples to work, of course.
2009-01-07 21:07:22 +00:00
2009-11-24 22:39:44 +00:00
Here's how to start MongoDB and run the "simple.rb" example:
2009-02-03 17:16:33 +00:00
$ cd path/to/mongo
$ ./mongod run
... then in another window ...
$ cd path/to/mongo-ruby-driver
2010-11-03 17:00:34 +00:00
$ ruby docs/examples/simple.rb
2008-12-02 01:20:00 +00:00
2009-08-18 14:07:01 +00:00
See also the test code, especially test/test_db_api.rb.
2008-12-02 01:20:00 +00:00
# GridFS
2009-01-29 16:23:50 +00:00
2010-02-24 20:24:01 +00:00
The Ruby driver include two abstractions for storing large files: Grid and GridFileSystem.
The Grid class is a Ruby implementation of MongoDB's GridFS file storage
specification. GridFileSystem is essentially the same, but provides a more filesystem-like API
2010-02-24 20:24:01 +00:00
and assumes that filenames are unique.
2009-01-29 16:31:45 +00:00
2010-02-24 20:24:01 +00:00
An instance of both classes represents an individual file store. See the API reference
for details, and see examples/gridfs.rb for code that uses many of the Grid
features (metadata, content type, seek, tell, etc).
2009-01-29 16:31:45 +00:00
2010-02-24 20:24:01 +00:00
Examples:
# Write a file on disk to the Grid
file = File.open('image.jpg')
grid = Mongo::Grid.new(db)
id = grid.put(file)
2010-02-24 20:24:01 +00:00
# Retrieve the file
file = grid.get(id)
file.read
# Get all the file's metata
file.filename
file.content_type
file.metadata
# Notes
## Thread Safety
2009-10-09 04:33:35 +00:00
2010-01-13 21:36:53 +00:00
The driver is thread-safe.
2009-11-24 22:39:44 +00:00
## Connection Pooling
2009-11-24 22:39:44 +00:00
2011-02-10 20:13:28 +00:00
The driver implements connection pooling. By default, only one
2009-11-24 22:39:44 +00:00
socket connection will be opened to MongoDB. However, if you're running a
multi-threaded application, you can specify a maximum pool size and a maximum
timeout for waiting for old connections to be released to the pool.
To set up a pooled connection to a single MongoDB instance:
@conn = Connection.new("localhost", 27017, :pool_size => 5, :timeout => 5)
2009-11-24 22:39:44 +00:00
Though the pooling architecture will undoubtedly evolve, it currently owes much credit
2009-11-24 22:39:44 +00:00
to the connection pooling implementations in ActiveRecord and PyMongo.
2009-10-09 04:33:35 +00:00
## Forking
2011-02-10 20:13:28 +00:00
Certain Ruby application servers work by forking, and it has long been necessary to
re-establish the child process's connection to the database after fork. But with the release
of v1.3.0, the Ruby driver detects forking and reconnects automatically.
## String Encoding
2009-01-13 17:53:55 +00:00
The BSON ("Binary JSON") format used to communicate with Mongo requires that
strings be UTF-8 (http://en.wikipedia.org/wiki/UTF-8).
Ruby 1.9 has built-in character encoding support. All strings sent to Mongo
and received from Mongo are converted to UTF-8 when necessary, and strings
read from Mongo will have their character encodings set to UTF-8.
When used with Ruby 1.8, the bytes in each string are written to and read from
Mongo as is. If the string is ASCII, all is well, because ASCII is a subset of
UTF-8. If the string is not ASCII, it may not be a well-formed UTF-8
string.
## Primary Keys
2009-02-01 14:14:21 +00:00
The `_id` field is a primary key. It is treated specially by the database, and
2009-07-13 16:18:05 +00:00
its use makes many operations more efficient. The value of an _id may be of
any type. The database itself inserts an _id value if none is specified when
a record is inserted.
2009-02-01 15:25:50 +00:00
### Primary Key Factories
2009-02-01 14:14:21 +00:00
A primary key factory is a class you supply to a DB object that knows how to
2009-07-13 16:18:05 +00:00
generate _id values. If you want to control _id values or even their types,
using a PK factory lets you do so.
2009-02-01 14:14:21 +00:00
You can tell the Ruby Mongo driver how to create primary keys by passing in
the :pk option to the Connection#db method.
db = Mongo::Connection.new.db('dbname', :pk => MyPKFactory.new)
A primary key factory object must respond to :create_pk, which should
take a hash and return a hash which merges the original hash with any
primary key fields the factory wishes to inject.
NOTE: if the object already has a primary key, the factory should not
inject a new key; this means that the object may already exist in the
database. The idea here is that whenever a record is inserted, the
:pk object's +create_pk+ method will be called and the new hash
returned will be inserted.
Here is a sample primary key factory, taken from the tests:
class TestPKFactory
def create_pk(row)
2012-02-22 11:08:14 +00:00
row['_id'] ||= BSON::ObjectId.new
row
end
end
2009-01-29 16:31:45 +00:00
Here's a slightly more sophisticated one that handles both symbol and string
keys. This is the PKFactory that comes with the MongoRecord code (an
ActiveRecord-like framework for non-Rails apps) and the AR Mongo adapter code
(for Rails):
class PKFactory
def create_pk(row)
return row if row[:_id]
row.delete(:_id) # in case it exists but the value is nil
2012-02-22 11:08:14 +00:00
row['_id'] ||= BSON::ObjectId.new
row
end
2009-01-29 16:31:45 +00:00
end
2009-02-01 14:14:21 +00:00
A database's PK factory object may be set either when a DB object is created
or immediately after you obtain it, but only once. The only reason it is
changeable at all is so that libraries such as MongoRecord that use this
driver can set the PK factory after obtaining the database but before using it
for the first time.
## The DB Class
### Strict mode
Each database has an optional strict mode. If strict mode is on, then asking
for a collection that does not exist will raise an error, as will asking to
create a collection that already exists. Note that both these operations are
completely harmless; strict mode is a programmer convenience only.
To turn on strict mode, either pass in :strict => true when obtaining a DB
object or call the `:strict=` method:
db = Connection.new.db('dbname', :strict => true)
# I'm feeling lax
db.strict = false
# No, I'm not!
db.strict = true
The method DB#strict? returns the current value of that flag.
## Cursors
2009-02-03 17:43:22 +00:00
Notes:
2009-02-03 17:43:22 +00:00
* Cursors are enumerable (and have a #to_a method).
2009-02-03 17:43:22 +00:00
* The query doesn't get run until you actually attempt to retrieve data from a
2009-02-03 17:43:22 +00:00
cursor.
* Cursors will timeout on the server after 10 minutes. If you need to keep a cursor
open for more than 10 minutes, specify `:timeout => false` when you create the cursor.
2009-02-03 17:43:22 +00:00
## Socket timeouts
The Ruby driver support timeouts on socket read operations. To enable them, set the
`:op_timeout` option when you create a `Mongo::Connection` object.
If implementing higher-level timeouts, using tools like `Rack::Timeout`, it's very important
to call `Mongo::Connection#close` to prevent the subsequent operation from receiving the previous
request.
2009-02-03 17:43:22 +00:00
### Test-Unit, Shoulda, and Mocha
Running the test suite requires test-unit, shoulda, and mocha. You can install them as follows:
$ gem install test-unit
$ gem install shoulda
$ gem install mocha
The tests assume that the Mongo database is running on the default port. You
can override the default host (localhost) and port (Connection::DEFAULT_PORT) by
using the environment variables MONGO_RUBY_DRIVER_HOST and
MONGO_RUBY_DRIVER_PORT.
# Testing
2008-12-02 01:20:00 +00:00
If you have the source code, you can run the tests. Skip this test with the C extension if you're running JRuby.
$ rake test:c
2008-12-02 01:20:00 +00:00
If you want to test the basic Ruby encoder, without the C extension, or if you're running JRuby:
$ rake test:ruby
These will run both unit and functional tests. To run these tests alone:
2009-11-23 18:13:14 +00:00
$ rake test:unit
$ rake test:functional
2009-11-23 18:13:14 +00:00
To run any individual rake tasks with the C extension enabled, just pass C_EXT=true to the task (don't do this with JRuby):
$ rake test:unit C_EXT=true
2009-11-23 18:13:14 +00:00
If you want to test replica set, you can run the following task:
2009-11-23 18:13:14 +00:00
$ rake test:rs
2009-11-23 18:13:14 +00:00
# Release Notes
2008-12-02 15:45:02 +00:00
2009-11-24 22:39:44 +00:00
See HISTORY.
2008-12-02 15:45:02 +00:00
# Credits
See CREDITS.
2009-11-25 16:25:50 +00:00
# License
2008-12-02 01:20:00 +00:00
2010-02-20 00:17:38 +00:00
Copyright 2008-2010 10gen Inc.
2008-12-02 01:20:00 +00:00
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
2008-12-02 01:20:00 +00:00
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.