SERVER-21933 Update README

This commit is contained in:
Ian Whalen
2017-02-24 17:42:25 -05:00
parent 14c45cd2dd
commit 74720a7275
2 changed files with 96 additions and 59 deletions

67
README
View File

@@ -4,22 +4,26 @@ Welcome to MongoDB!
COMPONENTS
mongod - The database process.
mongos - Sharding controller.
mongod - The database server.
mongos - Sharding router.
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
mongodump - Create a binary dump of the contents of a database.
mongorestore - Restore data from the output created by mongodump.
mongoexport - Export the contents of a collection to JSON or CSV.
mongoimport - Import data from JSON, CSV or TSV.
mongofiles - Put, get and delete files from GridFS.
mongostat - Show the status of a running mongod/mongos.
bsondump - Convert BSON files into human-readable formats.
mongooplog - Poll the oplog and apply to a local server.
mongoreplay - Traffic capture and replay tool.
mongotop - Track time spent reading and writing data.
BUILDING
See docs/building.md, also www.mongodb.org search for "Building".
See docs/building.md.
RUNNING
@@ -29,17 +33,22 @@ RUNNING
To run a single server database:
$ mkdir /data/db
$ sudo mkdir -p /data/db
$ ./mongod
$
$ # The mongo javascript shell connects to localhost and test database by default:
$ ./mongo
$ ./mongo
> help
DRIVERS
Client drivers for most programming languages are available at
mongodb.org. Use the shell ("mongo") for administrative tasks.
https://docs.mongodb.com/manual/applications/drivers/. Use the shell
("mongo") for administrative tasks.
BUG REPORTS
See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports.
PACKAGING
@@ -48,32 +57,28 @@ PACKAGING
DOCUMENTATION
http://www.mongodb.org/
CLOUD MANAGED MONGODB
https://docs.mongodb.com/manual/
http://cloud.mongodb.com/
CLOUD HOSTED MONGODB
MAIL LISTS AND IRC
https://www.mongodb.com/cloud/atlas
MAIL LISTS
https://groups.google.com/forum/#!forum/mongodb-user
A forum for technical questions about using MongoDB.
https://groups.google.com/forum/#!forum/mongodb-dev
A forum for technical questions about building and developing MongoDB.
http://dochub.mongodb.org/core/community
LEARN MONGODB
http://university.mongodb.com/
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.
https://university.mongodb.com/
LICENSE
Most MongoDB source files (src/mongo folder and below) are made available
under the terms of the GNU Affero General Public License (AGPL). See
under the terms of the GNU Affero General Public License (GNU AGPLv3). See
individual files for details.
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 File

@@ -1,22 +1,30 @@
MongoDB README
Welcome to MongoDB!
Welcome to MongoDB!
COMPONENTS
bin/mongod - The database process.
bin/mongos - Sharding controller.
bin/mongo - The database shell (uses interactive javascript).
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/mongoimport - Import from JSON or CSV
bin/mongofiles - Utility for putting and getting files from MongoDB GridFS
bin/mongostat - Show performance statistics
mongod - The database server.
mongos - Sharding router.
mongo - The database shell (uses interactive javascript).
UTILITIES
mongodump - Create a binary dump of the contents of a database.
mongorestore - Restore data from the output created by mongodump.
mongoexport - Export the contents of a collection to JSON or CSV.
mongoimport - Import data from JSON, CSV or TSV.
mongofiles - Put, get and delete files from GridFS.
mongostat - Show the status of a running mongod/mongos.
bsondump - Convert BSON files into human-readable formats.
mongooplog - Poll the oplog and apply to a local server.
mongoreplay - Traffic capture and replay tool.
mongotop - Track time spent reading and writing data.
BUILDING
See docs/building.md.
RUNNING
For command line options invoke:
@@ -25,28 +33,52 @@ RUNNING
To run a single server database:
$ mkdir /data/db
$ sudo mkdir -p /data/db
$ ./mongod
$
$ # The mongo javascript shell connects to localhost and test database by default:
$ ./mongo
$ ./mongo
> help
DRIVERS
Client drivers for most programming languages are available at mongodb.org. Use the
shell ("mongo") for administrative tasks.
Client drivers for most programming languages are available at
https://docs.mongodb.com/manual/applications/drivers/. Use the shell
("mongo") for administrative tasks.
BUG REPORTS
See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports.
PACKAGING
Packages are created dynamically by the package.py script located in the
buildscripts directory. This will generate RPM and Debian packages.
DOCUMENTATION
http://www.mongodb.org/
MAIL LISTS AND IRC
http://dochub.mongodb.org/core/community
https://docs.mongodb.com/manual/
32 BIT BUILD NOTES
CLOUD HOSTED MONGODB
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.
https://www.mongodb.com/cloud/atlas
MAIL LISTS
https://groups.google.com/forum/#!forum/mongodb-user
A forum for technical questions about using MongoDB.
https://groups.google.com/forum/#!forum/mongodb-dev
A forum for technical questions about building and developing MongoDB.
LEARN MONGODB
https://university.mongodb.com/
LICENSE
Most MongoDB source files (src/mongo folder and below) are made available
under the terms of the GNU Affero General Public License (GNU AGPLv3). See
individual files for details.