diff options
author | dwight <dwight@dwights-MacBook-Pro.local> | 2011-05-01 17:50:23 -0400 |
---|---|---|
committer | dwight <dwight@dwights-MacBook-Pro.local> | 2011-05-01 17:50:23 -0400 |
commit | 72b2c46fabdb0470e27f8a1ff102e46d9d07f362 (patch) | |
tree | a6846d257df96c921f6aa81f4e469efc0d97a89c /distsrc/README | |
parent | c203325c67046c970030859a557fbe67d04732b1 (diff) | |
download | mongo-72b2c46fabdb0470e27f8a1ff102e46d9d07f362.tar.gz |
update and normalize readme files a bit
Diffstat (limited to 'distsrc/README')
-rw-r--r-- | distsrc/README | 74 |
1 files changed, 46 insertions, 28 deletions
diff --git a/distsrc/README b/distsrc/README index 745608dbc1e..9b092a33449 100644 --- a/distsrc/README +++ b/distsrc/README @@ -1,34 +1,52 @@ - -MongoDB -======= - +MongoDB README
+
Welcome to MongoDB! -Package Contents ----------------- +COMPONENTS
+
+ bin/mongod - The database process.
+ bin/mongos - Sharding controller.
+ bin/mongo - The database shell (uses interactive javascript).
- bin/mongod - MongoDB server - bin/mongo - MongoDB client +UTILITIES bin/mongodump - MongoDB dump tool - for backups, snapshots, etc.. bin/mongorestore - MongoDB restore a dump - bin/mongoexport - Export a single collection to test (json,csv) - bin/mongoimportjson - Import a json file into a collection - - bin/mongofiles - Utility for putting and getting files from MongoDB gridfs - - -Useful Resources ----------------- - - MongoDB Website - - * http://www.mongodb.org/ - -Documentation - - * http://www.mongodb.org/display/DOCS/Documentation - - MongoDB Maillists & IRC - - * http://www.mongodb.org/display/DOCS/Community + bin/mongoexport - Export a single collection to test (JSON, CSV) + bin/mongoimport - Import from JSON or CSV + bin/mongofiles - Utility for putting and getting files from MongoDB GridFS + bin/mongostat - Show performance statistics + +RUNNING
+
+ For command line options invoke:
+
+ $ ./mongod --help
+
+ To run a single server database:
+
+ $ mkdir /data/db
+ $ ./mongod
+ $
+ $ # The mongo javascript shell connects to localhost and test database by default:
+ $ ./mongo
+ > help
+
+DRIVERS
+
+ Client drivers for most programming languages are available at mongodb.org. Use the + shell ("mongo") for administrative tasks.
+
+DOCUMENTATION
+
+ http://www.mongodb.org/ + +MAIL LISTS AND IRC + + http://www.mongodb.org/display/DOCS/Community
+
+32 BIT BUILD NOTES
+
+ MongoDB uses memory mapped files. If built as a 32 bit executable, you will
+ not be able to work with large (multi-gigabyte) databases. However, 32 bit
+ builds work fine with small development databases.
|