Skip to main content

MongoDb persistence components for Pip.Services in Python

Project description

Pip.Services Logo
MongoDB components for Python

This module is a part of the Pip.Services polyglot microservices toolkit.

The MongoDB module simplifies how we work with Mongo databases and contains everything you need to start working with MongoDB.

The module contains the following packages:

  • Build - contains a factory for creating MongoDB persistence components.
  • Connect - instruments for configuring connections to the database. The component receives a set of configuration parameters and uses them to generate all necessary database connection parameters.
  • Persistence - abstract classes for working with the database that can be used for connecting to collections and performing basic CRUD operations.

Quick links:


Install the Python package as

pip install pip-services3-mongodb

As an example, lets create persistence for the following data object.

class Dummy(IStringIdentifiable):
    def __init__(self, id: str = None, key: str = None, content: str = None): = id
        self.key = key
        self.content = content

The persistence component shall implement the following interface with a basic set of CRUD operations.

from import DataPage, PagingParams, FilterParams

class IMyPersistence:

    def get_page_by_filter(self, correlation_id: str, filter: FilterParams, paging: PagingParams) -> DataPage:

    def get_one_by_id(self, correlation_id: Optional[str], id: str) -> T:

    def get_one_by_key(self, correlation_id: Optional[str], key: str) -> T:

    def create(self, correlation_id: Optional[str], item: T)-> T:

    def update(self, correlation_id: Optional[str], item: T)-> T:

    def delete_by_id(self, correlation_id: Optional[str], id: str) -> T:

To implement mongodb persistence component you shall inherit IdentifiableMongoDbPersistence. Most CRUD operations will come from the base class. You only need to override get_page_by_filter method with a custom filter function. And implement a get_one_by_key custom persistence method that doesn't exist in the base class.

from import FilterParams
from pip_services3_mongodb.persistence import IdentifiableMongoDbPersistence

class MyMongoDbPersistence(IdentifiableMongoDbPersistence):
    def __init__(self):
        super(MyMongoDbPersistence, self).__init__('myobjects')

    def __composeFilter(self, filterr):
        filterr = filterr or FilterParams()
        id = filterr.get_as_nullable_string("id")
        if id:
            filterr.update({'_id': id})
        temp_ids = filterr.get_as_nullable_string("ids")
        if temp_ids:
            ids = temp_ids.split(",")
            filterr.update({'_id': {'$in': ids}})
        ids = temp_ids.split(",") if temp_ids is not None else None
        if ids:
            filterr.update({'_id': {'$in': ids}})
        key = filterr.get_as_nullable_string("key")

        if key:
            filterr.update({'key': key})

        if len(filterr) > 0:
            return {'$and': filterr}
            return None

    def get_page_by_filter(self, correlation_id, filter, paging, sort=None, select=None):
        return super().get_page_by_filter(correlation_id, filter, paging, '_id', select)

    def get_one_by_key(self, correlation_id, key):

        filterr = {'key': key}
        item = self._collection.find_one(filterr)
        if item:
            self._logger.trace(correlation_id, "Retrieved from {} with key = {}", self._collection_name, key)
            item = self._convert_to_public(item)
            return item
            self._logger.trace(correlation_id, "Nothing found from {} with key = {}", self._collection_name, key)

Configuration for your microservice that includes mongodb persistence may look the following way.

- descriptor: pip-services:connection:mongodb:con1:1.0
  collection: {{MONGO_COLLECTION}}{{#unless MONGO_COLLECTION}}myobjects{{/unless}}
    uri: {{{MONGO_SERVICE_URI}}}
    host: {{{MONGO_SERVICE_HOST}}}{{#unless MONGO_SERVICE_HOST}}localhost{{/unless}}
    port: {{MONGO_SERVICE_PORT}}{{#unless MONGO_SERVICE_PORT}}27017{{/unless}}
    database: {{MONGO_DB}}{{#unless MONGO_DB}}app{{/unless}}
    username: {{MONGO_USER}}
    password: {{MONGO_PASS}}
- descriptor: myservice:persistence:mongodb:default:1.0
    connection: pip-services:connection:mongodb:con1:1.0


For development you shall install the following prerequisites:

  • Python 3.7+
  • Visual Studio Code or another IDE of your choice
  • Docker

Install dependencies:

pip install -r requirements.txt

Run automated tests:


Generate API documentation:


Before committing changes run dockerized build and test as:



The Python version of Pip.Services is created and maintained by Sergey Seroukhov

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pip-services3-mongodb, version 3.1.3
Filename, size File type Python version Upload date Hashes
Filename, size pip_services3_mongodb-3.1.3.tar.gz (18.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page