diff options
| author | Ian Whalen <ian.whalen@gmail.com> | 2017-02-24 17:42:25 -0500 |
|---|---|---|
| committer | Ian Whalen <ian.whalen@gmail.com> | 2017-03-01 18:23:31 -0500 |
| commit | 74720a72751c92bcb363d31c8a016e158771267e (patch) | |
| tree | 126374fcbe7a0861cae6a23435bbd669cfe81a23 /distsrc | |
| parent | 14c45cd2ddc67ecb3a21001dce416dd41eed5163 (diff) | |
| download | mongo-74720a72751c92bcb363d31c8a016e158771267e.tar.gz | |
SERVER-21933 Update README
Diffstat (limited to 'distsrc')
| -rw-r--r-- | distsrc/README | 88 |
1 files changed, 60 insertions, 28 deletions
diff --git a/distsrc/README b/distsrc/README index 8cc83742981..ab71a40b425 100644 --- a/distsrc/README +++ b/distsrc/README @@ -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/
+
+CLOUD HOSTED MONGODB
+
+ 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/
-32 BIT BUILD NOTES
+LICENSE
- 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.
+ 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.
|