finds.database.mongodb

MongoDB client wrapper

Copyright 2022, Terence Lim

MIT License

class finds.database.mongodb.MongoDB(host: str = 'localhost', port: int = 27017, **kwargs)[source]

Bases: Database

Interface to pymongo

Parameters:

  • database – Name of database in MongoDB

  • host – IP address of server

  • port – Port number

Variables:

client – MongoClient instance providing MongoDB interface

Examples

>>> mdb = MongoDB()
>>> serverStatusResult = mdb.client.admin.command("serverStatus")
>>> pprint(serverStatusResult)
>>> collections = mdb.client['database'].list_collection_names()
>>> mdb.client[database][collections[0]].estimated_document_count()

Methods:

count_documents(filter, session=None, limit=None)
create_index(keys, unique=False)
create_indexes(indexes)
delete_one(filter)
distinct(key, filter=None)
drop()
drop_index(index_or_name)
drop_indexes()
estimated_document_count()
find(filter={}, projection=[], limit=None)
find_one(filter=None)
insert_many(documents, ordered=True)
insert_one(document)
list_indexes()
replace_one(filter, replacement, upsert=False)
update_many(filter, update, upsert=False)
update_many(filter, update, upsert=False)
update_one(filter, update, upsert=False)

MongoDB Operators:

$eq     Matches values that are equal to a specified value.
$gt     Matches values that are greater than a specified value.
$gte    Matches values that are greater than or equal to a specified value.
$in     Matches any of the values specified in an array.
$lt     Matches values that are less than a specified value.
$lte    Matches values that are less than or equal to a specified value.
$ne     Matches all values that are not equal to a specified value.
$nin    Matches none of the values specified in an array.
$and    Joins query clauses with a logical AND
$not    Inverts the effect of a query expression
$nor    Joins query clauses with a logical NOR returns
$or     Joins query clauses with a logical OR returns
$exists Matches documents that have the specified field.
$type   Selects documents if a field is of the specified type.

Unix Installation:

https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/

sudo systemctl start mongod
sudo systemctl restart mongod
sudo systemctl stop mongod
sudo systemctl enable mongod
sudo service mongod stop
sudo apt-get purge mongodb-org*

/etc/mongod.conf - configuration file for MongoDB:

  • dbPath: where the database files stored (/var/lib/mongodb)

  • systemLog: logging options (/var/log/mongodb/mongod.log)

drop(database: str, collection: str = '')[source]

Drop a database or collection (table) by name

Parameters:

  • database – Name of database to drop collection

  • collection – Name of collection to drop (blank to drop database)

show(database: str = '')[source]

List all database or collection (table) names

Parameters:

database – List collections in (blank to list all databases)

finds.database.mongodb.parse_where(where: Dict | str | List) → Dict[source]

Helper to parse dict or list-like where clause to pymongo command str

Parameters:

  • where – keyword name may have operator suffix:

  • name_eq (-) – be equal to the value

  • name_ne (-) – be equal to the value

  • name_lt (-) – less than the value

  • name_le (-) – less than or equal to the value

  • name_gt (-) – greater than the value

  • name_ge (-) – greater than or equal to the value

  • name_in (-) – be included in the value

  • name_notin (-) – not be included in the value

Returns:

Dictionary of conditions in pymongo format