Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 2.28 KB

File metadata and controls

69 lines (51 loc) · 2.28 KB

MongoPythonAPI

Table of Contents

  1. About The Project
  2. Example Uses
  3. Acknowledgements

About The Project

The first version of this code was written in our Discord Bot. As I am starting to make changes to the API I wanted to track them seperately.

The code specifies a simple wrapper around the pymongo. The wrapper operates under the assumption that only one database is accessed. It also simplifies the handling of collections making it a parameter of the function instead of having to access them with the __get_item__ operation.

Built With

Example Uses

The API supports following actions:

  • Find one entry: find_one
  • Find multiple entries: find
  • Insert one entry: insert_one
  • Insert multiple entries: insert
  • Update one entry: update_one
  • Update multiple entrie: update
  • Delete one entry: delete_one
  • Delete multiple entries: delete
  • Count multiple entries: count

Here are some examples how you can use the api. Further documentation can be found in the docstrings.

Initialization of the API

from pymongo_api_wrapper.sync_mongo_api import MongoAPI

mongo = MongoAPI('db_address', 'db_name', 'db_username', 'db_password')

Find

Find can be used to query the database.

mongo.find('movies', {'name': 'Interstellar'})

Insert One

Insert One can be used to insert single entries into the database. If you want to insert multiple use insert with a array of entries.

new_movie = {'name': 'First Man', 'length': 141}
mongo.insert_one('movies', new_movie)

[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed

On some systems you might get a error that is similar to [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed. The following code should fix your problem.

from pymongo_api_wrapper.sync_mongo_api import MongoAPI
import certifi

mongo = MongoAPI('db_address', 'db_name', 'db_username', 'db_password', tlsCAFile=certifi.where())

Acknowledgements