sachnaror / django-firebase-orm

Django like models for NoSQL database Firestore Integrating with django's ORM.

django-firebase-orm.

Django like models for NoSQL database Firestore Integrating with django's ORM.

I made a few changes and improvements to suit my liking:

1. Created a second settings.py file in the root of your django project to now only require that you define the neccessary configurations in your project's settings module. Note that django is now an explicit dependency

2. Created a new package for this app on pypi under django-firebase-orm

It is my desire to continue the development of this project and thus welcome all developers wishing to contribute via improving documentation, bug fixes, test coverage, new features, etc.

Installation

$ pip install django-firebase-orm

Initialize

In your project settings add the following configuration variables

settings.py

FIREBASE_ORM_CERTIFICATE = 'path/to/serviceAccountKey.json'
FIREBASE_ORM_BUCKET_NAME = '<BUCKET_NAME>.appspot.com'

FIREBASE_ORM_CERTIFICATE

: Once you have created a Firebase console project and downloaded a JSON file with your service account credentials.

FIREBASE_ORM_BUCKET_NAME

: The bucket name must not contain gs:// or any other protocol prefixes. For example, if the bucket URL displayed in the Firebase console is gs://bucket-name.appspot.com, pass the string bucket-name.appspot.com

Usage

Create model:

from firebase_orm import models


class Article(models.Model):
    headline = models.TextField()
    type_article = models.TextField(db_column='type')

    class Meta:
        db_table = 'medications'

    def __str__(self):
        return self.headline

Using The API:

Creating objects

To represent cloud firestore data in Python objects, FirebaseORM uses an intuitive system: A model class represents a collection, and an instance of that class represents a document in collection.

To create an object, instantiate it using keyword arguments to the model class, then call save() to save it to the database.

# Import the models we created
>>> from models import Article
# Create a new Article.
>>> a = Article(headline='Django is cool')
# Save the object into the database. You have to call save() explicitly.
>>> a.save()

Retrieving all objects

The simplest way to retrieve documents from a collections is to get all of them. To do this, use the all() method on a Manager as you would in normal django:

>>> all_Article = Article.objects.all()

The all() method returns a list instance Article of all the collection in the database.

# Now it has an ID.
>>> a.id
1
# Fields are represented as attributes on the Python object.
>>> a.headline
'Django is cool'

Saving changes to objects

To save changes to an object that's already in the database, use save().

Given a Article instance a that has already been saved to the database, this example changes its name and updates its record in the database:

>>> a.headline = 'Django-Firebase-ORM is awesome'
>>> a.save()

This performs an document.update() method behind the scenes. FirebaseORM doesn't hit the database until you explicitly call save().

# Firebase ORM provides a rich database lookup API.
>>> Article.objects.get(id=1)
<Article: Django-Firebase-ORM is awesome>
>>> Article.objects.get(id=2)
Traceback (most recent call last):
    ...
DoesNotExist: Article matching query does not exist.

Field options:

The following arguments are available to all field types. All are optional.

Field.db_column

If contains characters that aren't allowed in Python variable names -- use db_column. The name of the firestore key in document to use for this field. If this isn't given, FirebaseORM will use the field's name.

Field types:

AutoField

class AutoField()

By default, FirebaseORM gives each model the following field:

id = models.AutoField(primary_key=True)

TextField

**class TextField(**options)**

Text string Up to 1,048,487 bytes (1 MiB - 89 bytes). Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

TextField has not extra required argument.

Dependencies

1. firebase-admin
2. grpcio
3. django

Building from Source for Developers

$ git clone https://github.com/sachnaror/django-firebase-orm
$ cd django-firebase-orm