mirror of
https://github.com/mongodb/mongo.git
synced 2024-11-28 16:24:56 +01:00
The MongoDB Database
30668e1c79
This patch is a reorganization of our build files, which brings them slightly
closer in line with standard SCons organization.
In particular, the SConstruct file sets up the various "build environment"
objects, by examining the local system and command line parameters. Then, it
delegates to some SConscript files, which describe build rules, like how to
compile "mongod" from source.
Typically, you would create several SConscript files for a project this large,
after breaking the project into logical sub projects, such as "platform
abstraction", "data manager", "query optimizer", etc. That will be future work.
For now, we only separate out the special rules for executing smoke tests into
SConscript.smoke. Pretty much all other build rules are in src/mongo/SConscript.
"tools" are placed in site_scons/site_tools.
This patch also includes better support for building and tracking dependencies
among static libraries ("libdeps" and "MergeLibrary"), and some incumbent, minor
restructuring.
This patch introduces a "warning" message from SCons about framework.o having
two rules that generate it. It is harmless, for now, and will be removed in
future work.
Future work also includes eliminating use of the SCons "Glob" utility, and
restructuring the source code into sensible components.
|
||
|---|---|---|
| buildscripts | ||
| debian | ||
| distsrc | ||
| docs | ||
| jstests | ||
| rpm | ||
| site_scons | ||
| src | ||
| .gitattributes | ||
| .gitignore | ||
| APACHE-2.0.txt | ||
| doxygenConfig | ||
| GNU-AGPL-3.0.txt | ||
| mongo_astyle | ||
| README | ||
| SConscript.smoke | ||
| SConstruct | ||
| valgrind.suppressions | ||
| win2008plus.props | ||
MongoDB README
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
See docs/building.md, also www.mongodb.org search for "Building".
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.
LICENSE
Most MongoDB source files are made available under the terms of the
GNU Affero General Public License (AGPL). 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.