Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.34 KB

index.rst

File metadata and controls

76 lines (57 loc) · 2.34 KB

Casbah User Documentation

Welcome to the Casbah Documentation. Casbah is a Scala toolkit for MongoDB --- We use the term "toolkit" rather than "driver", as Casbah is a layer on top of the official mongo-java-driver for better integration with Scala. This is as opposed to a native implementation of the MongoDB wire protocol, which the Java driver does exceptionally well. Rather than a complete rewrite, Casbah uses implicits, and Pimp My Library code to enhance the existing Java code.

:doc:`tutorial`
A quick tutorial to get you started using Casbah.
:doc:`guide/index`
The full guide to Casbah - covering installation, connecting, the query dsl , gridfs, and everything between.
ScalaDocs
The complete ScalaDocs for Casbah along with SXR cross referenced source.
:doc:`changelog`
The recent changes to Casbah
:doc:`whats_new`
An indepth review of new features in MongoDB and Casbah

Help and support

For help and support using casbah please send emails / questions to the Casbah Mailing List on Google Groups. Also be sure to subscribe to the usergroup to get the latest news and information about Casbah.

Stackoverflow is also a great resource for getting answers to your casbah questions - just be sure to tag any questions with "casbah". Just don't forget to mark any answered questions as answered!

Contributing

The source is available on GitHub and contributions are always encouraged. Contributions can be as simple as minor tweaks to the documentation, feature improments or updates to the core.

To contribute, fork the project on GitHub and send a pull request.

Offline Reading

Download the docs in either PDF or ePub formats for offline reading.

.. toctree::
    :maxdepth: 1
    :titlesonly:
    :numbered:

    tutorial
    guide/index
    examples
    changelog
    whats_new
    upgrade

Indices and tables