README

TokuMX README

Welcome to TokuMX!

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/
  http://www.tokutek.com/

MAIL LISTS AND IRC

  http://dochub.mongodb.org/core/community

  #tokutek on irc.freenode.net
  tokumx-user@googlegroups.com
  tokumx-dev@googlegroups.com

32 BIT BUILD NOTES

  TokuMX only supports 64-bit architectures.

LICENSE

  Most TokuMX 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.

  The TokuKV Fractal Tree Indexing library is made available under the terms of the
  GNU General Public License (GPL) version 2, with an additional grant of a patent
  license.  See README-TOKUKV for details.