🐳 OceanDB MongoDB Driver (Python)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
oceandb_mongodb_driver
tests
.bumpversion.cfg
.editorconfig
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
MANIFEST.in
Makefile
README.md
bumpversion.sh
requirements_dev.txt
setup.cfg
setup.py
tox.ini

README.md

banner

oceandb-mongodb-driver

🐳 Mongo DB driver for OceanDB (Python). oceanprotocol.com

Travis (.com) Codacy coverage PyPI GitHub contributors


Table of Contents


Features

MongoDB driver to connect implementing OceanDB.

Prerequisites

You should have running a mongo instance.

Quickstart

First of all we have to specify where is allocated our config. To do that we have to pass the following argument:

--config=/path/of/my/config

If you do not provide a configuration path, by default the config is expected in the config folder.

In the configuration we are going to specify the following parameters to

    [oceandb]

    enabled=true            # In order to enable or not the plugin
    module=mongodb          # You can use one the plugins already created. Currently we have mongodb and bigchaindb.
    module.path=            # You can specify the location of your custom plugin.
    db.hostname=localhost   # Address of your MongoDB.
    db.port=27017           # Port of your Mongodb.
    
    db.ssl=True             # If True, connections will be made using HTTPS, else using HTTP
    db.verifyCerts=False    # If True, CA certificate will be verified
    db.caCertPath=          # If verifyCerts is True, then path to the CA cert should be provided here
    db.clientKey=           # If db server needs client verification, then provide path to your client key
    db.clientCertPath=      # If db server needs client verification, then provide path to your client certificate
   
    db.username=user        # If you are using authentication, mongodb username.
    db.password=password    # If you are using authentication, mongodb password.
    db.name=test            # Mongodb database name
    db.collection=col       # Mongodb collection name

Once you have defined this the only thing that you have to do it is use it:

    oceandb = OceanDb(conf)
    oceandb.write({"value": "test"}, id)

Environment variables

When you want to instantiate an Oceandb plugin you can provide the next environment variables:

  • $CONFIG_PATH
  • $MODULE
  • $DB_HOSTNAME
  • $DB_PORT
  • $DB_NAME
  • $DB_COLLECTION
  • $DB_USERNAME
  • $DB_PASSWORD

About queries

If you are going to do queries in mongoDB and you want to be efficient you should be aware of create an index for the fields that you want to sort.

Code style

The information about code style in python is documented in this two links python-developer-guide and python-style-guide.

Testing

Automatic tests are setup via Travis, executing tox. Our test use pytest framework.

New Version

The bumpversion.sh script helps to bump the project version. You can execute the script using as first argument {major|minor|patch} to bump accordingly the version.

License

Copyright 2018 Ocean Protocol Foundation Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.