Documentation

Welcome to the Mondoc documentation. Here you will find everything you need to know about Mondoc, including how to get started, how to use the various classes and methods, and how to extend and fully use the Mondoc library.

Common documentation

Below is a list of common documentation that you may find useful when working with Mondoc.

info If you've not yet read the description Quick start guide, we recommend starting there.
Configuration

MondocConfig is the class that holds the MongoDB client and provides the mapping between your models and services.

Read more »
Model

A more in-depth look at the MondocAbstractModel, which is the extension source for all top level models in Mondoc.

Read more »
Service

The MondocAbstractService class is the base class for all services in Mondoc. It provides the ability to interact with your models and perform CRUD operations.

Read more »

Specific topics

We've created a few advanced topics that you may find useful when working with Mondoc.

info Before advancing to these topics, we recommend at least having a working instance of Mondoc set up and running.
Converting types

Learn how to convert types in Mondoc, and make use of the MondocTypes object.

Read more »
Nested models

Learn how to nest models within other models, and how to use nested models in your top level models or nested models.

Read more »
Model traits

Learn how to use the predefined Mondoc traits in your models to add additional functionality.

Read more »
Data retention

Learn how to use the data retention trait to retain all changes made to your models.

Read more »
Query building

Learn how to build queries using the MondocBuilder library to ease the building of queries.

Read more »