Skip to content

Latest commit

 

History

History
111 lines (81 loc) · 4.39 KB

README.md

File metadata and controls

111 lines (81 loc) · 4.39 KB
Raw

djongo

Attention !

Attention ! This is a fork from popular original djongo at djongo before the license is switched to AFL. I forked it for my own purpose to develop a solution for my client, please support the original djongo project if you found that my fork is useful.

I have done a hard reset to the commit 4a8a0eef7c4aa66ca83b46de04a12bda99a6ec47 which is the last commit before the license switched from BSD3 to AFL.


super@super-Inspiron-7380:~/Code/vaim/djongo$ git reset --hard 4a8a0eef7c4aa66ca83b46de04a12bda99a6ec47
HEAD is now at 4a8a0ee updated docs
super@super-Inspiron-7380:~/Code/vaim/djongo$ git push origin HEAD --force
Username for 'https://github.com': vaimdev
Password for 'https://vaimdev@github.com':
remote: Invalid username or password.
fatal: Authentication failed for 'https://github.com/vaimdev/djongo/'
super@super-Inspiron-7380:~/Code/vaim/djongo$ git push origin HEAD --force
Username for 'https://github.com': vaimdev
Password for 'https://vaimdev@github.com':
Total 0 (delta 0), reused 0 (delta 0)
To https://github.com/vaimdev/djongo
 + cc6c7d6...4a8a0ee HEAD -> master (forced update)

Below is the original README.md

BSD3 PyPI version

Driver for allowing Django to use MongoDB as the database backend

Use MongoDB as a backend database for your Django project, without changing the Django ORM. Use the Django Admin GUI to add and modify documents in MongoDB.

Usage:

  1. Install djongo: 
    pip install djongo
  2. Into settings.py file of your project, add: 
    DATABASES = {
    'default': {
        'ENGINE': 'djongo',
        'NAME': 'your-db-name',
    }
}
  3. Run manage.py makemigrations <app_name> followed by manage.py migrate (ONLY the first time to create collections in mongoDB)
  4. YOUR ARE SET! HAVE FUN!

Requirements:

  1. Python 3.6 or higher.

  2. MongoDB 3.4 or higher.

  3. If your models use nested queries or sub querysets like:

    inner_qs = Blog.objects.filter(name__contains='Ch').values('name')
entries = Entry.objects.filter(blog__name__in=inner_qs)

    MongoDB 3.6 or higher is required.

Dear Supporter

I am inundated daily with your love, appreciation, queries and feature requests for Djongo. Djongo has grown into more than a simple hobby project of an individual developer. Visit my Patreon page to understand the different levels of support and services you can get.

How it works

djongo is a SQL to mongodb query compiler. It translates a SQL query string into a mongoDB query document. As a result, all Django features, models etc work as is.

Django contrib modules:

  
'django.contrib.admin',
'django.contrib.auth',    
'django.contrib.sessions',

and others... fully supported.

Features

  • Use Django Admin GUI to access MongoDB.
  • Embedded Model.
  • Embedded Array.
  • Embedded Form Fields.

Read the full documentation

Contribute

If you think djongo is useful, please share it with the world! Your endorsements and online reviews will help get more support for this project.

Take a look at the Enhancements project that contains a list of features that must be implemented in future versions of Djongo. You can contribute to the source code or the documentation by creating a simple pull request! You may want to refer to the design documentation to get an idea on how Django MongoDB connector is implemented.

Add a star, show some love :)

Questions and Discussion

  • Djongo groups is where you can watch for new release announcements, suggest improvements, and discuss topics pertaining to Django and MongoDB.
  • Issues, where things are not working as expected, please raise a git-hub issue ticket.
  • For questions and clarifications regarding usage, please put it up on stackoverflow instead.