Browse files

Updated README.md

  • Loading branch information...
1 parent 2891030 commit 1ebdb7e6a2d8231294f4923111692c5d0e8bd2ec Evan Wies committed Dec 31, 2011
Showing with 55 additions and 8 deletions.
  1. +55 −8 README.md
View
63 README.md
@@ -1,17 +1,64 @@
-<h1>A Lua driver for mongodb</h1>
+# A Lua driver for mongodb
+## Wiki Documentation
-<a href="https://github.com/moai/luamongo/wiki/Bsontypes">BsonTypes</a>
+ * <a href="https://github.com/moai/luamongo/wiki/Bsontypes">BsonTypes</a>
-<a href="https://github.com/moai/luamongo/wiki/Helperfunctions">HelperFunctions</a>
+ * <a href="https://github.com/moai/luamongo/wiki/Helperfunctions">HelperFunctions</a>
-<a href="https://github.com/moai/luamongo/wiki/GridFS">GridFS</a>
+ * <a href="https://github.com/moai/luamongo/wiki/GridFS">GridFS</a>
-<a href="https://github.com/moai/luamongo/wiki/MongoConnection">MongoConnection</a> - START HERE
+ * <a href="https://github.com/moai/luamongo/wiki/MongoConnection">MongoConnection</a> - START HERE
-<a href="https://github.com/moai/luamongo/wiki/MongoReplicaSet">MongoReplicaSet</a>
+ * <a href="https://github.com/moai/luamongo/wiki/MongoReplicaSet">MongoReplicaSet</a>
-<a href="https://github.com/moai/luamongo/wiki/MongoCursor">MongoCursor</a>
+ * <a href="https://github.com/moai/luamongo/wiki/MongoCursor">MongoCursor</a>
+## Support
+
+Submit issues to the <a href="https://github.com/moai/luamongo/issues">moai github site</a>.
+
+There is a <a href="http://groups.google.com/group/luamongo">Google Groups mailing list</a>.
+
+## Example
+
+ require('mongo')
+
+ -- Create a connection object
+ local db = assert(mongo.Connection.New())
+
+ -- connect to the server on localhost
+ assert(db:connect('localhost'))
+
+ -- insert a value into the namespace 'test.values'
+ assert(db:insert('test.values', {a = 10, b = 'str1'}))
+
+ -- the same using a JSON string
+ assert(db:insert('test.values', "{'a': 20, 'b': 'str2'}"))
+
+ -- insert a multiple values into the namespace 'test.values'
+ assert(db:insert_batch('test.values', {{a = 10, b = 'str1'}, {c = 11, d = 'str2'}}))
+
+ -- print the number of rows in the namespace 'test.values'
+ print(db:count('test.values'))
+
+ -- query all the values in the namespace 'test.values'
+ local q = assert(db:query('test.values', {}))
+
+ -- loop through the result set
+ for result in q:results() do
+ print(result.a)
+ print(result.b)
+ end
+
+
+## How It Works
+
+luamongo is a Lua library that wraps the <a href="https://github.com/mongodb/mongo/blob/master/src/mongo/client/dbclient.h">mongodb C++ API</a>.
+
+The current implementation does not give you raw access to the BSON objects. BSON objects are passed to the API using a Lua table or a JSON string representation. Every returned BSON document is fully marshalled to a Lua table.
+
+## History
+
+This project was forked from the <a href="http://code.google.com/p/luamongo/">luamongo project</a> on googlecode.
-This project was forked from the <a href="http://code.google.com/p/luamongo/">luamongo project</a> on googlecode.

0 comments on commit 1ebdb7e

Please sign in to comment.