Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update and normalize readme files a bit

  • Loading branch information...
commit 72b2c46fabdb0470e27f8a1ff102e46d9d07f362 1 parent c203325
dwight authored
Showing with 69 additions and 36 deletions.
  1. +23 −8 README
  2. +46 −28 distsrc/README
View
31 README
@@ -1,14 +1,21 @@
MongoDB README
-DOCUMENTATION
-
- http://www.mongodb.org/
-
+Welcome to MongoDB!
+
COMPONENTS
mongod - The database process.
mongos - Sharding controller.
mongo - The database shell (uses interactive javascript).
+
+UTILITIES
+
+ mongodump - MongoDB dump tool - for backups, snapshots, etc..
+ mongorestore - MongoDB restore a dump
+ mongoexport - Export a single collection to test (JSON, CSV)
+ mongoimport - Import from JSON or CSV
+ mongofiles - Utility for putting and getting files from MongoDB GridFS
+ mongostat - Show performance statistics
BUILDING
@@ -31,11 +38,20 @@ RUNNING
DRIVERS
- Client drivers for most programming languages are available at mongodb.org.
+ Client drivers for most programming languages are available at mongodb.org. Use the
+ shell ("mongo") for administrative tasks.
-NOTES
+DOCUMENTATION
- Mongo uses memory mapped files. If built as a 32 bit executable, you will
+ 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.
@@ -48,4 +64,3 @@ LICENSE
As an exception, the files in the client/, debian/, rpm/,
utils/mongoutils, and all subdirectories thereof are made available under
the terms of the Apache License, version 2.0.
-
View
74 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.
Please sign in to comment.
Something went wrong with that request. Please try again.