Skip to main content

EssentialDB - pure Python document database.

Project description

CI Status Cov Status For Python 3.4, 3.5, 3.6 & 3.7(Nightly)

EssentialDB is a pure Python document database developed to meet the following tenets:

  1. Databases shouldn’t slow down development - a developer should be able to integrate a database in less than a minute.

  2. Development databases should have a complete feature set and be performant enough for prototyping and project startups

  3. Development databases should provide a path to scale when your project takes off

Project On GitHub | Full Docs @ ReadTheDocs | Distribution On Pypi

Speeding Development

Our first tenet is that you should be able to start developing in less than a minute. Since EssentialDB is an ‘embedded’ database, there is no external services or dependencies to install or administrate. The tenet here is to take you from concept to development in less than a minute.

Installing is this simple:

pip install essentialdb

Using is this simple:

from essentialdb import EssentialDB

#create or open the database
db = EssentialDB(filepath="my.db")

#get the collection using 'adhoc' style (like pymongo)
authors = db.authors

#get the collection explicitly
authors = db.get_collection('authors', create=True)

#insert a document into the collection
authors.insert_one({'first': 'Langston', 'last': 'Hughes', 'born': 1902});

#find some entries
results = authors.find({'last':'Hughes'})

#commit the changes to disk
db.sync()

You can also use with semantics to assure that the database is closed and synced on exit:

with EssentialDB(filepath="my.db").authors as authors:

    data = [{'first': 'Langston', 'last': 'Hughes', 'born': 1902},
    {'first': 'Ezra', 'last': 'Pound', 'born': 1885}]

    authors.insert_many(data)

Documents are just Python dictionaries and EssentialDB provides an API to easily store and retrieve them.

Features & Performance

Our second tenet is that EssentialDB should have the performance and features you need to get your project rolling.

EssentialDB supports a very rich queries that follow the same basic form as MongoDB:

{ <field1>:  <operator1>: <value1> }, ... }

Most comparison operators are supported, including equals, not equals, less than, greater than:

author_db.find({"born" : {"$gt": 1900}})

You can even test against lists of items using $in and $nin:

author_db.find({"genre" : {"$in": ["tragedy", "drama"]}})

AND and OR boolean operators allow you to make arbitrarily complex queries:

#find authors born after 1900 and before 2000
author_db.find({'$and':[{'born': {'$gte': 1900}},{'born': {'$lt': 2000}}]})

#find authors with either the first or last name John
author_db.find({'$or':[{'first': {'$eg': 'John'}},{'last': {'$eq': 'John'}}]})

We’ve tested EssentialDB under some typical use cases, and seen that it is plenty performant for many use cases with small to moderate loads.

Project details


Download files

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

Source Distribution

essentialdb-0.7.1.win32.zip (30.5 kB view details)

Uploaded Source

Built Distribution

essentialdb-0.7.1-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file essentialdb-0.7.1.win32.zip.

File metadata

File hashes

Hashes for essentialdb-0.7.1.win32.zip
Algorithm Hash digest
SHA256 b72d94a01604db29c6dc3402e1808176f157fe9d7928bd7fd5d1690b8486df7b
MD5 54112647143b4483ccf5b89998aa36d7
BLAKE2b-256 b42e1fb81d38677a98bf1021f608c9902dfb4f160cdcc9ff69276b33f4bd0e74

See more details on using hashes here.

File details

Details for the file essentialdb-0.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for essentialdb-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 032857cf44eb3199eda288daed56206a52df8a54ed857d3912a211babcbe81b6
MD5 a912050f8ea4bfcc0a3e83156f759727
BLAKE2b-256 f45881f273b9b2e4de8b3b35af05b817b40d2bf4ef39de9fa1134592351ffeab

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page