mongo-ruby-driver/README.rdoc

106 lines
2.9 KiB
Plaintext
Raw Normal View History

2008-12-02 01:20:00 +00:00
= Introduction
2009-01-07 21:07:22 +00:00
This is a Ruby driver for the 10gen Mongo DB. For more information about
Mongo, see http://www.mongodb.org.
2008-12-02 01:20:00 +00:00
2009-01-07 21:07:22 +00:00
Note: this driver is still alpha quality. The API will change, as *may* the
data saved to the database (especially primary key values). Do *_not_* use
this for any production data yet.
2008-12-04 21:38:04 +00:00
2008-12-02 01:21:22 +00:00
2008-12-02 01:20:00 +00:00
= Demo
2009-01-07 21:07:22 +00:00
Mongo must be running, of course.
2008-12-17 16:43:08 +00:00
$ ruby examples/simple.rb
2008-12-02 01:20:00 +00:00
2009-01-07 21:07:22 +00:00
See also the test code, especially
http://github.com/jimm/mongo-ruby-driver/tree/master/tests/test_db_api.rb
2008-12-02 01:20:00 +00:00
2008-12-02 01:21:22 +00:00
2008-12-02 01:20:00 +00:00
= Testing
$ rake test
The tests assume that the Mongo database is running on the default port.
2008-12-02 01:21:22 +00:00
2008-12-04 22:02:19 +00:00
= Documentation
$ rake rdoc
Then open the file doc/index.html. (I need to figure out where to put this on
2008-12-16 12:42:56 +00:00
the Web, or perhaps how to publish this to the Wiki at
2009-01-07 21:07:22 +00:00
http://github.com/jimm/mongo-ruby-driver/wikis automatically. I have applied
for a RubyForge project, so the docs will eventually go there.)
2008-12-02 15:45:02 +00:00
2009-01-07 21:07:22 +00:00
= Release Notes
2008-12-02 15:45:02 +00:00
See the git log comments.
2008-12-02 15:45:02 +00:00
2008-12-02 01:21:22 +00:00
= To Do
2009-01-07 19:57:47 +00:00
* Add :publish Rake task, once we get a RubyForge project.
2009-01-07 21:56:34 +00:00
* Add group_by. Need to figure out how we are going to send functions. The
current thinking is that Mongo will allow a subset of JavaScript (which we
would have to send as a string), but this is still under discussion.
2009-01-07 21:27:49 +00:00
* Add explain and hint support.
* Only update message sizes once, not after every write of a value. This will
require an explicit call to update_message_length in each message subclass.
2008-12-17 16:03:09 +00:00
* Tests for update and repsert.
2008-12-16 22:35:31 +00:00
* Add a way to specify a collection of databases on startup (a simple array of
IP address/port numbers, perhaps, or a hash or something). The driver would
2008-12-16 22:19:53 +00:00
then find the master and, on each subsequent command, ask that machine if it
is the master before proceeding.
2008-12-09 18:00:14 +00:00
* Tests that prove that this driver's ObjectID and Geir's Java version do the
2008-12-16 12:42:56 +00:00
same thing. (I've done so manually.)
2008-12-09 18:00:14 +00:00
2008-12-08 20:57:20 +00:00
* Support more types: REF, SYMBOL, CODE_W_SCOPE, etc.
2008-12-04 21:25:51 +00:00
* Introduce optional per-database and per-collection PKInjector.
2008-12-02 01:21:22 +00:00
* More tests.
2008-12-08 20:57:20 +00:00
* Study src/main/ed/db/{dbcollection,dbcursor,db}.js and ByteEncoder.java in
the Babble code. That's what I should be writing to.
2008-12-02 12:22:32 +00:00
2008-12-02 01:21:22 +00:00
= Credits
Adrian Madrid, aemadrid@gmail.com
2009-01-06 15:49:18 +00:00
* bin/mongo_console
* examples/benchmarks.rb
* examples/irb.rb
2008-12-08 20:08:14 +00:00
* Modifications to examples/simple.rb
* Found plenty of bugs and missing features.
2009-01-06 15:49:18 +00:00
* Ruby 1.9 support.
* Gem support.
2008-12-08 20:08:14 +00:00
* Many other code suggestions and improvements.
2008-12-02 01:20:00 +00:00
= License
== Mongo Ruby Driver
2009-01-06 15:51:01 +00:00
Copyright (C) 2008-2009 10gen Inc.
2008-12-02 01:20:00 +00:00
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.
2008-12-17 16:49:06 +00:00
See http://www.gnu.org/licenses for a copy of the GNU Affero General Public
2008-12-02 01:20:00 +00:00
License.